Gams Modeling Object (GMO) API Documentation

Generated for GAMS 24.8.5

Functions, Procedures and Properties

Initialization

gmoDict(Set)
Load GAMS dictionary object and obtain pointer to it
gmoInitData
Initialize GMO data
gmoAddRow
Add a row
gmoAddCol
Add a column
gmoCompleteData
Complete GMO data instance
gmoLoadDataLegacy
Read instance from scratch files - Legacy Mode
gmoRegisterEnvironment
Register GAMS environment
gmoEnvironment
Get GAMS environment object pointer

Model Characteristics

gmoNameModel(Set)
Name of model
gmoModelSeqNr(Set)
Sequence number of model (0..n)
gmoModelType(Set)
Type of Model
gmoSense(Set)
Direction of optimization, see enumerated constants
gmoIsQP
Is this a QP or not
gmoOptFile(Set)
Number of option file
gmoDictionary(Set)
Dictionary flag
gmoScaleOpt(Set)
Scaling flag
gmoPriorOpt(Set)
Priority Flag
gmoHaveBasis(Set)
Do we have basis
gmoModelStat(Set)
Model status, see enumerated constants
gmoSolveStat(Set)
Solver status, see enumerated constants
gmoIsMPSGE(Set)
Is this an MPSGE model

Model View

gmoObjStyle(Set)
Style of objective, see enumerated constants
gmoInterface(Set)
Interface type (raw vs. processed), see enumerated constants
gmoIndexBase(Set)
User array index base (0 or 1)
gmoObjReform(Set)
Reformulate objective if possible
gmoEmptyOut(Set)
Reformulate objective even if objective variable is the only variable
gmoIgnXCDeriv(Set)
Consider constant derivatives in external functions or not
gmoUseQ(Set)
Toggle Q-mode
gmoAltBounds(Set)
Use alternative bounds
gmoAltRHS(Set)
Use alternative RHS
gmoAltVarTypes(Set)
Use alternative variable types
gmoForceLinear(Set)
Force linear representation of model
gmoForceCont(Set)
Force continuous relaxation of model
gmoPermuteCols(Set)
Column permutation flag
gmoPermuteRows(Set)
Row permutation flag
gmoPinf(Set)
Value for plus infinity
gmoMinf(Set)
Value for minus infinity
gmoQNaN
quiet IEEE NaN
gmoValNA
Double Value of N/A
gmoValNAInt
Integer Value of N/A
gmoValUndf
Double Value of UNDF
gmoViewStore
Store current view in view object
gmoViewRestore
Restore view
gmoViewDump
Dump current view to stdout
gmoGetiSolver
Get equation index in solver space
gmoGetjSolver
Get variable index in solver space
gmoGetiModel
Get equation index in model (original) space
gmoGetjModel
Get variable index in model (original) space
gmoSetEquPermutation
Set Permutation vectors for equations (model view)
gmoSetRvEquPermutation
Set Permutation vectors for equations (solver view)
gmoSetVarPermutation
Set Permutation vectors for variables (model view)
gmoSetRvVarPermutation
Set Permutation vectors for variables (solver view)
gmoSetNRowPerm
Set Permutation to skip =n= rows

Model Statistics

gmoM
Number of rows
gmoQM
Number of quadratic rows (-1 if Q information not used)
gmoNLM
Number of nonlinear rows
gmoNRowMatch
Number of matched rows
gmoN
Number of columns
gmoNLN
Number of nonlinear columns
gmoNDisc
Number of discontinuous columns
gmoNFixed
Number of fixed columns
gmoNColMatch
Number of matched columns
gmoNZ
Number of nonzeros in matrix
gmoNLNZ
Number of nonlinear nonzeros in matrix
gmoLNZ
Number of linear nonzeros in matrix, contains linear nonzeros of Q part if gmoUseQ is true
gmoQNZ
Number of quadratic nonzeros in matrix, 0 if gmoUseQ is false
gmoGNLNZ
Number of general nonlinear nonzeros in matrix, equals gmoNLNZ if gmoUseQ is false
gmoMaxQNZ
Maximum number of nonzeros in single Q matrix
gmoObjNZ
Number of nonzeros in objective
gmoObjNLNZ
Number of nonlinear nonzeros in objective
gmoObjQNZ
Number of nonzeros in Q matrix of objective (-1 if Q information not used)
gmoObjQDiagNZ
Number of nonzeros on diagonal of Q matrix of objective (-1 if Q information not used)
gmoNLConst(Set)
Length of constant pool in nonlinear code
gmoNLCodeSize(Set)
Nonlinear code size
gmoNLCodeSizeMaxRow
Maximum nonlinear code size for rows
gmoGetVarTypeCnt
Get variable type count
gmoGetEquTypeCnt
Get equation type count
gmoGetObjStat
Get obj counts
gmoGetRowStat
Get row counts
gmoGetColStat
Get column counts objnz = -1 if linear +1 if non-linear 0 otherwise
gmoGetRowQNZOne
Number of NZ in Q matrix of row si (-1 if Q information not used)
gmoGetRowQDiagNZOne
Number of NZ on diagonal of Q matrix of row si (-1 if Q information not used)
gmoGetSosCounts
Get SOS count information
gmoGetXLibCounts
Get external function information
gmoGetActiveModelType
Get model type in case of scenario solve generated models

Matrix

gmoGetMatrixRow
Get constraint matrix in row order with row start only and NL indicator
gmoGetMatrixCol
Get constraint matrix in column order with columns start only and NL indicator
gmoGetMatrixCplex
Get constraint matrix in column order with column start and end (colstart length is n+1)

Objective Information

gmoObjVar(Set)
Index of objective variable
gmoObjRow
Index of objective row
gmoGetObjOrder
Order of Objective, see enumerated constants
gmoObjConst
Objective constant
gmoObjJacVal
Value of Jacobian element of objective variable in objective
gmoGetObjName
Get name of objective
gmoGetObjNameCustom
Get name of objective with user specified suffix
gmoGetObjVector
Get objective function vector (dense)
gmoGetObjSparse
Get Jacobians information of objective function (sparse)
gmoGetObjQ
Get Q matrix of objective (NOTE: coefficients on the diagonal are doubled)

Row Information

gmoGetEquL
Get equation activity levels
gmoGetEquLOne
Get individual equation activity levels
gmoSetEquL
Set equation activity levels
gmoSetEquLOne
Set individual equation activity levels
gmoGetEquM
Get equation marginals
gmoGetEquMOne
Get individual equation marginal
gmoSetEquM
Set equation marginals (pass NULL to set to NA)
gmoGetEquNameOne
Get individual equation name
gmoGetEquNameCustomOne
Get individual equation name with quotes and user specified suffix
gmoGetRhs
Get right hand sides
gmoGetRhsOne
Get individual equation right hand side
gmoSetAltRHS
Set alternative RHS
gmoSetAltRHSOne
Set individual alternative RHS
gmoGetEquSlack
Get equation slacks
gmoGetEquSlackOne
Get individual equation slack
gmoSetEquSlack
Set equation slacks
gmoGetEquType
Get equation type
gmoGetEquTypeOne
Get individual equation type
gmoGetEquStat
Get equation basis status
gmoGetEquStatOne
Get individual basis equation status
gmoSetEquStat
Set equation basis status
gmoGetEquCStat
Get equation status
gmoGetEquCStatOne
Get individual equation status
gmoSetEquCStat
Set equation status
gmoGetEquMatch
Get equation match
gmoGetEquMatchOne
Get individual equation match
gmoGetEquScale
Get equation scale
gmoGetEquScaleOne
Get individual equation scale
gmoGetEquStageOne
Get individual equation stage
gmoGetEquOrderOne
Returns 0 on error, 1 linear, 2 quadratic, 3 nonlinear
gmoGetRowSparse
Get Jacobians information of row (sparse)
gmoGetRowJacInfoOne
Get Jacobian information of row one by one
gmoGetRowQ
Get Q matrix of row (NOTE: coefficients on the diagonal are doubled)
gmoGetEquIntDotOpt
Get equation integer values for dot option
gmoGetEquDblDotOpt
Get equation double values for dot option

Column Information

gmoGetVarL
Get variable level values
gmoGetVarLOne
Get individual variable level
gmoSetVarL
Set variable level values
gmoSetVarLOne
Set individual variable level
gmoGetVarM
Get variable marginals
gmoGetVarMOne
Get individual variable marginal
gmoSetVarM
Set variable marginals (pass null to set to NA)
gmoSetVarMOne
Set individual variable marginal
gmoGetVarNameOne
Get individual column name
gmoGetVarNameCustomOne
Get individual column name with quotes and user specified suffix
gmoGetVarLower
Get variable lower bounds
gmoGetVarLowerOne
Get individual variable lower bound
gmoGetVarUpper
Get variable upper bounds
gmoGetVarUpperOne
Get individual variable upper bound
gmoSetAltVarBounds
Set alternative variable lower and upper bounds
gmoSetAltVarLowerOne
Set individual alternative variable lower bound
gmoSetAltVarUpperOne
Set individual alternative variable upper bound
gmoGetVarType
Get variable type
gmoGetVarTypeOne
Get individual variable type
gmoSetAltVarType
Set alternative variable type
gmoSetAltVarTypeOne
Set individual alternative variable type
gmoGetVarStat
Get variable basis status
gmoGetVarStatOne
Get individual variable basis status
gmoSetVarStat
Set variable basis status
gmoSetVarStatOne
Set individual variable basis status
gmoGetVarCStat
Get variable status
gmoGetVarCStatOne
Get individual variable status
gmoSetVarCStat
Set variable status
gmoGetVarMatch
Get variable match
gmoGetVarMatchOne
Get individual variable match
gmoGetVarPrior
Get variable branching priority
gmoGetVarPriorOne
Get individual variable branching priority
gmoGetVarScale
Get variable scale
gmoGetVarScaleOne
Get individual variable scale
gmoGetVarStageOne
Get individual variable stage
gmoGetSosConstraints
Get SOS constraints
gmoGetVarSosSetOne
Get SOS set for individual variable
gmoGetColSparse
Get Jacobians information of column (sparse)
gmoGetColJacInfoOne
Get Jacobian information of column one by one
gmoGetVarIntDotOpt
Get variable integer values for dot option
gmoGetVarDblDotOpt
Get variable double values for dot option

Evaluation (general)

gmoEvalErrorMethod(Set)
Method for returning on nonlinear evaluation errors
gmoEvalMaxThreads(Set)
Maximum number of threads that can be used for evaluations
gmoEvalErrorMsg
Control writing messages for evaluation errors, default=true
gmoEvalErrorMsg_MT
Control writing messages for evaluation errors, default=true
gmoEvalErrorMaskLevel
Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr
gmoEvalErrorMaskLevel_MT
Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr
gmoEvalNewPoint
New point for the next evaluation call
gmoSetExtFuncs
Set external function manager object

Function Evaluation

gmoEvalFuncCount
Number of function evaluations
gmoEvalFuncTimeUsed
Time used for function evaluations in s
gmoEvalFunc
Evaluate the constraint si (excluding RHS)
gmoEvalFunc_MT
Evaluate the constraint si (excluding RHS)
gmoEvalFuncInt
Evaluate the constraint si using the GMO internal variable levels (excluding RHS)
gmoEvalFuncInt_MT
Evaluate the constraint si using the GMO internal variable levels (excluding RHS)
gmoEvalFuncNL
Evaluate the nonlinear function component of constraint si
gmoEvalFuncNL_MT
Evaluate the nonlinear function component of constraint si
gmoEvalFuncObj
Evaluate objective function component
gmoEvalFuncNLObj
Evaluate nonlinear objective function component
gmoEvalFuncInterval
Evaluate the function value of constraint si on the giving interval
gmoEvalFuncInterval_MT
Evaluate the function value of constraint si on the giving interval
gmoEvalFuncNLCluster
Evaluate the nonlinear function value component of clusters of variables of constraint si
gmoEvalFuncNLCluster_MT
Evaluate the nonlinear function value component of clusters of variables of constraint si

Gradient Evaluation

gmoEvalGradCount
Number of gradient evaluations
gmoEvalGradTimeUsed
Time used for gradient evaluations in s
gmoEvalGrad
Update the nonlinear gradients of constraint si and evaluate function value
gmoEvalGrad_MT
Update the nonlinear gradients of constraint si and evaluate function value
gmoEvalGradNL
Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value
gmoEvalGradNL_MT
Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value
gmoEvalGradObj
Update the gradients of the objective function and evaluate function and gradient value
gmoEvalGradNLObj
Update the nonlinear gradients of the objective function and evaluate function and gradient value
gmoEvalGradInterval
Evaluate the function and gradient value of constraint si on the giving interval
gmoEvalGradInterval_MT
Evaluate the function and gradient value of constraint si on the giving interval
gmoEvalGradNLUpdate
Evaluate all nonlinear gradients and return change vector plus optional update of Jacobians
gmoGetJacUpdate
Retrieve the updated Jacobian elements

Hessian Evaluation

gmoHessMaxDim
Maximum dimension of Hessian
gmoHessMaxNz
Maximum number of nonzeros in Hessian
gmoHessLagDim
Dimension of Hessian of the Lagrangian
gmoHessLagNz
Nonzeros in Hessian of the Lagrangian
gmoHessLagDiagNz
Nonzeros on Diagonal of Hessian of the Lagrangian
gmoHessLoad
Initialize Hessians
gmoHessUnload
Unload Hessians
gmoHessDim
Hessian dimension of row
gmoHessNz
Hessian nonzeros of row
gmoHessStruct
Get Hessian Structure
gmoHessValue
Get Hessian Value
gmoHessVec
Get Hessian-vector product
gmoHessLagStruct
Get Hessian of the Lagrangian Value structure
gmoHessLagValue
Get Hessian of the Lagrangian Value
gmoHessLagVec
Get Hessian of the Lagrangian-vector product

Solution

gmoGetHeadnTail
Get value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)
gmoSetHeadnTail
Set value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)
gmoSetSolutionPrimal
Set solution values for variable levels
gmoSetSolution2
Set solution values for variable levels and equation marginals
gmoSetSolution
Set solution values for variable and equation levels as well as marginals
gmoSetSolution8
Set solution values for variable and equation levels, marginals and statuses
gmoSetSolutionFixer
Construct and set solution based on available inputs
gmoGetSolutionVarRec
Get variable solution values (level, marginals and statuses)
gmoSetSolutionVarRec
Set variable solution values (level, marginals and statuses)
gmoGetSolutionEquRec
Get equation solution values (level, marginals and statuses)
gmoSetSolutionEquRec
Set equation solution values (level, marginals and statuses)
gmoSetSolutionStatus
Set solution values sfor variable and equation statuses
gmoCompleteObjective
Complete objective row/col for models with objective function
gmoCompleteSolution
Complete solution (e.g. for cols/rows not in view)
gmoGetAbsoluteGap
Compute absolute gap w.r.t. objective value and objective estimate in head or tail records
gmoGetRelativeGap
Compute relative gap w.r.t. objective value and objective estimate in head or tail records
gmoLoadSolutionLegacy
Load solution from legacy solution file
gmoUnloadSolutionLegacy
Unload solution to legacy solution file
gmoLoadSolutionGDX
Load solution to GDX solution file (optional: rows, cols and-or header and tail info)
gmoUnloadSolutionGDX
Unload solution to GDX solution file (optional: rows, cols and-or header and tail info)
gmoPrepareAllSolToGDX
Initialize writing of multiple solutions (e.g. scenarios) to a GDX file
gmoAddSolutionToGDX
Add a solution (e.g. scenario) to the GDX file
gmoWriteSolDone
Finalize writing of multiple solutions (e.g. scenarios) to a GDX file
gmoCheckSolPoolUEL
Check scenario UEL against dictionary uels and report number of varaible symbols
gmoPrepareSolPoolMerge
Prepare merged solution pool GDX file
gmoPrepareSolPoolNextSym
Write solution to merged solution pool GDX file
gmoUnloadSolPoolSolution
Write solution to merged solution pool GDX file
gmoFinalizeSolPoolMerge
Finalize merged solution pool GDX file

EMP Information

gmoNumVIFunc
EMP: Number of variational inequalities in model rim
gmoNumAgents
EMP: Number of Agents/Followers
gmoLoadEMPInfo
Load EMP information
gmoGetEquVI
Get VI mapping for all rows (-1 if not a VI function)
gmoGetEquVIOne
Get VI mapping for individual row (-1 if not a VI function)
gmoGetVarVI
Get VI mapping for all cols (-1 if not a VI variable)
gmoGetVarVIOne
Get VI mapping for individual cols (-1 if not a VI variable)
gmoGetAgentType
Get Agent Type of all agent (see gmoNumAgents)
gmoGetAgentTypeOne
Get Agent Type of agent
gmoGetBiLevelInfo
Get equation and variable mapping to agents
gmoDumpEMPInfoToGDX
Dump EMPInfo GDX File

Names

gmoNameOptFile(Set)
Name of option file
gmoNameSolFile(Set)
Name of solution file
gmoNameXLib(Set)
Name of external function library
gmoNameDict(Set)
Name of dictionary file
gmoNameInput
Name of input file (with .gms stripped)
gmoNameOutput
Name of output file (with .dat stripped)
gmoGetVarTypeTxt
String for variable type
gmoGetEquTypeTxt
String for equation type
gmoGetSolveStatusTxt
String for solvestatus
gmoGetModelStatusTxt
String for modelstatus
gmoGetModelTypeTxt
String for modeltype
gmoGetHeadNTailTxt
String for solution head or tail record

Memory Usage

gmoMemUsed
Get current memory consumption of GMO in MB
gmoPeakMemUsed
Get peak memory consumption of GMO in MB

Other

gmoPPool
Pointer to constant pool
gmoIOMutex
IO mutex
gmoError(Set)
Access to error indicator
gmoErrorMessage
Provide the last error message
gmoSetNLObject
Set NL Object and constant pool
gmoDumpQMakerGDX
Dump QMaker GDX File
gmoGetVarEquMap
Get variable equation mapping list
gmoGetIndicatorMap
Get indicator constraint list

Deprecated

gmoCrudeness
mature = 0 ... 100 = crude/not secure evaluations (non-GAMS evaluators)
gmoDirtyGetRowFNLInstr
Temporary function to get row function only code, do not use it
gmoDirtyGetObjFNLInstr
Temporary function to get row function only code, do not use it
gmoDirtySetRowFNLInstr
Temporary function to set row function only code, do not use it

Extrinsic Functions

gmoGetExtrLibName
Get file name stub of extrinsic function library
gmoGetExtrLibObjPtr
Get data object pointer of extrinsic function library
gmoGetExtrLibFuncName
Get name of extrinsic function
gmoLoadExtrLibEntry
Load a function from an extrinsic function library

Arguments

actModelType
active model type in case of scenario dict type emp model
agentvec
Array of agent types of length gmoNumAgents
aidx
Index of agent
checkv
a vector with column indicators to be treated as constant
cluster
Array defining the clustering of variables
codelen
length of NL code
coefs
Coefficients
colidx
Column index/indices of Jacobian(s)
colindic
map with column indicies
collength
Number of Jacobians in column
cols
Number of columns
colstart
Index of Jacobian column starts with
conweight
Weight for constraints in Hessian of the Lagrangian (=1 for GAMS convention)
dictid
GDX symbol number of dict
dj
Marginal values of variables
do2dir
Flag whether 2nd derivatives are wanted/available
docols
Flag whether to read/write column information from/to solution file
doHess
Flag whether Hessians are wanted/available
doht
Flag whether to read/write head and tail information from/to solution file
dojacupd
Flag whether to update Jacobians
domsg
Flag whether to write messages
dorows
Flag whether to read/write row information from/to solution file
dotopt
Dot option name
dval
Double value
dx
Direction in x-space for directional derivative of Lagrangian (W*dx)
e
Level values of equations
ebas
Basis flag of equation (0=basic)
ecstat
Status of equation (see enumerated constants)
el
Level of equation
emarg
Marginal of equation
ematch
Index of matching variable of equation
empinfofname
Name of EMP information file, if empty assume the default name and location
enz
Number of nonzeros in row
erhs
RHS of equation
escale
Scale of equation
eslack
Slack of equation
estat
Basis status of equation (see enumerated constants)
etyp
Type of equation (see enumerated constants)
extfunmgr
pointer to external function manager object
f
Function value
field
Nonlinear code field
fmax
Maximum function value
fmin
Minimum function value
fnl
Part of the function value depending on the nonlinear variables
funcidx
Function index
g
Gradient values
gdxfname
Name of GDX file
gevptr
Pointer to GAMS environment object
gmax
Maximum gradient values
gmin
Minimum gradient values
gx
Inner product of the gradient with the input variables ()
gxnl
Inner product of the gradient with the input variables (), nonlinear variables only
hcidx
Hessian column indices
hessdim
Dimension of Hessian
hessnz
Number of nonzeros in Hessian
hessval
Values of Hessian
hridx
Hessian row indices
htrec
Solution head or tail record, (see enumerated constants)
indiconval
0 or 1 value for binary variable to activate the constraint
indicstrict
1: Make the indicator reading strict. 0: accept duplicates, unmatched vars and equs, etc
infTol
Infeasibility tolerance
jacptr
Pointer to next Jacobian
jacval
Value(s) of Jacobian(s)
len
Length of array
len2
Length of second array
libidx
Library index
locobjval
Objective value
lovec
Lower bound values of variables
maptype
Type of variable equation mapping
MaskLevel
Ignore evaluation errors less that this value
maxJacMult
Multiplier to define memory limit for Hessian (0=no limit)
mdblvec
Array of doubles, len=number of rows in user view
mi
Index of row in original/GAMS space
mintvec
Array of integers, len=number of rows in user view
mj
Index of column original/GAMS client space
modelstat
Model status
modelstathint
Model status used as a hint
msg
Message
ncluster
Number of clusters (0=constant part only, 1=constant and cluster 1,...)
ndblvec
Array of doubles, len=number of columns in user view
nintvec
Array of integers, len=number of columns in user view
nlflag
NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)
nlnz
Number of nonlinear nonzeros
nlobject
Object of nonlinear instructions
nlpool
Constant pool object for constants in nonlinear instruction
nlpoolvec
Constant pool array for constants in nonlinear instruction
numerr
Number of errors evaluating the nonlinear function
numindic
Number of indicator constraints
numsol
Number of solutions in solution pool
numsos1
Number of SOS1 sets
numsos2
Number of SOS2 sets
numsym
Number of symbols
nz
Number of nonzeros
nzsos
Number of variables in SOS1/2 sets
objnz
Nonzeros in objective
objweight
Weight for objective in Hessian of the Lagrangian (=1 for GAMS convention)
opcode
Nonlinear code operation
optptr
Option object pointer
optTol
Optimality tolerance
optvals
Option values
orgcolind
Original/GAMS column indices
permut
Permutation vector (original/GAMS to client)
pi
Marginal values of equations
qnz
Number of quadratic nonzeros
result
Result/Return code of function
rhsdelta
Taylor expansion constants
rowidx
Row index/indices of Jacobian
rowindic
map with row indicies
rows
Number of rows
rowstart
Index of Jacobian row starts with
rvpermut
Reverse permutation vector (client to original/GAMS)
s
String
scengdx
Pointer to GDX solution file containing multiple solutions, e.g. scenarios
scenuel
Scenario labels
si
Index of row in client space
sj
Index of column in client space
solvestat
Solver status
sosbeg
Variable index start of SOS set
sosind
Variable indices
sostype
SOS type 1 or 2
soswt
Weight in SOS set
suffix
Suffix appended to name, could be .l, .m etc.
tidx
Index of thread
upvec
Upper bound values of variables
varidx1
First variable indices
varidx2
Second variable indices
vbas
Basis flag of variable (0=basic)
vcstat
Status of variable (see enumerated constants)
viewptr
Pointer to structure storing the view of a model
vl
Level of variable
vlo
Lower bound of variable
vmarg
Marginal of variable
vnz
Number of nonzeros in column
vprior
Priority value of variable
vscale
Scale of variable
vsos
SOS set variable belongs to
vstat
Basis status of variable (see enumerated constants)
vtyp
Type of variable (see enumerated constants)
vup
Upper bound of variable
w
Values for the structural nonzeros of the upper triangle of the symmetric matrix W (the Hessian of the Lagrangian), ordered by rows and within rows by columns
WCindex
Col indices for the upper triangle of the symmetric matrix W (the Hessian of the Lagrangian), ordered by rows and within rows by columns
Wdx
Directional derivative of the Lagrangian in direction dx (W*dx)
WRindex
Row indices for the upper triangle of the symmetric matrix W (the Hessian of the Lagrangian), ordered by rows and within rows by columns
x
Level values of variables
xb
Basis statuses of variables (see enumerated constants)
xmax
Maximum input level values of variables
xmin
Minimum input level values of variables
xs
Statuses of variables (see enumerated constants)
yb
Basis statuses of equations (see enumerated constants)
ys
Statuses of equation (see enumerated constants)

Calling Sequences

gmoAddCol

  • Add a column
  • Function returns Integer
  • Arguments:
    • vtyp : Integer
      Type of variable (see enumerated constants)
      vlo : Double
      Lower bound of variable
      vl : Double
      Level of variable
      vup : Double
      Upper bound of variable
      vmarg : Double
      Marginal of variable
      vbas : Integer
      Basis flag of variable (0=basic)
      vsos : Integer
      SOS set variable belongs to
      vprior : Double
      Priority value of variable
      vscale : Double
      Scale of variable
      vnz : Integer
      Number of nonzeros in column
      const rowidx : PLongIntArray
      Row index/indices of Jacobian
      const jacval : PDoubleArray
      Value(s) of Jacobian(s)
      const nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoAddRow

  • Add a row
  • Function returns Integer
  • Arguments:
    • etyp : Integer
      Type of equation (see enumerated constants)
      ematch : Integer
      Index of matching variable of equation
      eslack : Double
      Slack of equation
      escale : Double
      Scale of equation
      erhs : Double
      RHS of equation
      emarg : Double
      Marginal of equation
      ebas : Integer
      Basis flag of equation (0=basic)
      enz : Integer
      Number of nonzeros in row
      const colidx : PLongIntArray
      Column index/indices of Jacobian(s)
      const jacval : PDoubleArray
      Value(s) of Jacobian(s)
      const nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoAddSolutionToGDX

  • Add a solution (e.g. scenario) to the GDX file
  • Function returns Integer
  • Arguments:
    • const scenuel : TgdxStrIndex
      Scenario labels

gmoAltBounds(Set)

  • Use alternative bounds
  • Property of type Boolean
  • Actions
    • r
    • w

gmoAltRHS(Set)

  • Use alternative RHS
  • Property of type Boolean
  • Actions
    • r
    • w

gmoAltVarTypes(Set)

  • Use alternative variable types
  • Property of type Boolean
  • Actions
    • r
    • w

gmoCheckSolPoolUEL

  • Check scenario UEL against dictionary uels and report number of varaible symbols
  • Function returns Integer
  • Arguments:
    • const prefix : ShortString
      var numsym : Integer
      Number of symbols

gmoCompleteData

  • Complete GMO data instance
  • Function returns Integer
  • Arguments:
    • out msg : ShortString
      Message

gmoCompleteObjective

  • Complete objective row/col for models with objective function
  • Procedure
  • Arguments:
    • locobjval : Double
      Objective value

gmoCompleteSolution

  • Complete solution (e.g. for cols/rows not in view)
  • Function returns Integer

gmoCrudeness

  • mature = 0 ... 100 = crude/not secure evaluations (non-GAMS evaluators)
  • Function returns Integer

gmoDict(Set)

  • Load GAMS dictionary object and obtain pointer to it
  • Property of type Pointer
  • Actions
    • r
    • w

gmoDictionary(Set)

  • Dictionary flag
  • Property of type Integer
  • Actions
    • r
    • w

gmoDirtyGetObjFNLInstr

  • Temporary function to get row function only code, do not use it
  • Function returns Integer
  • Arguments:
    • out len : Integer
      Length of array
      opcode : PLongIntArray
      Nonlinear code operation
      field : PLongIntArray
      Nonlinear code field

gmoDirtyGetRowFNLInstr

  • Temporary function to get row function only code, do not use it
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      out len : Integer
      Length of array
      opcode : PLongIntArray
      Nonlinear code operation
      field : PLongIntArray
      Nonlinear code field

gmoDirtySetRowFNLInstr

  • Temporary function to set row function only code, do not use it
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      len : Integer
      Length of array
      const opcode : PLongIntArray
      Nonlinear code operation
      const field : PLongIntArray
      Nonlinear code field
      nlpool : Pointer
      Constant pool object for constants in nonlinear instruction
      nlpoolvec : PDoubleArray
      Constant pool array for constants in nonlinear instruction
      len2 : Integer
      Length of second array

gmoDumpEMPInfoToGDX

  • Dump EMPInfo GDX File
  • Function returns Integer
  • Arguments:
    • const gdxfname : ShortString
      Name of GDX file

gmoDumpQMakerGDX

  • Dump QMaker GDX File
  • Function returns Integer
  • Arguments:
    • const gdxfname : ShortString
      Name of GDX file

gmoEmptyOut(Set)

  • Reformulate objective even if objective variable is the only variable
  • Property of type Boolean
  • Actions
    • r
    • w

gmoEnvironment

  • Get GAMS environment object pointer
  • Function returns Pointer

gmoError(Set)

  • Access to error indicator
  • Property of type Integer
  • Actions
    • r
    • w

gmoErrorMessage

  • Provide the last error message
  • Property of type ShortString
  • Actions
    • r

gmoEvalErrorMaskLevel

  • Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr
  • Procedure
  • Arguments:
    • MaskLevel : Integer
      Ignore evaluation errors less that this value

gmoEvalErrorMaskLevel_MT

  • Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr
  • Procedure
  • Arguments:
    • MaskLevel : Integer
      Ignore evaluation errors less that this value
      tidx : Integer
      Index of thread

gmoEvalErrorMethod(Set)

  • Method for returning on nonlinear evaluation errors
  • Property of type Integer
  • Actions
    • r
    • w

gmoEvalErrorMsg

  • Control writing messages for evaluation errors, default=true
  • Procedure
  • Arguments:
    • const domsg : Boolean
      Flag whether to write messages

gmoEvalErrorMsg_MT

  • Control writing messages for evaluation errors, default=true
  • Procedure
  • Arguments:
    • const domsg : Boolean
      Flag whether to write messages
      tidx : Integer
      Index of thread

gmoEvalFunc

  • Evaluate the constraint si (excluding RHS)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out f : Double
      Function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncCount

  • Number of function evaluations
  • Property of type Integer
  • Actions
    • r

gmoEvalFuncInt

  • Evaluate the constraint si using the GMO internal variable levels (excluding RHS)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      out f : Double
      Function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncInterval

  • Evaluate the function value of constraint si on the giving interval
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const xmin : PDoubleArray
      Minimum input level values of variables
      const xmax : PDoubleArray
      Maximum input level values of variables
      out fmin : Double
      Minimum function value
      out fmax : Double
      Maximum function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncInterval_MT

  • Evaluate the function value of constraint si on the giving interval
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const xmin : PDoubleArray
      Minimum input level values of variables
      const xmax : PDoubleArray
      Maximum input level values of variables
      out fmin : Double
      Minimum function value
      out fmax : Double
      Maximum function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalFuncInt_MT

  • Evaluate the constraint si using the GMO internal variable levels (excluding RHS)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      out f : Double
      Function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalFuncNL

  • Evaluate the nonlinear function component of constraint si
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out fnl : Double
      Part of the function value depending on the nonlinear variables
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncNLCluster

  • Evaluate the nonlinear function value component of clusters of variables of constraint si
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      const cluster : PLongIntArray
      Array defining the clustering of variables
      ncluster : Integer
      Number of clusters (0=constant part only, 1=constant and cluster 1,...)
      fnl : PDoubleArray
      Part of the function value depending on the nonlinear variables
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncNLCluster_MT

  • Evaluate the nonlinear function value component of clusters of variables of constraint si
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      const cluster : PLongIntArray
      Array defining the clustering of variables
      ncluster : Integer
      Number of clusters (0=constant part only, 1=constant and cluster 1,...)
      fnl : PDoubleArray
      Part of the function value depending on the nonlinear variables
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalFuncNLObj

  • Evaluate nonlinear objective function component
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      out fnl : Double
      Part of the function value depending on the nonlinear variables
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncNL_MT

  • Evaluate the nonlinear function component of constraint si
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out fnl : Double
      Part of the function value depending on the nonlinear variables
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalFuncObj

  • Evaluate objective function component
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      out f : Double
      Function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalFuncTimeUsed

  • Time used for function evaluations in s
  • Property of type Double
  • Actions
    • r

gmoEvalFunc_MT

  • Evaluate the constraint si (excluding RHS)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out f : Double
      Function value
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalGrad

  • Update the nonlinear gradients of constraint si and evaluate function value
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out f : Double
      Function value
      g : PDoubleArray
      Gradient values
      out gx : Double
      Inner product of the gradient with the input variables ()
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalGradCount

  • Number of gradient evaluations
  • Property of type Integer
  • Actions
    • r

gmoEvalGradInterval

  • Evaluate the function and gradient value of constraint si on the giving interval
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const xmin : PDoubleArray
      Minimum input level values of variables
      const xmax : PDoubleArray
      Maximum input level values of variables
      out fmin : Double
      Minimum function value
      out fmax : Double
      Maximum function value
      gmin : PDoubleArray
      Minimum gradient values
      gmax : PDoubleArray
      Maximum gradient values
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalGradInterval_MT

  • Evaluate the function and gradient value of constraint si on the giving interval
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const xmin : PDoubleArray
      Minimum input level values of variables
      const xmax : PDoubleArray
      Maximum input level values of variables
      out fmin : Double
      Minimum function value
      out fmax : Double
      Maximum function value
      gmin : PDoubleArray
      Minimum gradient values
      gmax : PDoubleArray
      Maximum gradient values
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalGradNL

  • Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out fnl : Double
      Part of the function value depending on the nonlinear variables
      g : PDoubleArray
      Gradient values
      out gxnl : Double
      Inner product of the gradient with the input variables (), nonlinear variables only
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalGradNLObj

  • Update the nonlinear gradients of the objective function and evaluate function and gradient value
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      out fnl : Double
      Part of the function value depending on the nonlinear variables
      g : PDoubleArray
      Gradient values
      out gxnl : Double
      Inner product of the gradient with the input variables (), nonlinear variables only
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalGradNLUpdate

  • Evaluate all nonlinear gradients and return change vector plus optional update of Jacobians
  • Function returns Integer
  • Arguments:
    • rhsdelta : PDoubleArray
      Taylor expansion constants
      const dojacupd : Boolean
      Flag whether to update Jacobians
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalGradNL_MT

  • Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out fnl : Double
      Part of the function value depending on the nonlinear variables
      g : PDoubleArray
      Gradient values
      out gxnl : Double
      Inner product of the gradient with the input variables (), nonlinear variables only
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalGradObj

  • Update the gradients of the objective function and evaluate function and gradient value
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      out f : Double
      Function value
      g : PDoubleArray
      Gradient values
      out gx : Double
      Inner product of the gradient with the input variables ()
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoEvalGradTimeUsed

  • Time used for gradient evaluations in s
  • Property of type Double
  • Actions
    • r

gmoEvalGrad_MT

  • Update the nonlinear gradients of constraint si and evaluate function value
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      out f : Double
      Function value
      g : PDoubleArray
      Gradient values
      out gx : Double
      Inner product of the gradient with the input variables ()
      out numerr : Integer
      Number of errors evaluating the nonlinear function
      tidx : Integer
      Index of thread

gmoEvalMaxThreads(Set)

  • Maximum number of threads that can be used for evaluations
  • Property of type Integer
  • Actions
    • r
    • w

gmoEvalNewPoint

  • New point for the next evaluation call
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables

gmoFinalizeSolPoolMerge

  • Finalize merged solution pool GDX file
  • Function returns Integer
  • Arguments:
    • handle : Pointer

gmoForceCont(Set)

  • Force continuous relaxation of model
  • Property of type Boolean
  • Actions
    • r
    • w

gmoForceLinear(Set)

  • Force linear representation of model
  • Property of type Boolean
  • Actions
    • r
    • w

gmoGetAbsoluteGap

  • Compute absolute gap w.r.t. objective value and objective estimate in head or tail records
  • Function returns Double

gmoGetActiveModelType

  • Get model type in case of scenario solve generated models
  • Function returns Integer
  • Arguments:
    • checkv : PLongIntArray
      a vector with column indicators to be treated as constant
      out actModelType : Integer
      active model type in case of scenario dict type emp model

gmoGetAgentType

  • Get Agent Type of all agent (see gmoNumAgents)
  • Function returns Integer
  • Arguments:
    • agentvec : PLongIntArray
      Array of agent types of length gmoNumAgents

gmoGetAgentTypeOne

  • Get Agent Type of agent
  • Function returns Integer
  • Arguments:
    • aidx : Integer
      Index of agent

gmoGetBiLevelInfo

  • Get equation and variable mapping to agents
  • Function returns Integer
  • Arguments:
    • nintvec : PLongIntArray
      Array of integers, len=number of columns in user view
      mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoGetColJacInfoOne

  • Get Jacobian information of column one by one
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      var jacptr : Pointer
      Pointer to next Jacobian
      out jacval : Double
      Value(s) of Jacobian(s)
      out rowidx : Integer
      Row index/indices of Jacobian
      out nlflag : Integer
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoGetColSparse

  • Get Jacobians information of column (sparse)
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space
      rowidx : PLongIntArray
      Row index/indices of Jacobian
      jacval : PDoubleArray
      Value(s) of Jacobian(s)
      nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)
      out nz : Integer
      Number of nonzeros
      out nlnz : Integer
      Number of nonlinear nonzeros

gmoGetColStat

  • Get column counts objnz = -1 if linear +1 if non-linear 0 otherwise
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space
      out nz : Integer
      Number of nonzeros
      out qnz : Integer
      Number of quadratic nonzeros
      out nlnz : Integer
      Number of nonlinear nonzeros
      out objnz : Integer
      Nonzeros in objective

gmoGetEquCStat

  • Get equation status
  • Procedure
  • Arguments:
    • mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoGetEquCStatOne

  • Get individual equation status
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquDblDotOpt

  • Get equation double values for dot option
  • Function returns Integer
  • Arguments:
    • optptr : Pointer
      Option object pointer
      const dotopt : ShortString
      Dot option name
      optvals : PDoubleArray
      Option values

gmoGetEquIntDotOpt

  • Get equation integer values for dot option
  • Function returns Integer
  • Arguments:
    • optptr : Pointer
      Option object pointer
      const dotopt : ShortString
      Dot option name
      optvals : PLongIntArray
      Option values

gmoGetEquL

  • Get equation activity levels
  • Function returns Integer
  • Arguments:
    • e : PDoubleArray
      Level values of equations

gmoGetEquLOne

  • Get individual equation activity levels
  • Function returns Double
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquM

  • Get equation marginals
  • Function returns Integer
  • Arguments:
    • pi : PDoubleArray
      Marginal values of equations

gmoGetEquMatch

  • Get equation match
  • Function returns Integer
  • Arguments:
    • mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoGetEquMatchOne

  • Get individual equation match
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquMOne

  • Get individual equation marginal
  • Function returns Double
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquNameCustomOne

  • Get individual equation name with quotes and user specified suffix
  • Function returns ShortString
  • Arguments:
    • si : Integer
      Index of row in client space
      const suffix : ShortString
      Suffix appended to name, could be .l, .m etc.

gmoGetEquNameOne

  • Get individual equation name
  • Function returns ShortString
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquOrderOne

  • Returns 0 on error, 1 linear, 2 quadratic, 3 nonlinear
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquScale

  • Get equation scale
  • Function returns Integer
  • Arguments:
    • mdblvec : PDoubleArray
      Array of doubles, len=number of rows in user view

gmoGetEquScaleOne

  • Get individual equation scale
  • Function returns Double
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquSlack

  • Get equation slacks
  • Function returns Integer
  • Arguments:
    • mdblvec : PDoubleArray
      Array of doubles, len=number of rows in user view

gmoGetEquSlackOne

  • Get individual equation slack
  • Function returns Double
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquStageOne

  • Get individual equation stage
  • Function returns Double
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquStat

  • Get equation basis status
  • Procedure
  • Arguments:
    • mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoGetEquStatOne

  • Get individual basis equation status
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquType

  • Get equation type
  • Function returns Integer
  • Arguments:
    • mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoGetEquTypeCnt

  • Get equation type count
  • Function returns Integer
  • Arguments:
    • etyp : Integer
      Type of equation (see enumerated constants)

gmoGetEquTypeOne

  • Get individual equation type
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetEquTypeTxt

  • String for equation type
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      out s : ShortString
      String

gmoGetEquVI

  • Get VI mapping for all rows (-1 if not a VI function)
  • Function returns Integer
  • Arguments:
    • mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoGetEquVIOne

  • Get VI mapping for individual row (-1 if not a VI function)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetExtrLibFuncName

  • Get name of extrinsic function
  • Function returns ShortString
  • Arguments:
    • libidx : Integer
      Library index
      funcidx : Integer
      Function index

gmoGetExtrLibName

  • Get file name stub of extrinsic function library
  • Function returns ShortString
  • Arguments:
    • libidx : Integer
      Library index

gmoGetExtrLibObjPtr

  • Get data object pointer of extrinsic function library
  • Function returns Pointer
  • Arguments:
    • libidx : Integer
      Library index

gmoGetHeadnTail

  • Get value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)
  • Function returns Double
  • Arguments:
    • htrec : Integer
      Solution head or tail record, (see enumerated constants)

gmoGetHeadNTailTxt

  • String for solution head or tail record
  • Function returns Integer
  • Arguments:
    • htrec : Integer
      Solution head or tail record, (see enumerated constants)
      out s : ShortString
      String

gmoGetiModel

  • Get equation index in model (original) space
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetIndicatorMap

  • Get indicator constraint list
  • Function returns Integer
  • Arguments:
    • optptr : Pointer
      Option object pointer
      indicstrict : Integer
      1: Make the indicator reading strict. 0: accept duplicates, unmatched vars and equs, etc
      var numindic : Integer
      Number of indicator constraints
      rowindic : PLongIntArray
      map with row indicies
      colindic : PLongIntArray
      map with column indicies
      indiconval : PLongIntArray
      0 or 1 value for binary variable to activate the constraint

gmoGetiSolver

  • Get equation index in solver space
  • Function returns Integer
  • Arguments:
    • mi : Integer
      Index of row in original/GAMS space

gmoGetJacUpdate

  • Retrieve the updated Jacobian elements
  • Function returns Integer
  • Arguments:
    • rowidx : PLongIntArray
      Row index/indices of Jacobian
      colidx : PLongIntArray
      Column index/indices of Jacobian(s)
      jacval : PDoubleArray
      Value(s) of Jacobian(s)
      var len : Integer
      Length of array

gmoGetjModel

  • Get variable index in model (original) space
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetjSolver

  • Get variable index in solver space
  • Function returns Integer
  • Arguments:
    • mj : Integer
      Index of column original/GAMS client space

gmoGetMatrixCol

  • Get constraint matrix in column order with columns start only and NL indicator
  • Function returns Integer
  • Arguments:
    • colstart : PLongIntArray
      Index of Jacobian column starts with
      rowidx : PLongIntArray
      Row index/indices of Jacobian
      jacval : PDoubleArray
      Value(s) of Jacobian(s)
      nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoGetMatrixCplex

  • Get constraint matrix in column order with column start and end (colstart length is n+1)
  • Function returns Integer
  • Arguments:
    • colstart : PLongIntArray
      Index of Jacobian column starts with
      collength : PLongIntArray
      Number of Jacobians in column
      rowidx : PLongIntArray
      Row index/indices of Jacobian
      jacval : PDoubleArray
      Value(s) of Jacobian(s)

gmoGetMatrixRow

  • Get constraint matrix in row order with row start only and NL indicator
  • Function returns Integer
  • Arguments:
    • rowstart : PLongIntArray
      Index of Jacobian row starts with
      colidx : PLongIntArray
      Column index/indices of Jacobian(s)
      jacval : PDoubleArray
      Value(s) of Jacobian(s)
      nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoGetModelStatusTxt

  • String for modelstatus
  • Function returns Integer
  • Arguments:
    • modelstat : Integer
      Model status
      out s : ShortString
      String

gmoGetModelTypeTxt

  • String for modeltype
  • Function returns Integer
  • Arguments:
    • out s : ShortString
      String

gmoGetObjName

  • Get name of objective
  • Function returns ShortString

gmoGetObjNameCustom

  • Get name of objective with user specified suffix
  • Function returns ShortString
  • Arguments:
    • const suffix : ShortString
      Suffix appended to name, could be .l, .m etc.

gmoGetObjOrder

  • Order of Objective, see enumerated constants
  • Property of type Integer
  • Actions
    • r

gmoGetObjQ

  • Get Q matrix of objective (NOTE: coefficients on the diagonal are doubled)
  • Function returns Integer
  • Arguments:
    • varidx1 : PLongIntArray
      First variable indices
      varidx2 : PLongIntArray
      Second variable indices
      coefs : PDoubleArray
      Coefficients

gmoGetObjSparse

  • Get Jacobians information of objective function (sparse)
  • Function returns Integer
  • Arguments:
    • colidx : PLongIntArray
      Column index/indices of Jacobian(s)
      jacval : PDoubleArray
      Value(s) of Jacobian(s)
      nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)
      out nz : Integer
      Number of nonzeros
      out nlnz : Integer
      Number of nonlinear nonzeros

gmoGetObjStat

  • Get obj counts
  • Function returns Integer
  • Arguments:
    • out nz : Integer
      Number of nonzeros
      out qnz : Integer
      Number of quadratic nonzeros
      out nlnz : Integer
      Number of nonlinear nonzeros

gmoGetObjVector

  • Get objective function vector (dense)
  • Function returns Integer
  • Arguments:
    • jacval : PDoubleArray
      Value(s) of Jacobian(s)
      nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoGetRelativeGap

  • Compute relative gap w.r.t. objective value and objective estimate in head or tail records
  • Function returns Double

gmoGetRhs

  • Get right hand sides
  • Function returns Integer
  • Arguments:
    • mdblvec : PDoubleArray
      Array of doubles, len=number of rows in user view

gmoGetRhsOne

  • Get individual equation right hand side
  • Function returns Double
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetRowJacInfoOne

  • Get Jacobian information of row one by one
  • Procedure
  • Arguments:
    • si : Integer
      Index of row in client space
      var jacptr : Pointer
      Pointer to next Jacobian
      out jacval : Double
      Value(s) of Jacobian(s)
      out colidx : Integer
      Column index/indices of Jacobian(s)
      out nlflag : Integer
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)

gmoGetRowQ

  • Get Q matrix of row (NOTE: coefficients on the diagonal are doubled)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      varidx1 : PLongIntArray
      First variable indices
      varidx2 : PLongIntArray
      Second variable indices
      coefs : PDoubleArray
      Coefficients

gmoGetRowQDiagNZOne

  • Number of NZ on diagonal of Q matrix of row si (-1 if Q information not used)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetRowQNZOne

  • Number of NZ in Q matrix of row si (-1 if Q information not used)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoGetRowSparse

  • Get Jacobians information of row (sparse)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      colidx : PLongIntArray
      Column index/indices of Jacobian(s)
      jacval : PDoubleArray
      Value(s) of Jacobian(s)
      nlflag : PLongIntArray
      NL flag(s) of Jacobian(s) (0=linear,<>0=nonlinear)
      out nz : Integer
      Number of nonzeros
      out nlnz : Integer
      Number of nonlinear nonzeros

gmoGetRowStat

  • Get row counts
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      out nz : Integer
      Number of nonzeros
      out qnz : Integer
      Number of quadratic nonzeros
      out nlnz : Integer
      Number of nonlinear nonzeros

gmoGetSolutionEquRec

  • Get equation solution values (level, marginals and statuses)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      out el : Double
      Level of equation
      out emarg : Double
      Marginal of equation
      out estat : Integer
      Basis status of equation (see enumerated constants)
      out ecstat : Integer
      Status of equation (see enumerated constants)

gmoGetSolutionVarRec

  • Get variable solution values (level, marginals and statuses)
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space
      out vl : Double
      Level of variable
      out vmarg : Double
      Marginal of variable
      out vstat : Integer
      Basis status of variable (see enumerated constants)
      out vcstat : Integer
      Status of variable (see enumerated constants)

gmoGetSolveStatusTxt

  • String for solvestatus
  • Function returns Integer
  • Arguments:
    • solvestat : Integer
      Solver status
      out s : ShortString
      String

gmoGetSosConstraints

  • Get SOS constraints
  • Function returns Integer
  • Arguments:
    • sostype : PLongIntArray
      SOS type 1 or 2
      sosbeg : PLongIntArray
      Variable index start of SOS set
      sosind : PLongIntArray
      Variable indices
      soswt : PDoubleArray
      Weight in SOS set

gmoGetSosCounts

  • Get SOS count information
  • Procedure
  • Arguments:
    • out numsos1 : Integer
      Number of SOS1 sets
      out numsos2 : Integer
      Number of SOS2 sets
      out nzsos : Integer
      Number of variables in SOS1/2 sets

gmoGetVarCStat

  • Get variable status
  • Procedure
  • Arguments:
    • nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoGetVarCStatOne

  • Get individual variable status
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarDblDotOpt

  • Get variable double values for dot option
  • Function returns Integer
  • Arguments:
    • optptr : Pointer
      Option object pointer
      const dotopt : ShortString
      Dot option name
      optvals : PDoubleArray
      Option values

gmoGetVarEquMap

  • Get variable equation mapping list
  • Function returns Integer
  • Arguments:
    • maptype : Integer
      Type of variable equation mapping
      optptr : Pointer
      Option object pointer
      strict : Integer
      var nmappings : Integer
      rowindex : PLongIntArray
      colindex : PLongIntArray
      mapval : PLongIntArray

gmoGetVarIntDotOpt

  • Get variable integer values for dot option
  • Function returns Integer
  • Arguments:
    • optptr : Pointer
      Option object pointer
      const dotopt : ShortString
      Dot option name
      optvals : PLongIntArray
      Option values

gmoGetVarL

  • Get variable level values
  • Function returns Integer
  • Arguments:
    • x : PDoubleArray
      Level values of variables

gmoGetVarLOne

  • Get individual variable level
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarLower

  • Get variable lower bounds
  • Function returns Integer
  • Arguments:
    • lovec : PDoubleArray
      Lower bound values of variables

gmoGetVarLowerOne

  • Get individual variable lower bound
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarM

  • Get variable marginals
  • Function returns Integer
  • Arguments:
    • dj : PDoubleArray
      Marginal values of variables

gmoGetVarMatch

  • Get variable match
  • Function returns Integer
  • Arguments:
    • nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoGetVarMatchOne

  • Get individual variable match
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarMOne

  • Get individual variable marginal
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarNameCustomOne

  • Get individual column name with quotes and user specified suffix
  • Function returns ShortString
  • Arguments:
    • sj : Integer
      Index of column in client space
      const suffix : ShortString
      Suffix appended to name, could be .l, .m etc.

gmoGetVarNameOne

  • Get individual column name
  • Function returns ShortString
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarPrior

  • Get variable branching priority
  • Function returns Integer
  • Arguments:
    • ndblvec : PDoubleArray
      Array of doubles, len=number of columns in user view

gmoGetVarPriorOne

  • Get individual variable branching priority
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarScale

  • Get variable scale
  • Function returns Integer
  • Arguments:
    • ndblvec : PDoubleArray
      Array of doubles, len=number of columns in user view

gmoGetVarScaleOne

  • Get individual variable scale
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarSosSetOne

  • Get SOS set for individual variable
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarStageOne

  • Get individual variable stage
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarStat

  • Get variable basis status
  • Procedure
  • Arguments:
    • nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoGetVarStatOne

  • Get individual variable basis status
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarType

  • Get variable type
  • Function returns Integer
  • Arguments:
    • nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoGetVarTypeCnt

  • Get variable type count
  • Function returns Integer
  • Arguments:
    • vtyp : Integer
      Type of variable (see enumerated constants)

gmoGetVarTypeOne

  • Get individual variable type
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarTypeTxt

  • String for variable type
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space
      out s : ShortString
      String

gmoGetVarUpper

  • Get variable upper bounds
  • Function returns Integer
  • Arguments:
    • upvec : PDoubleArray
      Upper bound values of variables

gmoGetVarUpperOne

  • Get individual variable upper bound
  • Function returns Double
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetVarVI

  • Get VI mapping for all cols (-1 if not a VI variable)
  • Function returns Integer
  • Arguments:
    • nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoGetVarVIOne

  • Get VI mapping for individual cols (-1 if not a VI variable)
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space

gmoGetXLibCounts

  • Get external function information
  • Procedure
  • Arguments:
    • out rows : Integer
      Number of rows
      out cols : Integer
      Number of columns
      out nz : Integer
      Number of nonzeros
      orgcolind : PLongIntArray
      Original/GAMS column indices

gmoGNLNZ

  • Number of general nonlinear nonzeros in matrix, equals gmoNLNZ if gmoUseQ is false
  • Property of type Integer
  • Actions
    • r

gmoHaveBasis(Set)

  • Do we have basis
  • Property of type Integer
  • Actions
    • r
    • w

gmoHessDim

  • Hessian dimension of row
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoHessLagDiagNz

  • Nonzeros on Diagonal of Hessian of the Lagrangian
  • Property of type Integer
  • Actions
    • r

gmoHessLagDim

  • Dimension of Hessian of the Lagrangian
  • Property of type Integer
  • Actions
    • r

gmoHessLagNz

  • Nonzeros in Hessian of the Lagrangian
  • Property of type Integer
  • Actions
    • r

gmoHessLagStruct

  • Get Hessian of the Lagrangian Value structure
  • Function returns Integer
  • Arguments:
    • WRindex : PLongIntArray
      Row indices for the upper triangle of the symmetric matrix W (the Hessian of the Lagrangian), ordered by rows and within rows by columns
      WCindex : PLongIntArray
      Col indices for the upper triangle of the symmetric matrix W (the Hessian of the Lagrangian), ordered by rows and within rows by columns

gmoHessLagValue

  • Get Hessian of the Lagrangian Value
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      const pi : PDoubleArray
      Marginal values of equations
      w : PDoubleArray
      Values for the structural nonzeros of the upper triangle of the symmetric matrix W (the Hessian of the Lagrangian), ordered by rows and within rows by columns
      objweight : Double
      Weight for objective in Hessian of the Lagrangian (=1 for GAMS convention)
      conweight : Double
      Weight for constraints in Hessian of the Lagrangian (=1 for GAMS convention)
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoHessLagVec

  • Get Hessian of the Lagrangian-vector product
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      const pi : PDoubleArray
      Marginal values of equations
      const dx : PDoubleArray
      Direction in x-space for directional derivative of Lagrangian (W*dx)
      Wdx : PDoubleArray
      Directional derivative of the Lagrangian in direction dx (W*dx)
      objweight : Double
      Weight for objective in Hessian of the Lagrangian (=1 for GAMS convention)
      conweight : Double
      Weight for constraints in Hessian of the Lagrangian (=1 for GAMS convention)
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoHessLoad

  • Initialize Hessians
  • Function returns Integer
  • Arguments:
    • maxJacMult : Double
      Multiplier to define memory limit for Hessian (0=no limit)
      var do2dir : Integer
      Flag whether 2nd derivatives are wanted/available
      var doHess : Integer
      Flag whether Hessians are wanted/available

gmoHessMaxDim

  • Maximum dimension of Hessian
  • Property of type Integer
  • Actions
    • r

gmoHessMaxNz

  • Maximum number of nonzeros in Hessian
  • Property of type Integer
  • Actions
    • r

gmoHessNz

  • Hessian nonzeros of row
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space

gmoHessStruct

  • Get Hessian Structure
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      hridx : PLongIntArray
      Hessian row indices
      hcidx : PLongIntArray
      Hessian column indices
      out hessdim : Integer
      Dimension of Hessian
      out hessnz : Integer
      Number of nonzeros in Hessian

gmoHessUnload

  • Unload Hessians
  • Function returns Integer

gmoHessValue

  • Get Hessian Value
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      hridx : PLongIntArray
      Hessian row indices
      hcidx : PLongIntArray
      Hessian column indices
      out hessdim : Integer
      Dimension of Hessian
      out hessnz : Integer
      Number of nonzeros in Hessian
      const x : PDoubleArray
      Level values of variables
      hessval : PDoubleArray
      Values of Hessian
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoHessVec

  • Get Hessian-vector product
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      const x : PDoubleArray
      Level values of variables
      const dx : PDoubleArray
      Direction in x-space for directional derivative of Lagrangian (W*dx)
      Wdx : PDoubleArray
      Directional derivative of the Lagrangian in direction dx (W*dx)
      out numerr : Integer
      Number of errors evaluating the nonlinear function

gmoIgnXCDeriv(Set)

  • Consider constant derivatives in external functions or not
  • Property of type Boolean
  • Actions
    • r
    • w

gmoIndexBase(Set)

  • User array index base (0 or 1)
  • Property of type Integer
  • Actions
    • r
    • w

gmoInitData

  • Initialize GMO data
  • Function returns Integer
  • Arguments:
    • rows : Integer
      Number of rows
      cols : Integer
      Number of columns
      codelen : Integer
      length of NL code

gmoInterface(Set)

  • Interface type (raw vs. processed), see enumerated constants
  • Property of type Integer
  • Actions
    • r
    • w

gmoIOMutex

  • IO mutex
  • Property of type Pointer
  • Actions
    • r

gmoIsMPSGE(Set)

  • Is this an MPSGE model
  • Property of type Boolean
  • Actions
    • r
    • w

gmoIsQP

  • Is this a QP or not
  • Property of type Boolean
  • Actions
    • r

gmoLNZ

  • Number of linear nonzeros in matrix, contains linear nonzeros of Q part if gmoUseQ is true
  • Property of type Integer
  • Actions
    • r

gmoLoadDataLegacy

  • Read instance from scratch files - Legacy Mode
  • Function returns Integer
  • Arguments:
    • out msg : ShortString
      Message

gmoLoadEMPInfo

  • Load EMP information
  • Function returns Integer
  • Arguments:
    • const empinfofname : ShortString
      Name of EMP information file, if empty assume the default name and location

gmoLoadExtrLibEntry

  • Load a function from an extrinsic function library
  • Function returns Pointer
  • Arguments:
    • libidx : Integer
      Library index
      const name : ShortString
      out msg : ShortString
      Message

gmoLoadSolutionGDX

  • Load solution to GDX solution file (optional: rows, cols and-or header and tail info)
  • Function returns Integer
  • Arguments:
    • const gdxfname : ShortString
      Name of GDX file
      const dorows : Boolean
      Flag whether to read/write row information from/to solution file
      const docols : Boolean
      Flag whether to read/write column information from/to solution file
      const doht : Boolean
      Flag whether to read/write head and tail information from/to solution file

gmoLoadSolutionLegacy

  • Load solution from legacy solution file
  • Function returns Integer

gmoM

  • Number of rows
  • Property of type Integer
  • Actions
    • r

gmoMaxQNZ

  • Maximum number of nonzeros in single Q matrix
  • Property of type Integer
  • Actions
    • r

gmoMemUsed

  • Get current memory consumption of GMO in MB
  • Function returns Double

gmoMinf(Set)

  • Value for minus infinity
  • Property of type Double
  • Actions
    • r
    • w

gmoModelSeqNr(Set)

  • Sequence number of model (0..n)
  • Property of type Integer
  • Actions
    • r
    • w

gmoModelStat(Set)

  • Model status, see enumerated constants
  • Property of type Integer
  • Actions
    • r
    • w

gmoModelType(Set)

  • Type of Model
  • Property of type Integer
  • Actions
    • r
    • w

gmoN

  • Number of columns
  • Property of type Integer
  • Actions
    • r

gmoNameDict(Set)

  • Name of dictionary file
  • Property of type ShortString
  • Actions
    • r
    • w

gmoNameInput

  • Name of input file (with .gms stripped)
  • Property of type ShortString
  • Actions
    • r

gmoNameModel(Set)

  • Name of model
  • Property of type ShortString
  • Actions
    • r
    • w

gmoNameOptFile(Set)

  • Name of option file
  • Property of type ShortString
  • Actions
    • r
    • w

gmoNameOutput

  • Name of output file (with .dat stripped)
  • Property of type ShortString
  • Actions
    • r

gmoNameSolFile(Set)

  • Name of solution file
  • Property of type ShortString
  • Actions
    • r
    • w

gmoNameXLib(Set)

  • Name of external function library
  • Property of type ShortString
  • Actions
    • r
    • w

gmoNColMatch

  • Number of matched columns
  • Property of type Integer
  • Actions
    • r

gmoNDisc

  • Number of discontinuous columns
  • Property of type Integer
  • Actions
    • r

gmoNFixed

  • Number of fixed columns
  • Property of type Integer
  • Actions
    • r

gmoNLCodeSize(Set)

  • Nonlinear code size
  • Property of type Integer
  • Actions
    • r
    • w

gmoNLCodeSizeMaxRow

  • Maximum nonlinear code size for rows
  • Property of type Integer
  • Actions
    • r

gmoNLConst(Set)

  • Length of constant pool in nonlinear code
  • Property of type Integer
  • Actions
    • r
    • w

gmoNLM

  • Number of nonlinear rows
  • Property of type Integer
  • Actions
    • r

gmoNLN

  • Number of nonlinear columns
  • Property of type Integer
  • Actions
    • r

gmoNLNZ

  • Number of nonlinear nonzeros in matrix
  • Property of type Integer
  • Actions
    • r

gmoNRowMatch

  • Number of matched rows
  • Property of type Integer
  • Actions
    • r

gmoNumAgents

  • EMP: Number of Agents/Followers
  • Property of type Integer
  • Actions
    • r

gmoNumVIFunc

  • EMP: Number of variational inequalities in model rim
  • Property of type Integer
  • Actions
    • r

gmoNZ

  • Number of nonzeros in matrix
  • Property of type Integer
  • Actions
    • r

gmoObjConst

  • Objective constant
  • Property of type Double
  • Actions
    • r

gmoObjJacVal

  • Value of Jacobian element of objective variable in objective
  • Property of type Double
  • Actions
    • r

gmoObjNLNZ

  • Number of nonlinear nonzeros in objective
  • Property of type Integer
  • Actions
    • r

gmoObjNZ

  • Number of nonzeros in objective
  • Property of type Integer
  • Actions
    • r

gmoObjQDiagNZ

  • Number of nonzeros on diagonal of Q matrix of objective (-1 if Q information not used)
  • Property of type Integer
  • Actions
    • r

gmoObjQNZ

  • Number of nonzeros in Q matrix of objective (-1 if Q information not used)
  • Property of type Integer
  • Actions
    • r

gmoObjReform(Set)

  • Reformulate objective if possible
  • Property of type Boolean
  • Actions
    • r
    • w

gmoObjRow

  • Index of objective row
  • Property of type Integer
  • Actions
    • r

gmoObjStyle(Set)

  • Style of objective, see enumerated constants
  • Property of type Integer
  • Actions
    • r
    • w

gmoObjVar(Set)

  • Index of objective variable
  • Property of type Integer
  • Actions
    • r
    • w

gmoOptFile(Set)

  • Number of option file
  • Property of type Integer
  • Actions
    • r
    • w

gmoPeakMemUsed

  • Get peak memory consumption of GMO in MB
  • Function returns Double

gmoPermuteCols(Set)

  • Column permutation flag
  • Property of type Boolean
  • Actions
    • r
    • w

gmoPermuteRows(Set)

  • Row permutation flag
  • Property of type Boolean
  • Actions
    • r
    • w

gmoPinf(Set)

  • Value for plus infinity
  • Property of type Double
  • Actions
    • r
    • w

gmoPPool

  • Pointer to constant pool
  • Property of type Pointer
  • Actions
    • r

gmoPrepareAllSolToGDX

  • Initialize writing of multiple solutions (e.g. scenarios) to a GDX file
  • Function returns Integer
  • Arguments:
    • const gdxfname : ShortString
      Name of GDX file
      scengdx : Pointer
      Pointer to GDX solution file containing multiple solutions, e.g. scenarios
      dictid : Integer
      GDX symbol number of dict

gmoPrepareSolPoolMerge

  • Prepare merged solution pool GDX file
  • Function returns Pointer
  • Arguments:
    • const gdxfname : ShortString
      Name of GDX file
      numsol : Integer
      Number of solutions in solution pool
      const prefix : ShortString

gmoPrepareSolPoolNextSym

  • Write solution to merged solution pool GDX file
  • Function returns Integer
  • Arguments:
    • handle : Pointer

gmoPriorOpt(Set)

  • Priority Flag
  • Property of type Integer
  • Actions
    • r
    • w

gmoQM

  • Number of quadratic rows (-1 if Q information not used)
  • Property of type Integer
  • Actions
    • r

gmoQNaN

  • quiet IEEE NaN
  • Property of type Double
  • Actions
    • r

gmoQNZ

  • Number of quadratic nonzeros in matrix, 0 if gmoUseQ is false
  • Property of type Integer
  • Actions
    • r

gmoRegisterEnvironment

  • Register GAMS environment
  • Function returns Integer
  • Arguments:
    • gevptr : Pointer
      Pointer to GAMS environment object
      out msg : ShortString
      Message

gmoScaleOpt(Set)

  • Scaling flag
  • Property of type Integer
  • Actions
    • r
    • w

gmoSense(Set)

  • Direction of optimization, see enumerated constants
  • Property of type Integer
  • Actions
    • r
    • w

gmoSetAltRHS

  • Set alternative RHS
  • Function returns Integer
  • Arguments:
    • const mdblvec : PDoubleArray
      Array of doubles, len=number of rows in user view

gmoSetAltRHSOne

  • Set individual alternative RHS
  • Procedure
  • Arguments:
    • si : Integer
      Index of row in client space
      erhs : Double
      RHS of equation

gmoSetAltVarBounds

  • Set alternative variable lower and upper bounds
  • Function returns Integer
  • Arguments:
    • const lovec : PDoubleArray
      Lower bound values of variables
      const upvec : PDoubleArray
      Upper bound values of variables

gmoSetAltVarLowerOne

  • Set individual alternative variable lower bound
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      vlo : Double
      Lower bound of variable

gmoSetAltVarType

  • Set alternative variable type
  • Function returns Integer
  • Arguments:
    • const nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoSetAltVarTypeOne

  • Set individual alternative variable type
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      vtyp : Integer
      Type of variable (see enumerated constants)

gmoSetAltVarUpperOne

  • Set individual alternative variable upper bound
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      vup : Double
      Upper bound of variable

gmoSetEquCStat

  • Set equation status
  • Procedure
  • Arguments:
    • const mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoSetEquL

  • Set equation activity levels
  • Function returns Integer
  • Arguments:
    • const el : PDoubleArray
      Level of equation

gmoSetEquLOne

  • Set individual equation activity levels
  • Procedure
  • Arguments:
    • si : Integer
      Index of row in client space
      el : Double
      Level of equation

gmoSetEquM

  • Set equation marginals (pass NULL to set to NA)
  • Function returns Integer
  • Arguments:
    • const emarg : PDoubleArray
      Marginal of equation

gmoSetEquPermutation

  • Set Permutation vectors for equations (model view)
  • Function returns Integer
  • Arguments:
    • permut : PLongIntArray
      Permutation vector (original/GAMS to client)

gmoSetEquSlack

  • Set equation slacks
  • Function returns Integer
  • Arguments:
    • const mdblvec : PDoubleArray
      Array of doubles, len=number of rows in user view

gmoSetEquStat

  • Set equation basis status
  • Procedure
  • Arguments:
    • const mintvec : PLongIntArray
      Array of integers, len=number of rows in user view

gmoSetExtFuncs

  • Set external function manager object
  • Procedure
  • Arguments:
    • extfunmgr : Pointer
      pointer to external function manager object

gmoSetHeadnTail

  • Set value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)
  • Procedure
  • Arguments:
    • htrec : Integer
      Solution head or tail record, (see enumerated constants)
      dval : Double
      Double value

gmoSetNLObject

  • Set NL Object and constant pool
  • Function returns Integer
  • Arguments:
    • nlobject : Pointer
      Object of nonlinear instructions
      nlpool : Pointer
      Constant pool object for constants in nonlinear instruction

gmoSetNRowPerm

  • Set Permutation to skip =n= rows
  • Function returns Integer

gmoSetRvEquPermutation

  • Set Permutation vectors for equations (solver view)
  • Function returns Integer
  • Arguments:
    • rvpermut : PLongIntArray
      Reverse permutation vector (client to original/GAMS)
      len : Integer
      Length of array

gmoSetRvVarPermutation

  • Set Permutation vectors for variables (solver view)
  • Function returns Integer
  • Arguments:
    • rvpermut : PLongIntArray
      Reverse permutation vector (client to original/GAMS)
      len : Integer
      Length of array

gmoSetSolution

  • Set solution values for variable and equation levels as well as marginals
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      const dj : PDoubleArray
      Marginal values of variables
      const pi : PDoubleArray
      Marginal values of equations
      const e : PDoubleArray
      Level values of equations

gmoSetSolution2

  • Set solution values for variable levels and equation marginals
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      const pi : PDoubleArray
      Marginal values of equations

gmoSetSolution8

  • Set solution values for variable and equation levels, marginals and statuses
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables
      const dj : PDoubleArray
      Marginal values of variables
      const pi : PDoubleArray
      Marginal values of equations
      const e : PDoubleArray
      Level values of equations
      xb : PLongIntArray
      Basis statuses of variables (see enumerated constants)
      xs : PLongIntArray
      Statuses of variables (see enumerated constants)
      yb : PLongIntArray
      Basis statuses of equations (see enumerated constants)
      ys : PLongIntArray
      Statuses of equation (see enumerated constants)

gmoSetSolutionEquRec

  • Set equation solution values (level, marginals and statuses)
  • Function returns Integer
  • Arguments:
    • si : Integer
      Index of row in client space
      el : Double
      Level of equation
      emarg : Double
      Marginal of equation
      estat : Integer
      Basis status of equation (see enumerated constants)
      ecstat : Integer
      Status of equation (see enumerated constants)

gmoSetSolutionFixer

  • Construct and set solution based on available inputs
  • Function returns Integer
  • Arguments:
    • modelstathint: Integer
      Model status used as a hint
      const x : PDoubleArray
      Level values of variables
      const pi : PDoubleArray
      Marginal values of equations
      const xb : PLongIntArray
      Basis statuses of variables (see enumerated constants)
      const yb : PLongIntArray
      Basis statuses of equations (see enumerated constants)
      infTol : Double
      Infeasibility tolerance
      optTol : Double
      Optimality tolerance

gmoSetSolutionPrimal

  • Set solution values for variable levels
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables

gmoSetSolutionStatus

  • Set solution values sfor variable and equation statuses
  • Function returns Integer
  • Arguments:
    • xb : PLongIntArray
      Basis statuses of variables (see enumerated constants)
      xs : PLongIntArray
      Statuses of variables (see enumerated constants)
      yb : PLongIntArray
      Basis statuses of equations (see enumerated constants)
      ys : PLongIntArray
      Statuses of equation (see enumerated constants)

gmoSetSolutionVarRec

  • Set variable solution values (level, marginals and statuses)
  • Function returns Integer
  • Arguments:
    • sj : Integer
      Index of column in client space
      vl : Double
      Level of variable
      vmarg : Double
      Marginal of variable
      vstat : Integer
      Basis status of variable (see enumerated constants)
      vcstat : Integer
      Status of variable (see enumerated constants)

gmoSetVarCStat

  • Set variable status
  • Procedure
  • Arguments:
    • const nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoSetVarL

  • Set variable level values
  • Function returns Integer
  • Arguments:
    • const x : PDoubleArray
      Level values of variables

gmoSetVarLOne

  • Set individual variable level
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      vl : Double
      Level of variable

gmoSetVarM

  • Set variable marginals (pass null to set to NA)
  • Function returns Integer
  • Arguments:
    • const dj : PDoubleArray
      Marginal values of variables

gmoSetVarMOne

  • Set individual variable marginal
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      vmarg : Double
      Marginal of variable

gmoSetVarPermutation

  • Set Permutation vectors for variables (model view)
  • Function returns Integer
  • Arguments:
    • permut : PLongIntArray
      Permutation vector (original/GAMS to client)

gmoSetVarStat

  • Set variable basis status
  • Procedure
  • Arguments:
    • const nintvec : PLongIntArray
      Array of integers, len=number of columns in user view

gmoSetVarStatOne

  • Set individual variable basis status
  • Procedure
  • Arguments:
    • sj : Integer
      Index of column in client space
      vstat : Integer
      Basis status of variable (see enumerated constants)

gmoSolveStat(Set)

  • Solver status, see enumerated constants
  • Property of type Integer
  • Actions
    • r
    • w

gmoUnloadSolPoolSolution

  • Write solution to merged solution pool GDX file
  • Function returns Integer
  • Arguments:
    • handle : Pointer
      numsol : Integer
      Number of solutions in solution pool

gmoUnloadSolutionGDX

  • Unload solution to GDX solution file (optional: rows, cols and-or header and tail info)
  • Function returns Integer
  • Arguments:
    • const gdxfname : ShortString
      Name of GDX file
      const dorows : Boolean
      Flag whether to read/write row information from/to solution file
      const docols : Boolean
      Flag whether to read/write column information from/to solution file
      const doht : Boolean
      Flag whether to read/write head and tail information from/to solution file

gmoUnloadSolutionLegacy

  • Unload solution to legacy solution file
  • Function returns Integer

gmoUseQ(Set)

  • Toggle Q-mode
  • Property of type Boolean
  • Actions
    • r
    • w

gmoValNA

  • Double Value of N/A
  • Property of type Double
  • Actions
    • r

gmoValNAInt

  • Integer Value of N/A
  • Property of type Integer
  • Actions
    • r

gmoValUndf

  • Double Value of UNDF
  • Property of type Double
  • Actions
    • r

gmoViewDump

  • Dump current view to stdout
  • Procedure

gmoViewRestore

  • Restore view
  • Procedure
  • Arguments:
    • var viewptr : Pointer
      Pointer to structure storing the view of a model

gmoViewStore

  • Store current view in view object
  • Function returns Pointer

gmoWriteSolDone

  • Finalize writing of multiple solutions (e.g. scenarios) to a GDX file
  • Function returns Integer
  • Arguments:
    • out msg : ShortString
      Message

Enumerated Constants

  • gmoEquType
    • gmoequ = 0
    • gmoequ = 1
    • gmoequ = 2
    • gmoequ = 3
    • gmoequ = 4
    • gmoequ = 5
    • gmoequ = 6
  • gmoVarType
    • gmovar_ = 0
    • gmovar_ = 1
    • gmovar_ = 2
    • gmovar_ = 3
    • gmovar_ = 4
    • gmovar_ = 5
    • gmovar_ = 6
  • gmoEquOrder
    • gmoorder_E = 0
    • gmoorder_L = 1
    • gmoorder_Q = 2
    • gmoorder_N = 3
  • gmoVarFreeType
    • gmovar_X = 0
    • gmovar_X = 1
    • gmovar_X = 2
  • gmoVarEquBasisStatus
    • gmoBstat_Low = 0
    • gmoBstat_Upp = 1
    • gmoBstat_Bas = 2
    • gmoBstat_Sup = 3
  • gmoVarEquStatus
    • gmoCstat_OK = 0
    • gmoCstat_NonO = 1
    • gmoCstat_Infe = 2
    • gmoCstat_UnBn = 3
  • gmoObjectiveType
    • gmoObjType_V = 0
    • gmoObjType_F = 2
  • gmoInterfaceType
    • gmoIFace_Process = 0
    • gmoIFace_Raw = 1
  • gmoObjectiveSense
    • gmoObj_M = 0
    • gmoObj_M = 1
  • gmoSolverStatus
    • gmoSolveStat_Normal = 1
    • gmoSolveStat_Iteration = 2
    • gmoSolveStat_Resource = 3
    • gmoSolveStat_Solver = 4
    • gmoSolveStat_EvalError = 5
    • gmoSolveStat_Capabilit = 6
    • gmoSolveStat_License = 7
    • gmoSolveStat_User = 8
    • gmoSolveStat_SetupErr = 9
    • gmoSolveStat_SolverErr = 10
    • gmoSolveStat_InternalE = 11
    • gmoSolveStat_Skipped = 12
    • gmoSolveStat_SystemErr = 13
  • gmoModelStatus
    • gmoModelStat_OptimalGlobal = 1
    • gmoModelStat_OptimalLocal = 2
    • gmoModelStat_Unbounded = 3
    • gmoModelStat_InfeasibleGlobal = 4
    • gmoModelStat_InfeasibleLocal = 5
    • gmoModelStat_InfeasibleIntermed = 6
    • gmoModelStat_Feasible = 7
    • gmoModelStat_Integer = 8
    • gmoModelStat_NonIntegerIntermed = 9
    • gmoModelStat_IntegerInfeasible = 10
    • gmoModelStat_LicenseError = 11
    • gmoModelStat_ErrorUnknown = 12
    • gmoModelStat_ErrorNoSolution = 13
    • gmoModelStat_NoSolutionReturned = 14
    • gmoModelStat_SolvedUnique = 15
    • gmoModelStat_Solved = 16
    • gmoModelStat_SolvedSingular = 17
    • gmoModelStat_UnboundedNoSolutio = 18
    • gmoModelStat_InfeasibleNoSoluti = 19
  • gmoHeadnTail
    • gmoHiteruse = 3
    • gmoHresused = 4
    • gmoHobjval = 5
    • gmoHdomused = 6
    • gmoHmargina = 9
    • gmoHetalg = 10
    • gmoTmipnod = 11
    • gmoTninf = 12
    • gmoTnopt = 13
    • gmoTmipbest = 15
    • gmoTsinf = 20
    • gmoTrobj = 22
  • gmoHTcard
    • gmonumhead = 10
    • gmonumtail = 12
  • gmoProcType
    • gmoProc_none = 0
    • gmoProc_lp = 1
    • gmoProc_mip = 2
    • gmoProc_rmip = 3
    • gmoProc_nlp = 4
    • gmoProc_mcp = 5
    • gmoProc_mpec = 6
    • gmoProc_rmpec = 7
    • gmoProc_cns = 8
    • gmoProc_dnlp = 9
    • gmoProc_rminlp = 10
    • gmoProc_minlp = 11
    • gmoProc_qcp = 12
    • gmoProc_miqcp = 13
    • gmoProc_rmiqcp = 14
    • gmoProc_emp = 15
    • gmoProc_nrofmodeltyp = 16
  • gmoEMPAgentType
    • gmoMinAge = 0
    • gmoMaxAge = 1
    • gmoVIAgen = 2
  • gmoEvalErrorMethodNum
    • gmoEVALERRORMETHOD_KEEPGOI = 0
    • gmoEVALERRORMETHOD_FASTSTO = 1

Undocumented Arguments

  • colindex
  • handle
  • mapval
  • name
  • nmappings
  • prefix
  • rowindex
  • strict