com.gams.api.GAMSModifier Class Reference

Instances of this class are input to GAMSModelInstance.instantiate method. More...

Public Member Functions

 GAMSModifier (GAMSSymbol<?> gamsSymbol, GAMSGlobals.UpdateAction updateAction, GAMSParameter dataSymbol)
 Constructs a new GAMSModifier instance. More...
 
 GAMSModifier (GAMSSymbol<?> gamsSymbol, GAMSGlobals.UpdateAction updateAction, GAMSParameter dataSymbol, GAMSModelInstance.SymbolUpdateType updateType)
 Constructs a new GAMSModifier instance. More...
 
 GAMSModifier (GAMSParameter gamsParam)
 Constructs a new GAMSModifier instance. More...
 
 GAMSModifier (GAMSParameter gamsParam, GAMSModelInstance.SymbolUpdateType updateType)
 Constructs a new GAMSModifier instance. More...
 
GAMSSymbol<?> getGamsSymbol ()
 Get GAMSSymbol instance in the GAMS model to be modified. More...
 
GAMSGlobals.UpdateAction getUpdAction ()
 Get type of modification. More...
 
GAMSParameter getDataSymbol ()
 Get Symbol containing the data for the modification.s. More...
 
GAMSModelInstance.SymbolUpdateType getUpdateType ()
 Get Symbol Update Type. More...
 

Detailed Description

Instances of this class are input to GAMSModelInstance.instantiate method.

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 omitted the type defined in the Solve call is used).

See also
GAMSModelInstance

Constructor & Destructor Documentation

◆ GAMSModifier() [1/4]

com.gams.api.GAMSModifier.GAMSModifier ( GAMSSymbol<?>  gamsSymbol,
GAMSGlobals.UpdateAction  updateAction,
GAMSParameter  dataSymbol 
)

Constructs a new GAMSModifier instance.

Parameters
gamsSymbolSymbol in the GAMS model to be modified
updateActionModification action
dataSymbolParameter containing the data for the modification
Exceptions
GAMSExceptionIf GAMSModifier object could not be successfully created
See also
GAMSGlobals.UpdateAction
GAMSModelInstance
GAMSSymbol

◆ GAMSModifier() [2/4]

com.gams.api.GAMSModifier.GAMSModifier ( GAMSSymbol<?>  gamsSymbol,
GAMSGlobals.UpdateAction  updateAction,
GAMSParameter  dataSymbol,
GAMSModelInstance.SymbolUpdateType  updateType 
)

Constructs a new GAMSModifier instance.

Parameters
gamsSymbolSymbol in the GAMS model to be modified
updateActionModification action
dataSymbolParameter containing the data for the modification
updateTypeModification type
Exceptions
GAMSExceptionIf GAMSModifier object could not be successfully created
See also
GAMSGlobals.UpdateAction
GAMSModelInstance
GAMSModelInstance.SymbolUpdateType
GAMSSymbol

◆ GAMSModifier() [3/4]

com.gams.api.GAMSModifier.GAMSModifier ( GAMSParameter  gamsParam)

Constructs a new GAMSModifier instance.

Parameters
gamsParamParameter in the GAMS model to be modified with data for modification

◆ GAMSModifier() [4/4]

com.gams.api.GAMSModifier.GAMSModifier ( GAMSParameter  gamsParam,
GAMSModelInstance.SymbolUpdateType  updateType 
)

Constructs a new GAMSModifier instance.

Parameters
updateTypeModification type
gamsParamParameter in the GAMS model to be modified with data for modification
See also
GAMSModelInstance
GAMSModelInstance.SymbolUpdateType

Member Function Documentation

◆ getDataSymbol()

GAMSParameter com.gams.api.GAMSModifier.getDataSymbol ( )

Get Symbol containing the data for the modification.s.

Returns
GAMSParameter instance

◆ getGamsSymbol()

GAMSSymbol<?> com.gams.api.GAMSModifier.getGamsSymbol ( )

Get GAMSSymbol instance in the GAMS model to be modified.

Returns
GAMSSymbol instance
See also
GAMSSymbol

◆ getUpdAction()

GAMSGlobals.UpdateAction com.gams.api.GAMSModifier.getUpdAction ( )

Get type of modification.

Returns
type of modification.
See also
GAMSGlobals.UpdateAction

◆ getUpdateType()

GAMSModelInstance.SymbolUpdateType com.gams.api.GAMSModifier.getUpdateType ( )

Get Symbol Update Type.

Returns
update type
See also
GAMSModelInstance.SymbolUpdateType