GMO API (GAMS Modeling Object)

Generated for GAMS ..

Functions, Procedures, and Properties

Initialization
Pointer	gmoDict
	Load GAMS dictionary object and obtain pointer to it

Pointer	gmoDictSet
	Load GAMS dictionary object and obtain pointer to it

Model Characteristics
ShortString	gmoNameModel
	Name of model

ShortString	gmoNameModelSet
	Name of model

Integer	gmoModelSeqNr
	Sequence number of model (0..n)

Integer	gmoModelSeqNrSet
	Sequence number of model (0..n)

Integer	gmoModelType
	Type of Model

Integer	gmoModelTypeSet
	Type of Model

Boolean	gmoNLModelType
	Type of Model

Integer	gmoSense
	Direction of optimization, see enumerated constants

Integer	gmoSenseSet
	Direction of optimization, see enumerated constants

Boolean	gmoIsQP
	Is this a QP or not

Integer	gmoOptFile
	Number of option file

Integer	gmoOptFileSet
	Number of option file

Integer	gmoDictionary
	Dictionary flag

Integer	gmoDictionarySet
	Dictionary flag

Integer	gmoScaleOpt
	Scaling flag

Integer	gmoScaleOptSet
	Scaling flag

Integer	gmoPriorOpt
	Priority Flag

Integer	gmoPriorOptSet
	Priority Flag

Integer	gmoHaveBasis
	Do we have basis

Integer	gmoHaveBasisSet
	Do we have basis

Integer	gmoModelStat
	Model status, see enumerated constants

Integer	gmoModelStatSet
	Model status, see enumerated constants

Integer	gmoSolveStat
	Solver status, see enumerated constants

Integer	gmoSolveStatSet
	Solver status, see enumerated constants

Boolean	gmoIsMPSGE
	Is this an MPSGE model

Boolean	gmoIsMPSGESet
	Is this an MPSGE model

Model View
Integer	gmoObjStyle
	Style of objective, see enumerated constants

Integer	gmoObjStyleSet
	Style of objective, see enumerated constants

Integer	gmoInterface
	Interface type (raw vs. processed), see enumerated constants

Integer	gmoInterfaceSet
	Interface type (raw vs. processed), see enumerated constants

Integer	gmoIndexBase
	User array index base (0 or 1)

Integer	gmoIndexBaseSet
	User array index base (0 or 1)

Boolean	gmoObjReform
	Reformulate objective if possible

Boolean	gmoObjReformSet
	Reformulate objective if possible

Deprecated
Boolean	gmoEmptyOut
	deprecated control for objective variable reformulation: currently has no effect

Boolean	gmoEmptyOutSet
	deprecated control for objective variable reformulation: currently has no effect

Model View
Boolean	gmoIgnXCDeriv
	Consider constant derivatives in external functions or not

Boolean	gmoIgnXCDerivSet
	Consider constant derivatives in external functions or not

Boolean	gmoUseQ
	Toggle Q-mode

Boolean	gmoUseQSet
	Toggle Q-mode

Integer	gmoQExtractAlg
	Choose Q extraction algorithm (must be set before UseQ; 0: automatic; 1: ThreePass; 2: DoubleForward; 3: Concurrent)

Integer	gmoQExtractAlgSet
	Choose Q extraction algorithm (must be set before UseQ; 0: automatic; 1: ThreePass; 2: DoubleForward; 3: Concurrent)

Double	gmoQExtractDenseSwitchFactor
	Q extraction algorithm sparse/dense factor (smaller values make dense count vector more likely: 0 implies dense always)

Double	gmoQExtractDenseSwitchFactorSet
	Q extraction algorithm sparse/dense factor (smaller values make dense count vector more likely: 0 implies dense always)

Boolean	gmoQExtractDenseSwitchLog
	Toggle log output related to Q extraction algorithm sparse/dense factor gmoQExtractDenseSwitchFactor

Boolean	gmoQExtractDenseSwitchLogSet
	Toggle log output related to Q extraction algorithm sparse/dense factor gmoQExtractDenseSwitchFactor

Boolean	gmoAltBounds
	Use alternative bound

Boolean	gmoAltBoundsSet
	Use alternative bound

Boolean	gmoAltRHS
	Use alternative RHS

Boolean	gmoAltRHSSet
	Use alternative RHS

Boolean	gmoAltVarTypes
	Use alternative variable types

Boolean	gmoAltVarTypesSet
	Use alternative variable types

Boolean	gmoForceLinear
	Force linear representation of model

Boolean	gmoForceLinearSet
	Force linear representation of model

Boolean	gmoForceCont
	Force continuous relaxation of model

Boolean	gmoForceContSet
	Force continuous relaxation of model

Boolean	gmoPermuteCols
	Column permutation flag

Boolean	gmoPermuteColsSet
	Column permutation flag

Boolean	gmoPermuteRows
	Row permutation flag

Boolean	gmoPermuteRowsSet
	Row permutation flag

Double	gmoPinf
	Value for plus infinity

Double	gmoPinfSet
	Value for plus infinity

Double	gmoMinf
	Value for minus infinity

Double	gmoMinfSet
	Value for minus infinity

Double	gmoQNaN
	quiet IEEE NaN

Double	gmoValNA
	Double Value of N/A

Integer	gmoValNAInt
	Integer Value of N/A

Double	gmoValUndf
	Double Value of UNDF

Model Statistics
Integer	gmoM
	Number of rows

Integer	gmoQM
	Number of quadratic rows (-1 if Q information not used)

Integer	gmoNLM
	Number of nonlinear rows

Integer	gmoNRowMatch
	Number of matched rows

Integer	gmoN
	Number of columns

Integer	gmoNLN
	Number of nonlinear columns

Integer	gmoNDisc
	Number of discontinuous columns

Integer	gmoNFixed
	Number of fixed columns

Integer	gmoNColMatch
	Number of matched columns

Integer	gmoNZ
	Number of nonzeros in Jacobian matrix

Int64	gmoNZ64
	Number of nonzeros in Jacobian matrix

Integer	gmoNLNZ
	Number of nonlinear nonzeros in Jacobian matrix

Int64	gmoNLNZ64
	Number of nonlinear nonzeros in Jacobian matrix

Integer	gmoLNZEx
	Number of linear nonzeros in Jacobian matrix

Int64	gmoLNZEx64
	Number of linear nonzeros in Jacobian matrix

Integer	gmoLNZ
	Legacy overestimate for the count of linear nonzeros in Jacobian matrix, especially if gmoUseQ is true

Int64	gmoLNZ64
	Legacy overestimate for the count of linear nonzeros in Jacobian matrix, especially if gmoUseQ is true

Integer	gmoQNZ
	Number of quadratic nonzeros in Jacobian matrix, 0 if gmoUseQ is false

Int64	gmoQNZ64
	Number of quadratic nonzeros in Jacobian matrix, 0 if gmoUseQ is false

Integer	gmoGNLNZ
	Number of general nonlinear nonzeros in Jacobian matrix, equals gmoNLNZ if gmoUseQ is false

Int64	gmoGNLNZ64
	Number of general nonlinear nonzeros in Jacobian matrix, equals gmoNLNZ if gmoUseQ is false

Integer	gmoMaxQNZ
	Maximum number of nonzeros in single Q matrix (-1 on overflow)

Int64	gmoMaxQNZ64
	Maximum number of nonzeros in single Q matrix

Integer	gmoObjNZ
	Number of nonzeros in objective gradient

Integer	gmoObjLNZ
	Number of linear nonzeros in objective gradient

Integer	gmoObjQNZEx
	Number of GMOORDER_Q nonzeros in objective gradient

Integer	gmoObjNLNZ
	Number of nonlinear nonzeros in objective gradient

Integer	gmoObjNLNZEx
	Number of GMOORDER_NL nonzeros in objective gradient

Integer	gmoObjQMatNZ
	Number of nonzeros in lower triangle of Q matrix of objective (-1 if useQ false or overflow)

Int64	gmoObjQMatNZ64
	Number of nonzeros in lower triangle of Q matrix of objective (-1 if useQ false)

Deprecated
Integer	gmoObjQNZ
	deprecated synonym for gmoObjQMatNZ

Model Statistics
Integer	gmoObjQDiagNZ
	Number of nonzeros on diagonal of Q matrix of objective (-1 if useQ false)

Integer	gmoObjCVecNZ
	Number of nonzeros in c vector of objective (-1 if Q information not used)

Integer	gmoNLConst
	Length of constant pool in nonlinear code

Integer	gmoNLConstSet
	Length of constant pool in nonlinear code

Integer	gmoNLCodeSize
	Nonlinear code size

Integer	gmoNLCodeSizeSet
	Nonlinear code size

Integer	gmoNLCodeSizeMaxRow
	Maximum nonlinear code size for rows

Integer	gmoObjVar
	Index of objective variable

Integer	gmoObjVarSet
	Index of objective variable

Integer	gmoObjRow
	Index of objective row

Integer	gmoGetObjOrder
	Order of Objective, see enumerated constants

Double	gmoObjConst
	Objective constant

Double	gmoObjConstEx
	Objective constant - this is independent of useQ

Double	gmoObjQConst
	Get constant in solvers quadratic objective

Objective Information
Double	gmoObjJacVal
	Value of Jacobian element of objective variable in objective

Evaluation (general)
Integer	gmoEvalErrorMethod
	Method for returning on nonlinear evaluation errors

Integer	gmoEvalErrorMethodSet
	Method for returning on nonlinear evaluation errors

Integer	gmoEvalMaxThreads
	Maximum number of threads that can be used for evaluation

Integer	gmoEvalMaxThreadsSet
	Maximum number of threads that can be used for evaluation

Function Evaluation
Integer	gmoEvalFuncCount
	Number of function evaluations

Double	gmoEvalFuncTimeUsed
	Time used for function evaluations in s

Gradient Evaluation
Integer	gmoEvalGradCount
	Number of gradient evaluations

Double	gmoEvalGradTimeUsed
	Time used for gradient evaluations in s

Hessian Evaluation
Integer	gmoHessMaxDim
	Maximum dimension of Hessian

Integer	gmoHessMaxNz
	Maximum number of nonzeros in Hessian

Int64	gmoHessMaxNz64
	Maximum number of nonzeros in Hessian

Integer	gmoHessLagDim
	Dimension of Hessian of the Lagrangian

Integer	gmoHessLagNz
	Nonzeros in Hessian of the Lagrangian

Int64	gmoHessLagNz64
	Nonzeros in Hessian of the Lagrangian

Integer	gmoHessLagDiagNz
	Nonzeros on Diagonal of Hessian of the Lagrangian

Boolean	gmoHessInclQRows
	if useQ is true, still include GMOORDER_Q rows in the Hessian

Boolean	gmoHessInclQRowsSet
	if useQ is true, still include GMOORDER_Q rows in the Hessian

EMP Information
Integer	gmoNumVIFunc
	EMP: Number of variational inequalities in model rim

Integer	gmoNumAgents
	EMP: Number of Agents/Followers

Names
ShortString	gmoNameOptFile
	Name of option file

ShortString	gmoNameOptFileSet
	Name of option file

ShortString	gmoNameSolFile
	Name of solution file

ShortString	gmoNameSolFileSet
	Name of solution file

ShortString	gmoNameXLib
	Name of external function library

ShortString	gmoNameXLibSet
	Name of external function library

ShortString	gmoNameMatrix
	Name of matrix file

ShortString	gmoNameDict
	Name of dictionary file

ShortString	gmoNameDictSet
	Name of dictionary file

ShortString	gmoNameInput
	Name of input file (with .gms stripped)

ShortString	gmoNameInputSet
	Name of input file (with .gms stripped)

ShortString	gmoNameOutput
	Name of output file (with .dat stripped)

Pointer	gmoPPool
	Pointer to constant pool

Pointer	gmoIOMutex
	IO mutex

Integer	gmoError
	Access to error indicator

Integer	gmoErrorSet
	Access to error indicator

Other
ShortString	gmoErrorMessage
	Provide the last error message

Column Information
Integer	gmoGetVarL
	Get variable level values

Double	gmoGetVarLOne
	Get individual variable level

Integer	gmoSetVarL
	Set variable level values

void	gmoSetVarLOne
	Set individual variable level

Integer	gmoGetVarM
	Get variable marginals

Double	gmoGetVarMOne
	Get individual variable marginal

Integer	gmoSetVarM
	Set variable marginals (pass null to set to NA)'

void	gmoSetVarMOne
	Set individual variable marginal

ShortString	gmoGetVarNameOne
	Get individual column name

ShortString	gmoGetVarNameCustomOne
	Get individual column name with quotes and user specified suffix

Integer	gmoGetVarLower
	Get variable lower bounds

Double	gmoGetVarLowerOne
	Get individual variable lower bound

Integer	gmoGetVarUpper
	Get variable upper bounds

Double	gmoGetVarUpperOne
	Get individual variable upper bound

Integer	gmoSetAltVarBounds
	Set alternative variable lower and upper bounds

void	gmoSetAltVarLowerOne
	Set individual alternative variable lower bound

void	gmoSetAltVarUpperOne
	Set individual alternative variable upper bound

Integer	gmoGetVarType
	Get variable type

Integer	gmoGetVarTypeOne
	Get individual variable type

Integer	gmoSetAltVarType
	Set alternative variable type

void	gmoSetAltVarTypeOne
	Set individual alternative variable type

void	gmoGetVarStat
	Get variable basis status

Integer	gmoGetVarStatOne
	Get individual variable basis status

void	gmoSetVarStat
	Set variable basis status

void	gmoSetVarStatOne
	Set individual variable basis status

void	gmoGetVarCStat
	Get variable status

Integer	gmoGetVarCStatOne
	Get individual variable status

void	gmoSetVarCStat
	Set variable status

Integer	gmoGetVarMatch
	Get variable match

Integer	gmoGetVarMatchOne
	Get individual variable match

Integer	gmoGetVarPrior
	Get variable branching priority

Double	gmoGetVarPriorOne
	Get individual variable branching priority

Integer	gmoGetVarScale
	Get variable scale

Double	gmoGetVarScaleOne
	Get individual variable scale

Integer	gmoGetVarStage
	Get variable stage

Double	gmoGetVarStageOne
	Get individual variable stage

Integer	gmoGetSosConstraints
	Get SOS constraints

Integer	gmoGetVarSosSetOne
	Get SOS set for individual variable

Integer	gmoGetColSparse
	Get Jacobians information of column (sparse)

void	gmoGetColJacInfoOne
	Get Jacobian information of column one by one

Integer	gmoGetVarIntDotOpt
	Get variable integer values for dot option

Integer	gmoGetVarDblDotOpt
	Get variable double values for dot option

Deprecated
Integer	gmoGetObjQ
	deprecated synonym for gmoGetObjQMat

Integer	gmoGetRowQ
	deprecated synonym for gmoGetRowQMat

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

EMP Information
Integer	gmoLoadEMPInfo
	Load EMP information

Integer	gmoGetEquVI
	Get VI mapping for all rows (-1 if not a VI function)

Integer	gmoGetEquVIOne
	Get VI mapping for individual row (-1 if not a VI function)

Integer	gmoGetVarVI
	Get VI mapping for all cols (-1 if not a VI variable)

Integer	gmoGetVarVIOne
	Get VI mapping for individual cols (-1 if not a VI variable)

Integer	gmoGetAgentType
	Get Agent Type of all agent (see gmoNumAgents)

Integer	gmoGetAgentTypeOne
	Get Agent Type of agent

Integer	gmoGetBiLevelInfo
	Get equation and variable mapping to agents

Integer	gmoDumpEMPInfoToGDX
	Dump EMPInfo GDX File

Evaluation (general)
void	gmoEvalErrorMsg
	Control writing messages for evaluation errors, default=true

void	gmoEvalErrorMsg_MT
	Control writing messages for evaluation errors, default=true

void	gmoEvalErrorMaskLevel
	Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr

void	gmoEvalErrorMaskLevel_MT
	Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr

Integer	gmoEvalNewPoint
	New point for the next evaluation call

void	gmoSetExtFuncs
	Set external function manager object

Integer	gmoGetQMakerStats
	Get QMaker stats

Extrinsic Functions
ShortString	gmoGetExtrLibName
	Get file name stub of extrinsic function library

Pointer	gmoGetExtrLibObjPtr
	Get data object pointer of extrinsic function library

ShortString	gmoGetExtrLibFuncName
	Get name of extrinsic function

Pointer	gmoLoadExtrLibEntry
	Load a function from an extrinsic function library

Function Evaluation
Integer	gmoEvalFunc
	Evaluate the constraint si (excluding RHS)

Integer	gmoEvalFunc_MT
	Evaluate the constraint si (excluding RHS)

Integer	gmoEvalFuncInt
	Evaluate the constraint si using the GMO internal variable levels (excluding RHS)

Integer	gmoEvalFuncInt_MT
	Evaluate the constraint si using the GMO internal variable levels (excluding RHS)

Integer	gmoEvalFuncNL
	Evaluate the nonlinear function component of constraint si

Integer	gmoEvalFuncNL_MT
	Evaluate the nonlinear function component of constraint si

Integer	gmoEvalFuncObj
	Evaluate objective function component

Integer	gmoEvalFuncNLObj
	Evaluate nonlinear objective function component

Integer	gmoEvalFuncInterval
	Evaluate the function value of constraint si on the giving interval

Integer	gmoEvalFuncInterval_MT
	Evaluate the function value of constraint si on the giving interval

Gradient Evaluation
Integer	gmoEvalGrad
	Update the nonlinear gradients of constraint si and evaluate function value

Integer	gmoEvalGrad_MT
	Update the nonlinear gradients of constraint si and evaluate function value

Integer	gmoEvalGradNL
	Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value

Integer	gmoEvalGradNL_MT
	Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value

Integer	gmoEvalGradObj
	Update the gradients of the objective function and evaluate function and gradient value

Integer	gmoEvalGradNLObj
	Update the nonlinear gradients of the objective function and evaluate function and gradient value

Integer	gmoEvalGradInterval
	Evaluate the function and gradient value of constraint si on the giving interval

Integer	gmoEvalGradInterval_MT
	Evaluate the function and gradient value of constraint si on the giving interval

Integer	gmoEvalGradNLUpdate
	Evaluate all nonlinear gradients and return change vector plus optional update of Jacobians

Integer	gmoGetJacUpdate
	Retrieve the updated Jacobian elements

Hessian Evaluation
Integer	gmoHessLoad
	Initialize Hessians

Integer	gmoHessUnload
	Unload Hessians

Integer	gmoHessDim
	Hessian dimension of row

Integer	gmoHessNz
	Hessian nonzeros of row

Int64	gmoHessNz64
	Hessian nonzeros of row

Integer	gmoHessStruct
	Get Hessian Structure

Integer	gmoHessStruct64
	Get Hessian Structure

Integer	gmoHessValue
	Get Hessian Value

Integer	gmoHessValue64
	Get Hessian Value

Integer	gmoHessVec
	Get Hessian-vector product

Integer	gmoHessLagStruct
	Get Hessian of the Lagrangian Value structure

Integer	gmoHessLagValue
	Get Hessian of the Lagrangian Value

Integer	gmoHessLagVec
	Get Hessian of the Lagrangian-vector product

Initialization
Integer	gmoInitData
	Initialize GMO data

Integer	gmoAddRow
	Add a row

Integer	gmoAddCol
	Add a column

Integer	gmoCompleteData
	Complete GMO data instance

Integer	gmoFillMatches
	Complete matching information for MCP

Integer	gmoLoadDataLegacy
	Read instance from scratch files - Legacy Mode - without gmoFillMatches

Integer	gmoLoadDataLegacyEx
	Read instance from scratch files - Legacy Mode

Integer	gmoRegisterEnvironment
	Register GAMS environment

Pointer	gmoEnvironment
	Get GAMS environment object pointer

Matrix
Integer	gmoGetMatrixRow
	Get constraint matrix in row order with row start only and NL indicator

Integer	gmoGetMatrixCol
	Get constraint matrix in column order with columns start only and NL indicator

Integer	gmoGetMatrixCplex
	Get constraint matrix in column order with column start and end (colstart length is n+1)

Integer	gmoUpdateJac
	Update the linear Jacobian element at (mi,mj), returning 0 on success

Memory Usage
Double	gmoMemUsed
	Get current memory consumption of GMO in MB

Double	gmoPeakMemUsed
	Get peak memory consumption of GMO in MB

Model Statistics
Integer	gmoGetVarTypeCnt
	Get variable type count

Integer	gmoGetEquTypeCnt
	Get equation type count

Integer	gmoGetObjStat
	Get obj counts

Integer	gmoGetRowStat
	Get row counts

Integer	gmoGetRowStatEx
	Get Jacobian row NZ counts: total and by GMOORDER_XX

Integer	gmoGetColStat
	Get column counts objnz = -1 if linear +1 if non-linear 0 otherwise

Integer	gmoGetRowQNZOne
	Number of NZ in Q matrix of row si (-1 if Q information not used or overflow)

Int64	gmoGetRowQNZOne64
	Number of NZ in Q matrix of row si (-1 if Q information not used)

Integer	gmoGetRowQDiagNZOne
	Number of NZ on diagonal of Q matrix of row si (-1 if Q information not used)

Integer	gmoGetRowCVecNZOne
	Number of NZ in c vector of row si (-1 if Q information not used)

void	gmoGetSosCounts
	Get SOS count information

void	gmoGetXLibCounts
	Get external function information

Integer	gmoGetActiveModelType
	Get model type in case of scenario solve generated models

Model View
Pointer	gmoViewStore
	Store current view in view object

void	gmoViewRestore
	Restore view

void	gmoViewDump
	Dump current view to stdout

Integer	gmoGetiSolver
	Get equation index in solver space

Integer	gmoGetjSolver
	Get variable index in solver space

Integer	gmoGetiSolverQuiet
	Get equation index in solver space (without error message; negative if it fails)

Integer	gmoGetjSolverQuiet
	Get variable index in solver space (without error message; negative if it fails)

Integer	gmoGetiModel
	Get equation index in model (original) space

Integer	gmoGetjModel
	Get variable index in model (original) space

Integer	gmoSetEquPermutation
	Set Permutation vectors for equations (model view)

Integer	gmoSetRvEquPermutation
	Set Permutation vectors for equations (solver view)

Integer	gmoSetVarPermutation
	Set Permutation vectors for variables (model view)

Integer	gmoSetRvVarPermutation
	Set Permutation vectors for variables (solver view)

Integer	gmoSetNRowPerm
	Set Permutation to skip =n= rows

Names
Integer	gmoGetVarTypeTxt
	String for variable type

Integer	gmoGetEquTypeTxt
	String for equation type

Integer	gmoGetSolveStatusTxt
	String for solvestatus

Integer	gmoGetModelStatusTxt
	String for modelstatus

Integer	gmoGetModelTypeTxt
	String for modeltype

Integer	gmoGetHeadNTailTxt
	String for solution head or tail record

ShortString	gmoGetObjName
	Get name of objective

Objective Information
ShortString	gmoGetObjNameCustom
	Get name of objective with user specified suffix

Integer	gmoGetObjVector
	Get objective function vector (dense)

Integer	gmoGetObjSparse
	Get Jacobians information of objective function (sparse)

Integer	gmoGetObjSparseEx
	Get information for gradient of objective function (sparse)

Integer	gmoGetObjQMat
	Get lower triangle of Q matrix of objective

Integer	gmoGetObjCVec
	Get c vector of quadratic objective

Double	gmoGetObjL
	Get objective activity level

Integer	gmoDirtyGetObjFNLInstr
	Temporary function to get row function only code

Other
Integer	gmoSetNLObject
	Set NL Object and constant pool

Integer	gmoSetNLTables
	Set NL object and constant pool via plain arrays.

Integer	gmoDumpQMakerGDX
	Dump QMaker GDX File

Integer	gmoGetVarEquMap
	Get variable equation mapping list

Integer	gmoGetIndicatorMap
	Get indicator constraint list

Integer	gmoDirtySetRowFNLInstr
	Temporary function to set row function only code

Row Information
Integer	gmoGetEquL
	Get equation activity levels

Double	gmoGetEquLOne
	Get individual equation activity levels

Integer	gmoSetEquL
	Set equation activity levels

void	gmoSetEquLOne
	Set individual equation activity levels

Integer	gmoGetEquM
	Get equation marginals

Double	gmoGetEquMOne
	Get individual equation marginal

Integer	gmoSetEquM
	Set equation marginals (pass NULL to set to NA)

ShortString	gmoGetEquNameOne
	Get individual equation name

ShortString	gmoGetEquNameCustomOne
	Get individual equation name with quotes and user specified suffix

Integer	gmoGetRhs
	Get right hand sides

Double	gmoGetRhsOne
	Get individual equation right hand side

Double	gmoGetRhsOneEx
	Get individual equation RHS - independent of useQ'

Integer	gmoSetAltRHS
	Set alternative RHS

void	gmoSetAltRHSOne
	Set individual alternative RHS

Integer	gmoGetEquSlack
	Get equation slacks

Double	gmoGetEquSlackOne
	Get individual equation slack

Integer	gmoSetEquSlack
	Set equation slacks

Integer	gmoGetEquType
	Get equation type

Integer	gmoGetEquTypeOne
	Get individual equation type

void	gmoGetEquStat
	Get equation basis status

Integer	gmoGetEquStatOne
	Get individual basis equation status

void	gmoSetEquStat
	Set equation basis status

void	gmoGetEquCStat
	Get equation status

Integer	gmoGetEquCStatOne
	Get individual equation status

void	gmoSetEquCStat
	Set equation status

Integer	gmoGetEquMatch
	Get equation match

Integer	gmoGetEquMatchOne
	Get individual equation match

Integer	gmoGetEquScale
	Get equation scale

Double	gmoGetEquScaleOne
	Get individual equation scale

Integer	gmoGetEquStage
	Get equation stage

Double	gmoGetEquStageOne
	Get individual equation stage

Integer	gmoGetEquOrderOne
	Returns 0 on error, 1 linear, 2 quadratic, 3 nonlinear'

Integer	gmoGetRowSparse
	Get Jacobians information of row (sparse)

Integer	gmoGetRowSparseEx
	Get info for one row of Jacobian (sparse)

void	gmoGetRowJacInfoOne
	Get Jacobian information of row one by one

Integer	gmoGetRowQMat
	Get lower triangle of Q matrix of row si

Integer	gmoGetRowCVec
	Get c vector of the quadratic form for row si

Double	gmoGetRowQConst
	Get the constant of the quadratic form for row si

Integer	gmoGetEquIntDotOpt
	Get equation integer values for dot optio

Integer	gmoGetEquDblDotOpt
	Get equation double values for dot optio

Integer	gmoDirtyGetRowFNLInstr
	Temporary function to get row function only code

Solution
Double	gmoGetHeadnTail
	Get value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)

void	gmoSetHeadnTail
	Set value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)

Integer	gmoSetSolutionPrimal
	Set solution values for variable levels

Integer	gmoSetSolution2
	Set solution values for variable levels and equation marginals

Integer	gmoSetSolution
	Set solution values for variable and equation levels as well as marginals

Integer	gmoSetSolution8
	Set solution values for variable and equation levels, marginals and statuses

Integer	gmoSetSolutionFixer
	Construct and set solution based on available inputs

Integer	gmoGetSolutionVarRec
	Get variable solution values (level, marginals and statuses)

Integer	gmoSetSolutionVarRec
	Set variable solution values (level, marginals and statuses)

Integer	gmoGetSolutionEquRec
	Get equation solution values (level, marginals and statuses)

Integer	gmoSetSolutionEquRec
	Set equation solution values (level, marginals and statuses)

Integer	gmoSetSolutionStatus
	Set solution values sfor variable and equation statuses

void	gmoCompleteObjective
	Complete objective row/col for models with objective function

Integer	gmoCompleteSolution
	Complete solution (e.g. for cols/rows not in view)

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

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

Integer	gmoLoadSolutionLegacy
	Load solution from legacy solution file

Integer	gmoUnloadSolutionLegacy
	Unload solution to legacy solution file

Integer	gmoLoadSolutionGDX
	Load solution to GDX solution file (optional: rows, cols and-or header and tail info)

Integer	gmoUnloadSolutionGDX
	Unload solution to GDX solution file (optional: rows, cols and-or header and tail info)

Integer	gmoPrepareAllSolToGDX
	Initialize writing of multiple solutions (e.g. scenarios) to a GDX file

Integer	gmoAddSolutionToGDX
	Add a solution (e.g. scenario) to the GDX file'

Integer	gmoWriteSolDone
	Finalize writing of multiple solutions (e.g. scenarios) to a GDX file

Integer	gmoCheckSolPoolUEL
	heck scenario UEL against dictionary uels and report number of varaible symbols

Pointer	gmoPrepareSolPoolMerge
	Prepare merged solution pool GDX file

Integer	gmoPrepareSolPoolNextSym
	Write solution to merged solution pool GDX file

Integer	gmoUnloadSolPoolSolution
	Write solution to merged solution pool GDX file

Integer	gmoFinalizeSolPoolMerge
	Finalize merged solution pool GDX file

Enumerated Constants

gmoEquType	gmoequ_E	= 0
	gmoequ_G	= 1
	gmoequ_L	= 2
	gmoequ_N	= 3
	gmoequ_X	= 4
	gmoequ_C	= 5
	gmoequ_B	= 6

gmoVarType	gmovar_X	= 0
	gmovar_B	= 1
	gmovar_I	= 2
	gmovar_S1	= 3
	gmovar_S2	= 4
	gmovar_SC	= 5
	gmovar_SI	= 6

gmoEquOrder	gmoorder_ERR	= 0
	gmoorder_L	= 1
	gmoorder_Q	= 2
	gmoorder_NL	= 3

gmoVarFreeType	gmovar_X_F	= 0
	gmovar_X_N	= 1
	gmovar_X_P	= 2

gmoVarEquBasisStatus	gmoBstat_Lower	= 0
	gmoBstat_Upper	= 1
	gmoBstat_Basic	= 2
	gmoBstat_Super	= 3

gmoVarEquStatus	gmoCstat_OK	= 0
	gmoCstat_NonOpt	= 1
	gmoCstat_Infeas	= 2
	gmoCstat_UnBnd	= 3

gmoObjectiveType	gmoObjType_Var	= 0
	gmoObjType_Fun	= 2

gmoInterfaceType	gmoIFace_Processed	= 0
	gmoIFace_Raw	= 1

gmoObjectiveSense	gmoObj_Min	= 0
	gmoObj_Max	= 1
	gmoObj_None	= 255

gmoSolverStatus	gmoSolveStat_Normal	= 1
	gmoSolveStat_Iteration	= 2
	gmoSolveStat_Resource	= 3
	gmoSolveStat_Solver	= 4
	gmoSolveStat_EvalError	= 5
	gmoSolveStat_Capability	= 6
	gmoSolveStat_License	= 7
	gmoSolveStat_User	= 8
	gmoSolveStat_SetupErr	= 9
	gmoSolveStat_SolverErr	= 10
	gmoSolveStat_InternalErr	= 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_UnboundedNoSolution	= 18
	gmoModelStat_InfeasibleNoSolution	= 19

gmoHeadnTail	gmoHiterused	= 3
	gmoHresused	= 4
	gmoHobjval	= 5
	gmoHdomused	= 6
	gmoHmarginals	= 9
	gmoHetalg	= 10
	gmoTmipnod	= 11
	gmoTninf	= 12
	gmoTnopt	= 13
	gmoTmipbest	= 15
	gmoTsinf	= 20
	gmoTrobj	= 22

gmoHTcard	gmonumheader	= 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_nrofmodeltypes	= 16

gmoEMPAgentType	gmoMinAgent	= 0
	gmoMaxAgent	= 1
	gmoVIAgent	= 2

gmoEvalErrorMethodNum	gmoEVALERRORMETHOD_KEEPGOING	= 0
	gmoEVALERRORMETHOD_FASTSTOP	= 1

Definitions

gmoAltBounds ↵

Use alternative bound

Type: Property of type Boolean

Action: read

gmoAltBoundsSet ↵

Use alternative bound

Type: Property of type Boolean

Action: write

gmoAltRHS ↵

Use alternative RHS

Type: Property of type Boolean

Action: read

gmoAltRHSSet ↵

Use alternative RHS

Type: Property of type Boolean

Action: write

gmoAltVarTypes ↵

Use alternative variable types

Type: Property of type Boolean

Action: read

gmoAltVarTypesSet ↵

Use alternative variable types

Type: Property of type Boolean

Action: write

gmoDict ↵

Load GAMS dictionary object and obtain pointer to it

Type: Property of type Pointer

Action: read

gmoDictSet ↵

Load GAMS dictionary object and obtain pointer to it

Type: Property of type Pointer

Action: write

gmoDictionary ↵

Dictionary flag

Type: Property of type Integer

Action: read

gmoDictionarySet ↵

Dictionary flag

Type: Property of type Integer

Action: write

gmoEmptyOut ↵

deprecated control for objective variable reformulation: currently has no effect

Type: Property of type Boolean

Action: read

gmoEmptyOutSet ↵

deprecated control for objective variable reformulation: currently has no effect

Type: Property of type Boolean

Action: write

gmoError ↵

Access to error indicator

Type: Property of type Integer

Action: read

gmoErrorSet ↵

Access to error indicator

Type: Property of type Integer

Action: write

gmoErrorMessage ↵

Provide the last error message

Type: Property of type ShortString

Action: read

gmoEvalErrorMethod ↵

Method for returning on nonlinear evaluation errors

Type: Property of type Integer

Action: read

gmoEvalErrorMethodSet ↵

Method for returning on nonlinear evaluation errors

Type: Property of type Integer

Action: write

gmoEvalFuncCount ↵

Number of function evaluations

Type: Property of type Integer

Action: read

gmoEvalFuncTimeUsed ↵

Time used for function evaluations in s

Type: Property of type Double

Action: read

gmoEvalGradCount ↵

Number of gradient evaluations

Type: Property of type Integer

Action: read

gmoEvalGradTimeUsed ↵

Time used for gradient evaluations in s

Type: Property of type Double

Action: read

gmoEvalMaxThreads ↵

Maximum number of threads that can be used for evaluation

Type: Property of type Integer

Action: read

gmoEvalMaxThreadsSet ↵

Maximum number of threads that can be used for evaluation

Type: Property of type Integer

Action: write

gmoForceCont ↵

Force continuous relaxation of model

Type: Property of type Boolean

Action: read

gmoForceContSet ↵

Force continuous relaxation of model

Type: Property of type Boolean

Action: write

gmoForceLinear ↵

Force linear representation of model

Type: Property of type Boolean

Action: read

gmoForceLinearSet ↵

Force linear representation of model

Type: Property of type Boolean

Action: write

gmoGetObjOrder ↵

Order of Objective, see enumerated constants

Type: Property of type Integer

Action: read

gmoGNLNZ ↵

Number of general nonlinear nonzeros in Jacobian matrix, equals gmoNLNZ if gmoUseQ is false

Type: Property of type Integer

Action: read

gmoGNLNZ64 ↵

Number of general nonlinear nonzeros in Jacobian matrix, equals gmoNLNZ if gmoUseQ is false

Type: Property of type Int64

Action: read

gmoHaveBasis ↵

Do we have basis

Type: Property of type Integer

Action: read

gmoHaveBasisSet ↵

Do we have basis

Type: Property of type Integer

Action: write

gmoHessInclQRows ↵

if useQ is true, still include GMOORDER_Q rows in the Hessian

Type: Property of type Boolean

Action: read

gmoHessInclQRowsSet ↵

if useQ is true, still include GMOORDER_Q rows in the Hessian

Type: Property of type Boolean

Action: write

gmoHessLagDiagNz ↵

Nonzeros on Diagonal of Hessian of the Lagrangian

Type: Property of type Integer

Action: read

gmoHessLagDim ↵

Dimension of Hessian of the Lagrangian

Type: Property of type Integer

Action: read

gmoHessLagNz ↵

Nonzeros in Hessian of the Lagrangian

Type: Property of type Integer

Action: read

gmoHessLagNz64 ↵

Nonzeros in Hessian of the Lagrangian

Type: Property of type Int64

Action: read

gmoHessMaxDim ↵

Maximum dimension of Hessian

Type: Property of type Integer

Action: read

gmoHessMaxNz ↵

Maximum number of nonzeros in Hessian

Type: Property of type Integer

Action: read

gmoHessMaxNz64 ↵

Maximum number of nonzeros in Hessian

Type: Property of type Int64

Action: read

gmoIgnXCDeriv ↵

Consider constant derivatives in external functions or not

Type: Property of type Boolean

Action: read

gmoIgnXCDerivSet ↵

Consider constant derivatives in external functions or not

Type: Property of type Boolean

Action: write

gmoIndexBase ↵

User array index base (0 or 1)

Type: Property of type Integer

Action: read

gmoIndexBaseSet ↵

User array index base (0 or 1)

Type: Property of type Integer

Action: write

gmoInterface ↵

Interface type (raw vs. processed), see enumerated constants

Type: Property of type Integer

Action: read

gmoInterfaceSet ↵

Interface type (raw vs. processed), see enumerated constants

Type: Property of type Integer

Action: write

gmoIOMutex ↵

IO mutex

Type: Property of type Pointer

Action: read

gmoIsMPSGE ↵

Is this an MPSGE model

Type: Property of type Boolean

Action: read

gmoIsMPSGESet ↵

Is this an MPSGE model

Type: Property of type Boolean

Action: write

gmoIsQP ↵

Is this a QP or not

Type: Property of type Boolean

Action: read

gmoLNZ ↵

Legacy overestimate for the count of linear nonzeros in Jacobian matrix, especially if gmoUseQ is true

Type: Property of type Integer

Action: read

gmoLNZ64 ↵

Legacy overestimate for the count of linear nonzeros in Jacobian matrix, especially if gmoUseQ is true

Type: Property of type Int64

Action: read

gmoLNZEx ↵

Number of linear nonzeros in Jacobian matrix

Type: Property of type Integer

Action: read

gmoLNZEx64 ↵

Number of linear nonzeros in Jacobian matrix

Type: Property of type Int64

Action: read

gmoM ↵

Number of rows

Type: Property of type Integer

Action: read

gmoMaxQNZ ↵

Maximum number of nonzeros in single Q matrix (-1 on overflow)

Type: Property of type Integer

Action: read

gmoMaxQNZ64 ↵

Maximum number of nonzeros in single Q matrix

Type: Property of type Int64

Action: read

gmoMinf ↵

Value for minus infinity

Type: Property of type Double

Action: read

gmoMinfSet ↵

Value for minus infinity

Type: Property of type Double

Action: write

gmoModelSeqNr ↵

Sequence number of model (0..n)

Type: Property of type Integer

Action: read

gmoModelSeqNrSet ↵

Sequence number of model (0..n)

Type: Property of type Integer

Action: write

gmoModelStat ↵

Model status, see enumerated constants

Type: Property of type Integer

Action: read

gmoModelStatSet ↵

Model status, see enumerated constants

Type: Property of type Integer

Action: write

gmoModelType ↵

Type of Model

Type: Property of type Integer

Action: read

gmoModelTypeSet ↵

Type of Model

Type: Property of type Integer

Action: write

gmoN ↵

Number of columns

Type: Property of type Integer

Action: read

gmoNameDict ↵

Name of dictionary file

Type: Property of type ShortString

Action: read

gmoNameDictSet ↵

Name of dictionary file

Type: Property of type ShortString

Action: write

gmoNameInput ↵

Name of input file (with .gms stripped)

Type: Property of type ShortString

Action: read

gmoNameInputSet ↵

Name of input file (with .gms stripped)

Type: Property of type ShortString

Action: write

gmoNameMatrix ↵

Name of matrix file

Type: Property of type ShortString

Action: read

gmoNameModel ↵

Name of model

Type: Property of type ShortString

Action: read

gmoNameModelSet ↵

Name of model

Type: Property of type ShortString

Action: write

gmoNameOptFile ↵

Name of option file

Type: Property of type ShortString

Action: read

gmoNameOptFileSet ↵

Name of option file

Type: Property of type ShortString

Action: write

gmoNameOutput ↵

Name of output file (with .dat stripped)

Type: Property of type ShortString

Action: read

gmoNameSolFile ↵

Name of solution file

Type: Property of type ShortString

Action: read

gmoNameSolFileSet ↵

Name of solution file

Type: Property of type ShortString

Action: write

gmoNameXLib ↵

Name of external function library

Type: Property of type ShortString

Action: read

gmoNameXLibSet ↵

Name of external function library

Type: Property of type ShortString

Action: write

gmoNColMatch ↵

Number of matched columns

Type: Property of type Integer

Action: read

gmoNDisc ↵

Number of discontinuous columns

Type: Property of type Integer

Action: read

gmoNFixed ↵

Number of fixed columns

Type: Property of type Integer

Action: read

gmoNLCodeSize ↵

Nonlinear code size

Type: Property of type Integer

Action: read

gmoNLCodeSizeSet ↵

Nonlinear code size

Type: Property of type Integer

Action: write

gmoNLCodeSizeMaxRow ↵

Maximum nonlinear code size for rows

Type: Property of type Integer

Action: read

gmoNLConst ↵

Length of constant pool in nonlinear code

Type: Property of type Integer

Action: read

gmoNLConstSet ↵

Length of constant pool in nonlinear code

Type: Property of type Integer

Action: write

gmoNLM ↵

Number of nonlinear rows

Type: Property of type Integer

Action: read

gmoNLModelType ↵

Type of Model

Type: Property of type Boolean

Action: read

gmoNLN ↵

Number of nonlinear columns

Type: Property of type Integer

Action: read

gmoNLNZ ↵

Number of nonlinear nonzeros in Jacobian matrix

Type: Property of type Integer

Action: read

gmoNLNZ64 ↵

Number of nonlinear nonzeros in Jacobian matrix

Type: Property of type Int64

Action: read

gmoNRowMatch ↵

Number of matched rows

Type: Property of type Integer

Action: read

gmoNumAgents ↵

EMP: Number of Agents/Followers

Type: Property of type Integer

Action: read

gmoNumVIFunc ↵

EMP: Number of variational inequalities in model rim

Type: Property of type Integer

Action: read

gmoNZ ↵

Number of nonzeros in Jacobian matrix

Type: Property of type Integer

Action: read

gmoNZ64 ↵

Number of nonzeros in Jacobian matrix

Type: Property of type Int64

Action: read

gmoObjConst ↵

Objective constant

Type: Property of type Double

Action: read

gmoObjConstEx ↵

Objective constant - this is independent of useQ

Type: Property of type Double

Action: read

gmoObjCVecNZ ↵

Number of nonzeros in c vector of objective (-1 if Q information not used)

Type: Property of type Integer

Action: read

gmoObjJacVal ↵

Value of Jacobian element of objective variable in objective

Type: Property of type Double

Action: read

gmoObjLNZ ↵

Number of linear nonzeros in objective gradient

Type: Property of type Integer

Action: read

gmoObjNLNZ ↵

Number of nonlinear nonzeros in objective gradient

Type: Property of type Integer

Action: read

gmoObjNLNZEx ↵

Number of GMOORDER_NL nonzeros in objective gradient

Type: Property of type Integer

Action: read

gmoObjNZ ↵

Number of nonzeros in objective gradient

Type: Property of type Integer

Action: read

gmoObjQConst ↵

Get constant in solvers quadratic objective

Type: Property of type Double

Action: read

gmoObjQDiagNZ ↵

Number of nonzeros on diagonal of Q matrix of objective (-1 if useQ false)

Type: Property of type Integer

Action: read

gmoObjQMatNZ ↵

Number of nonzeros in lower triangle of Q matrix of objective (-1 if useQ false or overflow)

Type: Property of type Integer

Action: read

gmoObjQMatNZ64 ↵

Number of nonzeros in lower triangle of Q matrix of objective (-1 if useQ false)

Type: Property of type Int64

Action: read

gmoObjQNZ ↵

deprecated synonym for gmoObjQMatNZ

Type: Property of type Integer

Action: read

gmoObjQNZEx ↵

Number of GMOORDER_Q nonzeros in objective gradient

Type: Property of type Integer

Action: read

gmoObjReform ↵

Reformulate objective if possible

Type: Property of type Boolean

Action: read

gmoObjReformSet ↵

Reformulate objective if possible

Type: Property of type Boolean

Action: write

gmoObjRow ↵

Index of objective row

Type: Property of type Integer

Action: read

gmoObjStyle ↵

Style of objective, see enumerated constants

Type: Property of type Integer

Action: read

gmoObjStyleSet ↵

Style of objective, see enumerated constants

Type: Property of type Integer

Action: write

gmoObjVar ↵

Index of objective variable

Type: Property of type Integer

Action: read

gmoObjVarSet ↵

Index of objective variable

Type: Property of type Integer

Action: write

gmoOptFile ↵

Number of option file

Type: Property of type Integer

Action: read

gmoOptFileSet ↵

Number of option file

Type: Property of type Integer

Action: write

gmoPermuteCols ↵

Column permutation flag

Type: Property of type Boolean

Action: read

gmoPermuteColsSet ↵

Column permutation flag

Type: Property of type Boolean

Action: write

gmoPermuteRows ↵

Row permutation flag

Type: Property of type Boolean

Action: read

gmoPermuteRowsSet ↵

Row permutation flag

Type: Property of type Boolean

Action: write

gmoPinf ↵

Value for plus infinity

Type: Property of type Double

Action: read

gmoPinfSet ↵

Value for plus infinity

Type: Property of type Double

Action: write

gmoPPool ↵

Pointer to constant pool

Type: Property of type Pointer

Action: read

gmoPriorOpt ↵

Priority Flag

Type: Property of type Integer

Action: read

gmoPriorOptSet ↵

Priority Flag

Type: Property of type Integer

Action: write

gmoQExtractAlg ↵

Choose Q extraction algorithm (must be set before UseQ; 0: automatic; 1: ThreePass; 2: DoubleForward; 3: Concurrent)

Type: Property of type Integer

Action: read

gmoQExtractAlgSet ↵

Choose Q extraction algorithm (must be set before UseQ; 0: automatic; 1: ThreePass; 2: DoubleForward; 3: Concurrent)

Type: Property of type Integer

Action: write

gmoQExtractDenseSwitchFactor ↵

Q extraction algorithm sparse/dense factor (smaller values make dense count vector more likely: 0 implies dense always)

Type: Property of type Double

Action: read

gmoQExtractDenseSwitchFactorSet ↵

Q extraction algorithm sparse/dense factor (smaller values make dense count vector more likely: 0 implies dense always)

Type: Property of type Double

Action: write

gmoQExtractDenseSwitchLog ↵

Toggle log output related to Q extraction algorithm sparse/dense factor gmoQExtractDenseSwitchFactor

Type: Property of type Boolean

Action: read

gmoQExtractDenseSwitchLogSet ↵

Toggle log output related to Q extraction algorithm sparse/dense factor gmoQExtractDenseSwitchFactor

Type: Property of type Boolean

Action: write

gmoQM ↵

Number of quadratic rows (-1 if Q information not used)

Type: Property of type Integer

Action: read

gmoQNaN ↵

quiet IEEE NaN

Type: Property of type Double

Action: read

gmoQNZ ↵

Number of quadratic nonzeros in Jacobian matrix, 0 if gmoUseQ is false

Type: Property of type Integer

Action: read

gmoQNZ64 ↵

Number of quadratic nonzeros in Jacobian matrix, 0 if gmoUseQ is false

Type: Property of type Int64

Action: read

gmoScaleOpt ↵

Scaling flag

Type: Property of type Integer

Action: read

gmoScaleOptSet ↵

Scaling flag

Type: Property of type Integer

Action: write

gmoSense ↵

Direction of optimization, see enumerated constants

Type: Property of type Integer

Action: read

gmoSenseSet ↵

Direction of optimization, see enumerated constants

Type: Property of type Integer

Action: write

gmoSolveStat ↵

Solver status, see enumerated constants

Type: Property of type Integer

Action: read

gmoSolveStatSet ↵

Solver status, see enumerated constants

Type: Property of type Integer

Action: write

gmoUseQ ↵

Toggle Q-mode

Type: Property of type Boolean

Action: read

gmoUseQSet ↵

Toggle Q-mode

Type: Property of type Boolean

Action: write

gmoValNA ↵

Double Value of N/A

Type: Property of type Double

Action: read

gmoValNAInt ↵

Integer Value of N/A

Type: Property of type Integer

Action: read

gmoValUndf ↵

Double Value of UNDF

Type: Property of type Double

Action: read

gmoAddCol ↵

Add a column

Type: Function returns Integer

Parameters

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

gmoAddRow ↵

Add a row

Type: Function returns Integer

Parameters

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

gmoAddSolutionToGDX ↵

Add a solution (e.g. scenario) to the GDX file'

Type: Function returns Integer

Parameters

	const TgdxStrIndex	scenuel
		Scenario labels

gmoCheckSolPoolUEL ↵

heck scenario UEL against dictionary uels and report number of varaible symbols

Type: Function returns Integer

Parameters

	const ShortString	prefix
	var Integer	numsym
		Number of symbols

gmoCompleteData ↵

Complete GMO data instance

Type: Function returns Integer

Parameters

	out ShortString	msg
		Message

gmoCompleteObjective ↵

Complete objective row/col for models with objective function

Type: Procedure

Parameters

	Double	locobjval
		Objective value

gmoCompleteSolution ↵

Complete solution (e.g. for cols/rows not in view)

Type: Function returns Integer

gmoCrudeness ↵

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

Type: Function returns Integer

gmoDirtyGetObjFNLInstr ↵

Temporary function to get row function only code

Type: Function returns Integer

Parameters

	out Integer	len
		Length of array
	PLongIntArray	opcode
		Nonlinear code operation
	PLongIntArray	field
		Nonlinear code field

gmoDirtyGetRowFNLInstr ↵

Temporary function to get row function only code

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out Integer	len
		Length of array
	PLongIntArray	opcode
		Nonlinear code operation
	PLongIntArray	field
		Nonlinear code field

gmoDirtySetRowFNLInstr ↵

Temporary function to set row function only code

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	Integer	len
		Length of array
	const PLongIntArray	opcode
		Nonlinear code operation
	const PLongIntArray	field
		Nonlinear code field
	Pointer	nlpool
		Constant pool object for constants in nonlinear instruction
	PDoubleArray	nlpoolvec
		Constant pool array for constants in nonlinear instruction
	Integer	len2
		Length of second array

gmoDumpEMPInfoToGDX ↵

Dump EMPInfo GDX File

Type: Function returns Integer

Parameters

	const ShortString	gdxfname
		Name of GDX file

gmoDumpQMakerGDX ↵

Dump QMaker GDX File

Type: Function returns Integer

Parameters

	const ShortString	gdxfname
		Name of GDX file

gmoEnvironment ↵

Get GAMS environment object pointer

Type: Function returns Pointer

gmoEvalErrorMaskLevel ↵

Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr

Type: Procedure

Parameters

	Integer	MaskLevel
		Ignore evaluation errors less that this value

gmoEvalErrorMaskLevel_MT ↵

Set mask to ignore errors >= evalErrorMaskLevel when incrementing numerr

Type: Procedure

Parameters

	Integer	MaskLevel
		Ignore evaluation errors less that this value
	Integer	tidx
		Index of thread

gmoEvalErrorMsg ↵

Control writing messages for evaluation errors, default=true

Type: Procedure

Parameters

	const Boolean	domsg
		Flag whether to write messages

gmoEvalErrorMsg_MT ↵

Control writing messages for evaluation errors, default=true

Type: Procedure

Parameters

	const Boolean	domsg
		Flag whether to write messages
	Integer	tidx
		Index of thread

gmoEvalFunc ↵

Evaluate the constraint si (excluding RHS)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	f
		Function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalFunc_MT ↵

Evaluate the constraint si (excluding RHS)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	f
		Function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalFuncInt ↵

Evaluate the constraint si using the GMO internal variable levels (excluding RHS)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out Double	f
		Function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalFuncInt_MT ↵

Evaluate the constraint si using the GMO internal variable levels (excluding RHS)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out Double	f
		Function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalFuncInterval ↵

Evaluate the function value of constraint si on the giving interval

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	xmin
		Minimum input level values of variables
	const PDoubleArray	xmax
		Maximum input level values of variables
	out Double	fmin
		Minimum function value
	out Double	fmax
		Maximum function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalFuncInterval_MT ↵

Evaluate the function value of constraint si on the giving interval

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	xmin
		Minimum input level values of variables
	const PDoubleArray	xmax
		Maximum input level values of variables
	out Double	fmin
		Minimum function value
	out Double	fmax
		Maximum function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalFuncNL ↵

Evaluate the nonlinear function component of constraint si

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	fnl
		Part of the function value depending on the nonlinear variables
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalFuncNL_MT ↵

Evaluate the nonlinear function component of constraint si

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	fnl
		Part of the function value depending on the nonlinear variables
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalFuncNLObj ↵

Evaluate nonlinear objective function component

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	out Double	fnl
		Part of the function value depending on the nonlinear variables
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalFuncObj ↵

Evaluate objective function component

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	out Double	f
		Function value
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalGrad ↵

Update the nonlinear gradients of constraint si and evaluate function value

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	f
		Function value
	PDoubleArray	g
		Gradient values
	out Double	gx
		Inner product of the gradient with the input variables
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalGrad_MT ↵

Update the nonlinear gradients of constraint si and evaluate function value

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	f
		Function value
	PDoubleArray	g
		Gradient values
	out Double	gx
		Inner product of the gradient with the input variables
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalGradInterval ↵

Evaluate the function and gradient value of constraint si on the giving interval

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	xmin
		Minimum input level values of variables
	const PDoubleArray	xmax
		Maximum input level values of variables
	out Double	fmin
		Minimum function value
	out Double	fmax
		Maximum function value
	PDoubleArray	gmin
		Minimum gradient values
	PDoubleArray	gmax
		Maximum gradient values
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalGradInterval_MT ↵

Evaluate the function and gradient value of constraint si on the giving interval

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	xmin
		Minimum input level values of variables
	const PDoubleArray	xmax
		Maximum input level values of variables
	out Double	fmin
		Minimum function value
	out Double	fmax
		Maximum function value
	PDoubleArray	gmin
		Minimum gradient values
	PDoubleArray	gmax
		Maximum gradient values
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalGradNL ↵

Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	fnl
		Part of the function value depending on the nonlinear variables
	PDoubleArray	g
		Gradient values
	out Double	gxnl
		Inner product of the gradient with the input variables, nonlinear variables only
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalGradNL_MT ↵

Update the nonlinear gradients of constraint si and evaluate nonlinear function and gradient value

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	const PDoubleArray	x
		Level values of variables
	out Double	fnl
		Part of the function value depending on the nonlinear variables
	PDoubleArray	g
		Gradient values
	out Double	gxnl
		Inner product of the gradient with the input variables, nonlinear variables only
	out Integer	numerr
		Number of errors evaluating the nonlinear function
	Integer	tidx
		Index of thread

gmoEvalGradNLObj ↵

Update the nonlinear gradients of the objective function and evaluate function and gradient value

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	out Double	fnl
		Part of the function value depending on the nonlinear variables
	PDoubleArray	g
		Gradient values
	out Double	gxnl
		Inner product of the gradient with the input variables, nonlinear variables only
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalGradNLUpdate ↵

Evaluate all nonlinear gradients and return change vector plus optional update of Jacobians

Type: Function returns Integer

Parameters

	PDoubleArray	rhsdelta
		Taylor expansion constants
	const Boolean	dojacupd
		Flag whether to update Jacobians
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalGradObj ↵

Update the gradients of the objective function and evaluate function and gradient value

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	out Double	f
		Function value
	PDoubleArray	g
		Gradient values
	out Double	gx
		Inner product of the gradient with the input variables
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoEvalNewPoint ↵

New point for the next evaluation call

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables

gmoFillMatches ↵

Complete matching information for MCP

Type: Function returns Integer

Parameters

	out ShortString	msg
		Message

gmoFinalizeSolPoolMerge ↵

Finalize merged solution pool GDX file

Type: Function returns Integer

Parameters

Pointer handle

gmoGetAbsoluteGap ↵

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

Type: Function returns Double

gmoGetActiveModelType ↵

Get model type in case of scenario solve generated models

Type: Function returns Integer

Parameters

	PLongIntArray	checkv
		a vector with column indicators to be treated as constant
	out Integer	actModelType
		active model type in case of scenario dict type emp model

gmoGetAgentType ↵

Get Agent Type of all agent (see gmoNumAgents)

Type: Function returns Integer

Parameters

	PLongIntArray	agentvec
		Array of agent types of length gmoNumAgents

gmoGetAgentTypeOne ↵

Get Agent Type of agent

Type: Function returns Integer

Parameters

	Integer	aidx
		Index of agent

gmoGetBiLevelInfo ↵

Get equation and variable mapping to agents

Type: Function returns Integer

Parameters

	PLongIntArray	nintvec
		Array of integers, len=number of columns in user view
	PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoGetColJacInfoOne ↵

Get Jacobian information of column one by one

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	var Pointer	jacptr
		Pointer to next Jacobian
	out Double	jacval
		Value(s) of Jacobian(s)
	out Integer	rowidx
		Row index/indices of Jacobian
	out Integer	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)

gmoGetColSparse ↵

Get Jacobians information of column (sparse)

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space
	PLongIntArray	rowidx
		Row index/indices of Jacobian
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)
	out Integer	nz
		Number of nonzeros
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetColStat ↵

Get column counts objnz = -1 if linear +1 if non-linear 0 otherwise

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space
	out Integer	nz
		Number of nonzeros
	out Integer	qnz
		Number of quadratic nonzeros in Jacobian matrix
	out Integer	nlnz
		Number of nonlinear nonzeros
	out Integer	objnz
		Nonzeros in objective

gmoGetEquCStat ↵

Get equation status

Type: Procedure

Parameters

	PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoGetEquCStatOne ↵

Get individual equation status

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetEquDblDotOpt ↵

Get equation double values for dot optio

Type: Function returns Integer

Parameters

	Pointer	optptr
		Option object pointer
	const ShortString	dotopt
		Dot option name
	PDoubleArray	optvals
		Option values

gmoGetEquIntDotOpt ↵

Get equation integer values for dot optio

Type: Function returns Integer

Parameters

	Pointer	optptr
		Option object pointer
	const ShortString	dotopt
		Dot option name
	PLongIntArray	optvals
		Option values

gmoGetEquL ↵

Get equation activity levels

Type: Function returns Integer

Parameters

	PDoubleArray	e
		Level values of equations

gmoGetEquLOne ↵

Get individual equation activity levels

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetEquM ↵

Get equation marginals

Type: Function returns Integer

Parameters

	PDoubleArray	pi
		Marginal values of equations

gmoGetEquMatch ↵

Get equation match

Type: Function returns Integer

Parameters

	PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoGetEquMatchOne ↵

Get individual equation match

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetEquMOne ↵

Get individual equation marginal

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetEquNameCustomOne ↵

Get individual equation name with quotes and user specified suffix

Type: Function returns ShortString

Parameters

	Integer	si
		Index of row in client space
	const ShortString	suffix
		Suffix appended to name, could be .l, .m etc.

gmoGetEquNameOne ↵

Get individual equation name

Type: Function returns ShortString

Parameters

	Integer	si
		Index of row in client space

gmoGetEquOrderOne ↵

Returns 0 on error, 1 linear, 2 quadratic, 3 nonlinear'

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetEquScale ↵

Get equation scale

Type: Function returns Integer

Parameters

	PDoubleArray	mdblvec
		Array of doubles, len=number of rows in user view

gmoGetEquScaleOne ↵

Get individual equation scale

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetEquSlack ↵

Get equation slacks

Type: Function returns Integer

Parameters

	PDoubleArray	mdblvec
		Array of doubles, len=number of rows in user view

gmoGetEquSlackOne ↵

Get individual equation slack

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetEquStage ↵

Get equation stage

Type: Function returns Integer

Parameters

	PDoubleArray	mdblvec
		Array of doubles, len=number of rows in user view

gmoGetEquStageOne ↵

Get individual equation stage

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetEquStat ↵

Get equation basis status

Type: Procedure

Parameters

	PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoGetEquStatOne ↵

Get individual basis equation status

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetEquType ↵

Get equation type

Type: Function returns Integer

Parameters

	PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoGetEquTypeCnt ↵

Get equation type count

Type: Function returns Integer

Parameters

	Integer	etyp
		Type of equation (see enumerated constants)

gmoGetEquTypeOne ↵

Get individual equation type

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetEquTypeTxt ↵

String for equation type

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out ShortString	s
		String

gmoGetEquVI ↵

Get VI mapping for all rows (-1 if not a VI function)

Type: Function returns Integer

Parameters

	PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoGetEquVIOne ↵

Get VI mapping for individual row (-1 if not a VI function)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetExtrLibFuncName ↵

Get name of extrinsic function

Type: Function returns ShortString

Parameters

	Integer	libidx
		Library index
	Integer	funcidx
		Function index

gmoGetExtrLibName ↵

Get file name stub of extrinsic function library

Type: Function returns ShortString

Parameters

	Integer	libidx
		Library index

gmoGetExtrLibObjPtr ↵

Get data object pointer of extrinsic function library

Type: Function returns Pointer

Parameters

	Integer	libidx
		Library index

gmoGetHeadnTail ↵

Get value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)

Type: Function returns Double

Parameters

	Integer	htrec
		Solution head or tail record, (see enumerated constants)

gmoGetHeadNTailTxt ↵

String for solution head or tail record

Type: Function returns Integer

Parameters

	Integer	htrec
		Solution head or tail record, (see enumerated constants)
	out ShortString	s
		String

gmoGetiModel ↵

Get equation index in model (original) space

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetIndicatorMap ↵

Get indicator constraint list

Type: Function returns Integer

Parameters

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

gmoGetiSolver ↵

Get equation index in solver space

Type: Function returns Integer

Parameters

	Integer	mi
		Index of row in original/GAMS space

gmoGetiSolverQuiet ↵

Get equation index in solver space (without error message; negative if it fails)

Type: Function returns Integer

Parameters

	Integer	mi
		Index of row in original/GAMS space

gmoGetJacUpdate ↵

Retrieve the updated Jacobian elements

Type: Function returns Integer

Parameters

	PLongIntArray	rowidx
		Row index/indices of Jacobian
	PLongIntArray	colidx
		Column index/indices of Jacobian(s)
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	var Integer	len
		Length of array

gmoGetjModel ↵

Get variable index in model (original) space

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetjSolver ↵

Get variable index in solver space

Type: Function returns Integer

Parameters

	Integer	mj
		Index of column in original/GAMS client space

gmoGetjSolverQuiet ↵

Get variable index in solver space (without error message; negative if it fails)

Type: Function returns Integer

Parameters

	Integer	mj
		Index of column in original/GAMS client space

gmoGetMatrixCol ↵

Get constraint matrix in column order with columns start only and NL indicator

Type: Function returns Integer

Parameters

	PLongIntArray	colstart
		Index of Jacobian column starts with
	PLongIntArray	rowidx
		Row index/indices of Jacobian
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		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)

Type: Function returns Integer

Parameters

	PLongIntArray	colstart
		Index of Jacobian column starts with
	PLongIntArray	collength
		Number of Jacobians in column
	PLongIntArray	rowidx
		Row index/indices of Jacobian
	PDoubleArray	jacval
		Value(s) of Jacobian(s)

gmoGetMatrixRow ↵

Get constraint matrix in row order with row start only and NL indicator

Type: Function returns Integer

Parameters

	PLongIntArray	rowstart
		Index of Jacobian row starts with
	PLongIntArray	colidx
		Column index/indices of Jacobian(s)
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)

gmoGetModelStatusTxt ↵

String for modelstatus

Type: Function returns Integer

Parameters

	Integer	modelstat
		Model status
	out ShortString	s
		String

gmoGetModelTypeTxt ↵

String for modeltype

Type: Function returns Integer

Parameters

	Integer	modeltype
	out ShortString	s
		String

gmoGetObjCVec ↵

Get c vector of quadratic objective

Type: Function returns Integer

Parameters

	PLongIntArray	varidx
	PDoubleArray	coefs
		Coefficients

gmoGetObjL ↵

Get objective activity level

Type: Function returns Double

gmoGetObjName ↵

Get name of objective

Type: Function returns ShortString

gmoGetObjNameCustom ↵

Get name of objective with user specified suffix

Type: Function returns ShortString

Parameters

	const ShortString	suffix
		Suffix appended to name, could be .l, .m etc.

gmoGetObjQ ↵

deprecated synonym for gmoGetObjQMat

Type: Function returns Integer

Parameters

	PLongIntArray	varidx1
		First variable indices
	PLongIntArray	varidx2
		Second variable indices
	PDoubleArray	coefs
		Coefficients

gmoGetObjQMat ↵

Get lower triangle of Q matrix of objective

Type: Function returns Integer

Parameters

	PLongIntArray	varidx1
		First variable indices
	PLongIntArray	varidx2
		Second variable indices
	PDoubleArray	coefs
		Coefficients

gmoGetObjSparse ↵

Get Jacobians information of objective function (sparse)

Type: Function returns Integer

Parameters

	PLongIntArray	colidx
		Column index/indices of Jacobian(s)
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)
	out Integer	nz
		Number of nonzeros
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetObjSparseEx ↵

Get information for gradient of objective function (sparse)

Type: Function returns Integer

Parameters

	PLongIntArray	colidx
		Column index/indices of Jacobian(s)
	PDoubleArray	gradval
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)
	out Integer	nz
		Number of nonzeros
	out Integer	qnz
		Number of quadratic nonzeros in Jacobian matrix
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetObjStat ↵

Get obj counts

Type: Function returns Integer

Parameters

	out Integer	nz
		Number of nonzeros
	out Integer	qnz
		Number of quadratic nonzeros in Jacobian matrix
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetObjVector ↵

Get objective function vector (dense)

Type: Function returns Integer

Parameters

	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)

gmoGetQMakerStats ↵

Get QMaker stats

Type: Function returns Integer

Parameters

	out ShortString	algName
		the name of the QMaker algorithm used
	out Double	algTime
		the wall-clock time in seconds used by QMaker
	out Int64	winnerCount3Pass
		count of rows where new 3-pass alg was the winner
	out Int64	winnerCountDblFwd
		count of rows where old double-forward alg was the winner

gmoGetRelativeGap ↵

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

Type: Function returns Double

gmoGetRhs ↵

Get right hand sides

Type: Function returns Integer

Parameters

	PDoubleArray	mdblvec
		Array of doubles, len=number of rows in user view

gmoGetRhsOne ↵

Get individual equation right hand side

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetRhsOneEx ↵

Get individual equation RHS - independent of useQ'

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetRowCVec ↵

Get c vector of the quadratic form for row si

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	varidx
	PDoubleArray	coefs
		Coefficients

gmoGetRowCVecNZOne ↵

Number of NZ in c vector of row si (-1 if Q information not used)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetRowJacInfoOne ↵

Get Jacobian information of row one by one

Type: Procedure

Parameters

	Integer	si
		Index of row in client space
	var Pointer	jacptr
		Pointer to next Jacobian
	out Double	jacval
		Value(s) of Jacobian(s)
	out Integer	colidx
		Column index/indices of Jacobian(s)
	out Integer	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)

gmoGetRowQ ↵

deprecated synonym for gmoGetRowQMat

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	varidx1
		First variable indices
	PLongIntArray	varidx2
		Second variable indices
	PDoubleArray	coefs
		Coefficients

gmoGetRowQConst ↵

Get the constant of the quadratic form for row si

Type: Function returns Double

Parameters

	Integer	si
		Index of row in client space

gmoGetRowQDiagNZOne ↵

Number of NZ on diagonal of Q matrix of row si (-1 if Q information not used)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetRowQMat ↵

Get lower triangle of Q matrix of row si

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	varidx1
		First variable indices
	PLongIntArray	varidx2
		Second variable indices
	PDoubleArray	coefs
		Coefficients

gmoGetRowQNZOne ↵

Number of NZ in Q matrix of row si (-1 if Q information not used or overflow)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoGetRowQNZOne64 ↵

Number of NZ in Q matrix of row si (-1 if Q information not used)

Type: Function returns Int64

Parameters

	Integer	si
		Index of row in client space

gmoGetRowSparse ↵

Get Jacobians information of row (sparse)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	colidx
		Column index/indices of Jacobian(s)
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)
	out Integer	nz
		Number of nonzeros
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetRowSparseEx ↵

Get info for one row of Jacobian (sparse)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	colidx
		Column index/indices of Jacobian(s)
	PDoubleArray	jacval
		Value(s) of Jacobian(s)
	PLongIntArray	nlflag
		NL flag(s) of Jacobian(s) (0 : linear,!=0 : nonlinear)
	out Integer	nz
		Number of nonzeros
	out Integer	qnz
		Number of quadratic nonzeros in Jacobian matrix
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetRowStat ↵

Get row counts

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out Integer	nz
		Number of nonzeros
	out Integer	qnz
		Number of quadratic nonzeros in Jacobian matrix
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetRowStatEx ↵

Get Jacobian row NZ counts: total and by GMOORDER_XX

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out Integer	nz
		Number of nonzeros
	out Integer	lnz
	out Integer	qnz
		Number of quadratic nonzeros in Jacobian matrix
	out Integer	nlnz
		Number of nonlinear nonzeros

gmoGetSolutionEquRec ↵

Get equation solution values (level, marginals and statuses)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	out Double	el
		Level of equation
	out Double	emarg
		Marginal of equation
	out Integer	estat
		Basis status of equation (see enumerated constants)
	out Integer	ecstat
		Status of equation (see enumerated constants)

gmoGetSolutionVarRec ↵

Get variable solution values (level, marginals and statuses)

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space
	out Double	vl
		Level of variable
	out Double	vmarg
		Marginal of variable
	out Integer	vstat
		Basis status of variable (see enumerated constants)
	out Integer	vcstat
		Status of variable (see enumerated constants)

gmoGetSolveStatusTxt ↵

String for solvestatus

Type: Function returns Integer

Parameters

	Integer	solvestat
		Solver status
	out ShortString	s
		String

gmoGetSosConstraints ↵

Get SOS constraints

Type: Function returns Integer

Parameters

	PLongIntArray	sostype
		SOS type 1 or 2
	PLongIntArray	sosbeg
		Variable index start of SOS set
	PLongIntArray	sosind
		Variable indices
	PDoubleArray	soswt
		Weight in SOS set

gmoGetSosCounts ↵

Get SOS count information

Type: Procedure

Parameters

	out Integer	numsos1
		Number of SOS1 sets
	out Integer	numsos2
		Number of SOS2 sets
	out Integer	nzsos
		Number of variables in SOS1/2 sets

gmoGetVarCStat ↵

Get variable status

Type: Procedure

Parameters

	PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoGetVarCStatOne ↵

Get individual variable status

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarDblDotOpt ↵

Get variable double values for dot option

Type: Function returns Integer

Parameters

	Pointer	optptr
		Option object pointer
	const ShortString	dotopt
		Dot option name
	PDoubleArray	optvals
		Option values

gmoGetVarEquMap ↵

Get variable equation mapping list

Type: Function returns Integer

Parameters

	Integer	maptype
		Type of variable equation mapping
	Pointer	optptr
		Option object pointer
	Integer	strict
	var Integer	nmappings
	PLongIntArray	rowindex
	PLongIntArray	colindex
	PLongIntArray	mapval

gmoGetVarIntDotOpt ↵

Get variable integer values for dot option

Type: Function returns Integer

Parameters

	Pointer	optptr
		Option object pointer
	const ShortString	dotopt
		Dot option name
	PLongIntArray	optvals
		Option values

gmoGetVarL ↵

Get variable level values

Type: Function returns Integer

Parameters

	PDoubleArray	x
		Level values of variables

gmoGetVarLOne ↵

Get individual variable level

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarLower ↵

Get variable lower bounds

Type: Function returns Integer

Parameters

	PDoubleArray	lovec
		Lower bound values of variables

gmoGetVarLowerOne ↵

Get individual variable lower bound

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarM ↵

Get variable marginals

Type: Function returns Integer

Parameters

	PDoubleArray	dj
		Marginal values of variables

gmoGetVarMatch ↵

Get variable match

Type: Function returns Integer

Parameters

	PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoGetVarMatchOne ↵

Get individual variable match

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarMOne ↵

Get individual variable marginal

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarNameCustomOne ↵

Get individual column name with quotes and user specified suffix

Type: Function returns ShortString

Parameters

	Integer	sj
		Index of column in client space
	const ShortString	suffix
		Suffix appended to name, could be .l, .m etc.

gmoGetVarNameOne ↵

Get individual column name

Type: Function returns ShortString

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarPrior ↵

Get variable branching priority

Type: Function returns Integer

Parameters

	PDoubleArray	ndblvec
		Array of doubles, len=number of columns in user view

gmoGetVarPriorOne ↵

Get individual variable branching priority

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarScale ↵

Get variable scale

Type: Function returns Integer

Parameters

	PDoubleArray	ndblvec
		Array of doubles, len=number of columns in user view

gmoGetVarScaleOne ↵

Get individual variable scale

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarSosSetOne ↵

Get SOS set for individual variable

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarStage ↵

Get variable stage

Type: Function returns Integer

Parameters

	PDoubleArray	ndblvec
		Array of doubles, len=number of columns in user view

gmoGetVarStageOne ↵

Get individual variable stage

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarStat ↵

Get variable basis status

Type: Procedure

Parameters

	PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoGetVarStatOne ↵

Get individual variable basis status

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarType ↵

Get variable type

Type: Function returns Integer

Parameters

	PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoGetVarTypeCnt ↵

Get variable type count

Type: Function returns Integer

Parameters

	Integer	vtyp
		Type of variable (see enumerated constants)

gmoGetVarTypeOne ↵

Get individual variable type

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarTypeTxt ↵

String for variable type

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space
	out ShortString	s
		String

gmoGetVarUpper ↵

Get variable upper bounds

Type: Function returns Integer

Parameters

	PDoubleArray	upvec
		Upper bound values of variables

gmoGetVarUpperOne ↵

Get individual variable upper bound

Type: Function returns Double

Parameters

	Integer	sj
		Index of column in client space

gmoGetVarVI ↵

Get VI mapping for all cols (-1 if not a VI variable)

Type: Function returns Integer

Parameters

	PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoGetVarVIOne ↵

Get VI mapping for individual cols (-1 if not a VI variable)

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space

gmoGetXLibCounts ↵

Get external function information

Type: Procedure

Parameters

	out Integer	rows
		Number of rows
	out Integer	cols
		Number of columns
	out Integer	nz
		Number of nonzeros
	PLongIntArray	orgcolind

gmoHessDim ↵

Hessian dimension of row

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoHessLagStruct ↵

Get Hessian of the Lagrangian Value structure

Type: Function returns Integer

Parameters

	PLongIntArray	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
	PLongIntArray	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

gmoHessLagValue ↵

Get Hessian of the Lagrangian Value

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	const PDoubleArray	pi
		Marginal values of equations
	PDoubleArray	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
	Double	objweight
		Weight for objective in Hessian of the Lagrangian (=1 for GAMS convention)
	Double	conweight
		Weight for constraints in Hessian of the Lagrangian (=1 for GAMS convention)
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoHessLagVec ↵

Get Hessian of the Lagrangian-vector product

Type: Function returns Integer

Parameters

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

gmoHessLoad ↵

Initialize Hessians

Type: Function returns Integer

Parameters

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

gmoHessNz ↵

Hessian nonzeros of row

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space

gmoHessNz64 ↵

Hessian nonzeros of row

Type: Function returns Int64

Parameters

	Integer	si
		Index of row in client space

gmoHessStruct ↵

Get Hessian Structure

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	hridx
		Hessian row indices
	PLongIntArray	hcidx
		Hessian column indices
	out Integer	hessdim
		Dimension of Hessian
	out Integer	hessnz
		Number of nonzeros in Hessian

gmoHessStruct64 ↵

Get Hessian Structure

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	hridx
		Hessian row indices
	PLongIntArray	hcidx
		Hessian column indices
	out Integer	hessdim
		Dimension of Hessian
	out Int64	hessnz
		Number of nonzeros in Hessian

gmoHessUnload ↵

Unload Hessians

Type: Function returns Integer

gmoHessValue ↵

Get Hessian Value

Type: Function returns Integer

Parameters

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

gmoHessValue64 ↵

Get Hessian Value

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	PLongIntArray	hridx
		Hessian row indices
	PLongIntArray	hcidx
		Hessian column indices
	out Integer	hessdim
		Dimension of Hessian
	out Int64	hessnz
		Number of nonzeros in Hessian
	const PDoubleArray	x
		Level values of variables
	PDoubleArray	hessval
	out Integer	numerr
		Number of errors evaluating the nonlinear function

gmoHessVec ↵

Get Hessian-vector product

Type: Function returns Integer

Parameters

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

gmoInitData ↵

Initialize GMO data

Type: Function returns Integer

Parameters

	Integer	rows
		Number of rows
	Integer	cols
		Number of columns
	Integer	codelen
		length of NL code

gmoLoadDataLegacy ↵

Read instance from scratch files - Legacy Mode - without gmoFillMatches

Type: Function returns Integer

Parameters

	out ShortString	msg
		Message

gmoLoadDataLegacyEx ↵

Read instance from scratch files - Legacy Mode

Type: Function returns Integer

Parameters

	const Boolean	fillMatches
		controls gmoFillMatches call during the load
	out ShortString	msg
		Message

gmoLoadEMPInfo ↵

Load EMP information

Type: Function returns Integer

Parameters

	const ShortString	empinfofname
		Name of EMP information file, if empty assume the default name and location

gmoLoadExtrLibEntry ↵

Load a function from an extrinsic function library

Type: Function returns Pointer

Parameters

	Integer	libidx
		Library index
	const ShortString	name
	out ShortString	msg
		Message

gmoLoadSolutionGDX ↵

Load solution to GDX solution file (optional: rows, cols and-or header and tail info)

Type: Function returns Integer

Parameters

	const ShortString	gdxfname
		Name of GDX file
	const Boolean	dorows
		Flag whether to read/write row information from/to solution file
	const Boolean	docols
		Flag whether to read/write column information from/to solution file
	const Boolean	doht
		Flag whether to read/write head and tail information from/to solution file

gmoLoadSolutionLegacy ↵

Load solution from legacy solution file

Type: Function returns Integer

gmoMemUsed ↵

Get current memory consumption of GMO in MB

Type: Function returns Double

gmoPeakMemUsed ↵

Get peak memory consumption of GMO in MB

Type: Function returns Double

gmoPrepareAllSolToGDX ↵

Initialize writing of multiple solutions (e.g. scenarios) to a GDX file

Type: Function returns Integer

Parameters

	const ShortString	gdxfname
		Name of GDX file
	Pointer	scengdx
		Pointer to GDX solution file containing multiple solutions, e.g. scenarios
	Integer	dictid
		GDX symbol number of dict

gmoPrepareSolPoolMerge ↵

Prepare merged solution pool GDX file

Type: Function returns Pointer

Parameters

	const ShortString	gdxfname
		Name of GDX file
	Integer	numsol
		Number of solutions in solution pool
	const ShortString	prefix

gmoPrepareSolPoolNextSym ↵

Write solution to merged solution pool GDX file

Type: Function returns Integer

Parameters

Pointer handle

gmoRegisterEnvironment ↵

Type: Function returns Integer

Parameters

	Pointer	gevptr
	out ShortString	msg
		Message

gmoSetAltRHS ↵

Set alternative RHS

Type: Function returns Integer

Parameters

	const PDoubleArray	mdblvec
		Array of doubles, len=number of rows in user view

gmoSetAltRHSOne ↵

Set individual alternative RHS

Type: Procedure

Parameters

	Integer	si
		Index of row in client space
	Double	erhs
		RHS of equation

gmoSetAltVarBounds ↵

Set alternative variable lower and upper bounds

Type: Function returns Integer

Parameters

	const PDoubleArray	lovec
		Lower bound values of variables
	const PDoubleArray	upvec
		Upper bound values of variables

gmoSetAltVarLowerOne ↵

Set individual alternative variable lower bound

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	Double	vlo
		Lower bound of variable

gmoSetAltVarType ↵

Set alternative variable type

Type: Function returns Integer

Parameters

	const PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoSetAltVarTypeOne ↵

Set individual alternative variable type

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	Integer	vtyp
		Type of variable (see enumerated constants)

gmoSetAltVarUpperOne ↵

Set individual alternative variable upper bound

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	Double	vup
		Upper bound of variable

gmoSetEquCStat ↵

Set equation status

Type: Procedure

Parameters

	const PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoSetEquL ↵

Set equation activity levels

Type: Function returns Integer

Parameters

	const PDoubleArray	el
		Level of equation

gmoSetEquLOne ↵

Set individual equation activity levels

Type: Procedure

Parameters

	Integer	si
		Index of row in client space
	Double	el
		Level of equation

gmoSetEquM ↵

Set equation marginals (pass NULL to set to NA)

Type: Function returns Integer

Parameters

	const PDoubleArray	emarg
		Marginal of equation

gmoSetEquPermutation ↵

Set Permutation vectors for equations (model view)

Type: Function returns Integer

Parameters

	PLongIntArray	permut
		Permutation vector (original/GAMS to client)

gmoSetEquSlack ↵

Set equation slacks

Type: Function returns Integer

Parameters

	const PDoubleArray	mdblvec
		Array of doubles, len=number of rows in user view

gmoSetEquStat ↵

Set equation basis status

Type: Procedure

Parameters

	const PLongIntArray	mintvec
		Array of integers, len=number of rows in user view

gmoSetExtFuncs ↵

Set external function manager object

Type: Procedure

Parameters

Pointer extfunmgr

gmoSetHeadnTail ↵

Set value of solution head or tail record, except for modelstat and solvestat (see enumerated constants)

Type: Procedure

Parameters

	Integer	htrec
		Solution head or tail record, (see enumerated constants)
	Double	dval
		Double value

gmoSetNLObject ↵

Set NL Object and constant pool

Type: Function returns Integer

Parameters

	Pointer	nlobject
		Object of nonlinear instructions
	Pointer	nlpool
		Constant pool object for constants in nonlinear instruction

gmoSetNLTables ↵

Set NL object and constant pool via plain arrays.

Type: Function returns Integer

Parameters

	Integer	numInstructions
		Number of nonlinear instructions (opcode and field pairs)
	const PLongIntArray	opcodes
		Array of opcodes (integers)
	const PLongIntArray	fields
		Array of fields (integers)
	Integer	numConstants
		Number of nonlinear constants
	const PDoubleArray	constants
		Array of constants (doubles)
	Integer	NLCodeSizeMaxRow
		Maximum single code per row

gmoSetNRowPerm ↵

Set Permutation to skip =n= rows

Type: Function returns Integer

gmoSetRvEquPermutation ↵

Set Permutation vectors for equations (solver view)

Type: Function returns Integer

Parameters

	PLongIntArray	rvpermut
		Reverse permutation vector (client to original/GAMS)
	Integer	len
		Length of array

gmoSetRvVarPermutation ↵

Set Permutation vectors for variables (solver view)

Type: Function returns Integer

Parameters

	PLongIntArray	rvpermut
		Reverse permutation vector (client to original/GAMS)
	Integer	len
		Length of array

gmoSetSolution ↵

Set solution values for variable and equation levels as well as marginals

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	const PDoubleArray	dj
		Marginal values of variables
	const PDoubleArray	pi
		Marginal values of equations
	const PDoubleArray	e
		Level values of equations

gmoSetSolution2 ↵

Set solution values for variable levels and equation marginals

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	const PDoubleArray	pi
		Marginal values of equations

gmoSetSolution8 ↵

Set solution values for variable and equation levels, marginals and statuses

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables
	const PDoubleArray	dj
		Marginal values of variables
	const PDoubleArray	pi
		Marginal values of equations
	const PDoubleArray	e
		Level values of equations
	PLongIntArray	xb
		Basis statuses of variables (see enumerated constants)
	PLongIntArray	xs
		Statuses of variables (see enumerated constants)
	PLongIntArray	yb
		Basis statuses of equations (see enumerated constants)
	PLongIntArray	ys
		Statuses of equation (see enumerated constants)

gmoSetSolutionEquRec ↵

Set equation solution values (level, marginals and statuses)

Type: Function returns Integer

Parameters

	Integer	si
		Index of row in client space
	Double	el
		Level of equation
	Double	emarg
		Marginal of equation
	Integer	estat
		Basis status of equation (see enumerated constants)
	Integer	ecstat
		Status of equation (see enumerated constants)

gmoSetSolutionFixer ↵

Construct and set solution based on available inputs

Type: Function returns Integer

Parameters

	Integer	modelstathint
		Model status used as a hint
	const PDoubleArray	x
		Level values of variables
	const PDoubleArray	pi
		Marginal values of equations
	const PLongIntArray	xb
		Basis statuses of variables (see enumerated constants)
	const PLongIntArray	yb
		Basis statuses of equations (see enumerated constants)
	Double	infTol
		Infeasibility tolerance
	Double	optTol
		Optimality tolerance

gmoSetSolutionPrimal ↵

Set solution values for variable levels

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables

gmoSetSolutionStatus ↵

Set solution values sfor variable and equation statuses

Type: Function returns Integer

Parameters

	PLongIntArray	xb
		Basis statuses of variables (see enumerated constants)
	PLongIntArray	xs
		Statuses of variables (see enumerated constants)
	PLongIntArray	yb
		Basis statuses of equations (see enumerated constants)
	PLongIntArray	ys
		Statuses of equation (see enumerated constants)

gmoSetSolutionVarRec ↵

Set variable solution values (level, marginals and statuses)

Type: Function returns Integer

Parameters

	Integer	sj
		Index of column in client space
	Double	vl
		Level of variable
	Double	vmarg
		Marginal of variable
	Integer	vstat
		Basis status of variable (see enumerated constants)
	Integer	vcstat
		Status of variable (see enumerated constants)

gmoSetVarCStat ↵

Set variable status

Type: Procedure

Parameters

	const PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoSetVarL ↵

Set variable level values

Type: Function returns Integer

Parameters

	const PDoubleArray	x
		Level values of variables

gmoSetVarLOne ↵

Set individual variable level

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	Double	vl
		Level of variable

gmoSetVarM ↵

Set variable marginals (pass null to set to NA)'

Type: Function returns Integer

Parameters

	const PDoubleArray	dj
		Marginal values of variables

gmoSetVarMOne ↵

Set individual variable marginal

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	Double	vmarg
		Marginal of variable

gmoSetVarPermutation ↵

Set Permutation vectors for variables (model view)

Type: Function returns Integer

Parameters

	PLongIntArray	permut
		Permutation vector (original/GAMS to client)

gmoSetVarStat ↵

Set variable basis status

Type: Procedure

Parameters

	const PLongIntArray	nintvec
		Array of integers, len=number of columns in user view

gmoSetVarStatOne ↵

Set individual variable basis status

Type: Procedure

Parameters

	Integer	sj
		Index of column in client space
	Integer	vstat
		Basis status of variable (see enumerated constants)

gmoUnloadSolPoolSolution ↵

Write solution to merged solution pool GDX file

Type: Function returns Integer

Parameters

	Pointer	handle
	Integer	numsol
		Number of solutions in solution pool

gmoUnloadSolutionGDX ↵

Unload solution to GDX solution file (optional: rows, cols and-or header and tail info)

Type: Function returns Integer

Parameters

	const ShortString	gdxfname
		Name of GDX file
	const Boolean	dorows
		Flag whether to read/write row information from/to solution file
	const Boolean	docols
		Flag whether to read/write column information from/to solution file
	const Boolean	doht
		Flag whether to read/write head and tail information from/to solution file

gmoUnloadSolutionLegacy ↵

Unload solution to legacy solution file

Type: Function returns Integer

gmoUpdateJac ↵

Update the linear Jacobian element at (mi,mj), returning 0 on success

Type: Function returns Integer

Parameters

	Integer	mi
		Index of row in [1..m]
	Integer	mj
		Index of column in [1..n]
	Double	v
		New Jacobian coefficient
	out ShortString	msg
		Message

gmoViewDump ↵

Dump current view to stdout

Type: Procedure

gmoViewRestore ↵

Restore view

Type: Procedure

Parameters

	var Pointer	viewptr
		Pointer to structure storing the view of a model

gmoViewStore ↵

Store current view in view object

Type: Function returns Pointer

gmoWriteSolDone ↵

Finalize writing of multiple solutions (e.g. scenarios) to a GDX file

Type: Function returns Integer

Parameters

	out ShortString	msg
		Message

Functions, Procedures, and Properties

Initialization

Model Characteristics

Model View

Deprecated

Model View

Model Statistics

Deprecated

Model Statistics

Objective Information

Evaluation (general)

Function Evaluation

Gradient Evaluation

Hessian Evaluation

EMP Information

Names

Other

Column Information

Deprecated

EMP Information

Evaluation (general)

Extrinsic Functions

Function Evaluation

Gradient Evaluation

Hessian Evaluation

Initialization

Matrix

Memory Usage

Model Statistics

Model View

Names

Objective Information

Other

Row Information

Solution

Enumerated Constants

Definitions

gmoAltBounds ↵

gmoAltBoundsSet ↵

gmoAltRHS ↵

gmoAltRHSSet ↵

gmoAltVarTypes ↵

gmoAltVarTypesSet ↵

gmoDict ↵

gmoDictSet ↵

gmoDictionary ↵

gmoDictionarySet ↵

gmoEmptyOut ↵

gmoEmptyOutSet ↵

gmoError ↵

gmoErrorSet ↵

gmoErrorMessage ↵

gmoEvalErrorMethod ↵

gmoEvalErrorMethodSet ↵

gmoEvalFuncCount ↵

gmoEvalFuncTimeUsed ↵

gmoEvalGradCount ↵

gmoEvalGradTimeUsed ↵

gmoEvalMaxThreads ↵

gmoEvalMaxThreadsSet ↵

gmoForceCont ↵

gmoForceContSet ↵

gmoForceLinear ↵

gmoForceLinearSet ↵

gmoGetObjOrder ↵

gmoGNLNZ ↵

gmoGNLNZ64 ↵

gmoHaveBasis ↵

gmoHaveBasisSet ↵

gmoHessInclQRows ↵

gmoHessInclQRowsSet ↵

gmoHessLagDiagNz ↵

gmoHessLagDim ↵

gmoHessLagNz ↵

gmoHessLagNz64 ↵

gmoHessMaxDim ↵

gmoHessMaxNz ↵

gmoHessMaxNz64 ↵

gmoIgnXCDeriv ↵

gmoIgnXCDerivSet ↵