Loading...
Searching...
No Matches
GAMS.GAMSModifier Class Reference

Instances of this class are input to GAMSModelInstance.Instatiate. A GAMSModifier consists either of a GAMSParameter or a triple: A GAMSVariable or GAMSEquation to be modified, the modification action (e.g. . Upper, Lower or Fixed for updating bounds of a variable, or Primal/Dual for updating the level/marginal of a variable or equation mainly used for starting non-linear models from different starting points), and a GAMSParameter that holds the data for modification. In addition the UpdateType can be defined (if ommitted the type defined in the Solve call is used). More...

Public Member Functions

 GAMSModifier (GAMSSymbol gamsSym, UpdateAction updAction, GAMSParameter dataSym, GAMSModelInstance.SymbolUpdateType updType=GAMSModelInstance.SymbolUpdateType.Inherit)
 Constructor.
 
 GAMSModifier (GAMSParameter gamsPar, GAMSModelInstance.SymbolUpdateType updType=GAMSModelInstance.SymbolUpdateType.Inherit)
 Constructor.
 

Properties

GAMSSymbol GamsSym [get]
 Symbol in the GAMS model to be modified.
 
UpdateAction UpdAction [get]
 Type of modification.
 
GAMSParameter DataSym [get]
 Symbol containing the data for the modification.
 
GAMSModelInstance.SymbolUpdateType UpdType [get]
 Symbol Update Type.
 

Detailed Description

Instances of this class are input to GAMSModelInstance.Instatiate. A GAMSModifier consists either of a GAMSParameter or a triple: A GAMSVariable or GAMSEquation to be modified, the modification action (e.g. . Upper, Lower or Fixed for updating bounds of a variable, or Primal/Dual for updating the level/marginal of a variable or equation mainly used for starting non-linear models from different starting points), and a GAMSParameter that holds the data for modification. In addition the UpdateType can be defined (if ommitted the type defined in the Solve call is used).

Constructor & Destructor Documentation

◆ GAMSModifier() [1/2]

GAMS.GAMSModifier.GAMSModifier ( GAMSSymbol  gamsSym,
UpdateAction  updAction,
GAMSParameter  dataSym,
GAMSModelInstance::SymbolUpdateType  updType = GAMSModelInstance::SymbolUpdateType::Inherit 
)
inline

Constructor.

Parameters
gamsSymSymbol in the GAMS model to be modified
updActionModification action
dataSymParameter containing the data for the modification
updTypeSymbol Update Type

◆ GAMSModifier() [2/2]

GAMS.GAMSModifier.GAMSModifier ( GAMSParameter  gamsPar,
GAMSModelInstance::SymbolUpdateType  updType = GAMSModelInstance::SymbolUpdateType::Inherit 
)
inline

Constructor.

Parameters
gamsParParameter in the GAMS model to be modified with data for modification
updTypeSymbol Update Type

Property Documentation

◆ DataSym

GAMSParameter GAMS.GAMSModifier.DataSym
get

Symbol containing the data for the modification.

◆ GamsSym

GAMSSymbol GAMS.GAMSModifier.GamsSym
get

Symbol in the GAMS model to be modified.

◆ UpdAction

UpdateAction GAMS.GAMSModifier.UpdAction
get

Type of modification.

◆ UpdType

GAMSModelInstance.SymbolUpdateType GAMS.GAMSModifier.UpdType
get

Symbol Update Type.