Generated for GAMS 34.3.0

Functions, Procedures and Properties

Initialization

gevRegisterWriteCallback: Register callback for log and status streams
gevCompleteEnvironment: Complete initialization of environment
gevInitEnvironmentLegacy: Initialization in legacy mode (from control file)

GAMS Options

gevThreads: Number of threads (1..n)
gevGetIntOpt: Get integer valued option (see enumerated constants)
gevGetDblOpt: Get double valued option (see enumerated constants)
gevGetStrOpt: Get string valued option (see enumerated constants)
gevSetIntOpt: Set integer valued option (see enumerated constants)
gevSetDblOpt: Set double valued option (see enumerated constants)
gevSetStrOpt: Set string valued option (see enumerated constants)
gevSynchronizeOpt: Copy environment options to passed in option object

GAMS Solvers

gevGetSlvExeInfo: Name of solver executable
gevGetSlvLibInfo: Solver library name, prefix, and API version
gevCapabilityCheck: Check if solver is capable to handle model type given
gevSolverVisibility: Provide information if solver is hidden
gevNumSolvers: Number of solvers in the system
gevGetSolver: Name of the solver chosen for modeltype (if non is chosen, it is the default)
gevGetCurrentSolver: Name of the select solver
gevGetSolverDefault: Name of the default solver for modeltype
gevSolver2Id: Internal ID of solver, 0 for failure
gevId2Solver: Solver name
gevCallSolverNextGridDir: Creates grid directory for next gevCallSolver call and returns name (if called with gevSolveLinkAsyncGrid or gevSolveLinkAsyncSimulate)
gevCallSolver: Call GAMS solver on GMO model or control file
gevCallSolverHandleStatus: Check status of solver job if called with gevSolveLinkAsyncGrid (0 job is done, 1 unknown job handle, 2 job is running)
gevCallSolverHandleDelete: Delete instance of solver job if called with gevSolveLinkAsyncGrid (0 deleted, 1 unknown job handle, 2 deletion failed)
gevCallSolverHandleCollect: Collect solution from solver job if called with gevSolveLinkAsyncGrid (0 loaded, 1 unknown job handle, 2 job is running, 3 other error), delete instance

Logging

gevSkipIOLegacy(Set): Prevent log and status file to be opened
gevSwitchLogStat: Switch log and status streams to another file or callback
gevGetLShandle: Returns handle to last log and status stream stored by gevSwitchLogStat (Workaround for problem with vptr in Python)
gevRestoreLogStat: Restore log status stream settings
gevRestoreLogStatRewrite: Restore log status stream settings but never append to former log
gevLog: Send string to log stream
gevLogPChar: Send PChar to log stream, no newline added
gevStat: Send string to status stream
gevStatC: Send string to status and copy to listing file
gevStatPChar: Send PChar to status stream, no newline added
gevStatAudit: GAMS internal status stream operation {=0}
gevStatCon: GAMS internal status stream operation {=1}
gevStatCoff: GAMS internal status stream operation {=2}
gevStatEOF: GAMS internal status stream operation {=3}
gevStatSysout: GAMS internal status stream operation {=4}
gevStatAddE: GAMS internal status stream operation {=5}
gevStatAddV: GAMS internal status stream operation {=6}
gevStatAddJ: GAMS internal status stream operation {=7}
gevStatEject: GAMS internal status stream operation {=8}
gevStatEdit: GAMS internal status stream operation {=9}
gevStatE: GAMS internal status stream operation {=E}
gevStatV: GAMS internal status stream operation {=V}
gevStatT: GAMS internal status stream operation {=T}
gevStatA: GAMS internal status stream operation {=A}
gevStatB: GAMS internal status stream operation {=B}
gevLogStat: Send string to log and status streams and copy to listing file
gevLogStatNoC: Send string to log and status streams
gevLogStatPChar: Send string to log and status streams, no newline added
gevLogStatFlush: Flush status streams (does not work with callback)
gevGetAnchor: Get anchor line for log (points to file and is clickable in GAMS IDE)
gevLSTAnchor: Put a line to log that points to the current lst line"
gevStatAppend: Append status file to current status file
gevMIPReport: Print MIP report to log and lst

Timing

gevTimeJNow: GAMS Julian time
gevTimeDiff: Time difference in seconds since creation or last call to gevTimeDiff
gevTimeDiffStart: Time difference in seconds since creation of object
gevTimeSetStart: Reset timer (overwrites time stamp from creation)

Interrupt

gevTerminateUninstall: Uninstalls an already registered interrupt handler
gevTerminateInstall: Installs an already registered interrupt handler
gevTerminateSet: Register a pointer to some memory that will indicate an interrupt and the pointer to a interrupt handler and installs it
gevTerminateGet: Check if one should interrupt
gevTerminateClear: Resets the interrupt counter
gevTerminateRaise: Increases the interrupt counter
gevTerminateGetHandler: Get installed termination handler

Other

gevNSolves: Number of solves
gevGetScratchName: Get scratch file name plus scratch extension including path of scratch directory
gevWriteModelInstance: Creates model instance file
gevDuplicateScratchDir: Duplicates a scratch directory and points to read only files in source scratch directory

Deprecated

gevInitJacLegacy: Legacy Jacobian Evaluation: Initialize row wise Jacobian structure
gevSetColRowPermLegacy: Legacy Jacobian Evaluation: Set column and row permutation GAMS to solver
gevSetJacPermLegacy: Legacy Jacobian Evaluation: Set Jacobian permutation GAMS to solver
gevEvalNewPointLegacy: Legacy Jacobian Evaluation: Set new point and do point copy magic
gevEvalJacLegacy: Legacy Jacobian Evaluation: Evaluate row and store in Jacobian structure
gevEvalJacLegacyX: Legacy Jacobian Evaluation: Evaluate set of rows and store in Jacobian structure
gevNextNLLegacy: Legacy Jacobian Evaluation: Provide next nonlinear row, start with M
gevRowGms2SlvLegacy: Legacy Jacobian Evaluation: Provide permuted row index
gevFreeJacLegacy: Legacy Jacobian Evaluation: Free row wise Jacobian structure
gevGetALGX: Pass pointer to ALGX structure

Arguments

C: Character
capable: Flag whether solver is capable or not
cgms2slv: GAMS to solver permutation of columns
cnt: count
cntrfn: Name of control file
domlim: Domain violation limit
domviol: Domain violations
ehdler: Pointer to interrupt handler
evalptr: Pointer to structure for legacy Jacobian evaluation
exename: Name of solver executable
f: Function value
fvec: Vector of function values
gmoptr: Pointer to GAMS modeling object
ifversion: Version of solver interface
intr: Pointer to some memory indicating an interrupt
iterlim: Iteration limit
ival: Integer value
ivec: Array of integer options
jac: Array to store the gradients
jacs: Array of original indices of Jacobian elements (1-based), length njacs
jgms2slv: GAMS to solver permutation of Jacobian elements, length njacs
jobhandle: Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid
libname: Name of solver library
lo: logoption (0..3)
logappend: Flag whether to append to log stream or not
logenabled: Flag to enable log or not
logfn: Log file name
Logging: Log option for solver called through gevCallSolver (see enumerated constants)
lshandle: Log and status handle for later restoring
lsw: Pointer to callback for log and status streams
m: Number of constraints
mi: Index or constraint
mifn: Model instance file name
mj: Index or variable
modeltype: ModelType
msg: Message
n: Number of variables
njacs: Number of Jacobian elements in jacs and jgms2slv arrays
njacsupd: Number of Jacobian elements updated
nlcodelen: Length of nonlinear code
optca: Optimality criterion for absolute gap
optcr: Optimality criterion for relative gap
optname: Name of option (see enumerated constants)
optptr: Pointer to option object
p: Pointer to array of characters
palg: Pointer to ALGX structure (GAMS Internal)
prefix: Prefix of solver
reslim: Resource limit
result: Result/Return code of function
rgms2slv: GAMS to solver permutation of rows
rowidx: Vector of row indicies
rval: Real/Double value
rvec: Array of real/double options
s: String
s2: String
scrdir: Scratch directory
si: Solve index for row i
solvelink: Solvelink option for solver called through gevCallSolver (see enumerated constants)
solverid: Internal ID of solver
solvername: Name of solver
statappend: Flag whether to append to status stream or not
statfn: Status file name
sval: String value
svec: Array of string options
usrmem: User memory
x: Input values for variables

Calling Sequences

gevCallSolver

Call GAMS solver on GMO model or control file
Function returns Integer
Arguments:

gmoptr : Pointer: Pointer to GAMS modeling object
const cntrfn : ShortString: Name of control file
const solvername: ShortString: Name of solver
solvelink : Integer: Solvelink option for solver called through gevCallSolver (see enumerated constants)
Logging : Integer: Log option for solver called through gevCallSolver (see enumerated constants)
const logfn : ShortString: Log file name
const statfn : ShortString: Status file name
reslim : Double: Resource limit
iterlim : Integer: Iteration limit
domlim : Integer: Domain violation limit
optcr : Double: Optimality criterion for relative gap
optca : Double: Optimality criterion for absolute gap
var jobhandle : Pointer: Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid
out msg : ShortString: Message

gevCallSolverHandleCollect

Collect solution from solver job if called with gevSolveLinkAsyncGrid (0 loaded, 1 unknown job handle, 2 job is running, 3 other error), delete instance
Function returns Integer
Arguments:

var jobhandle : Pointer: Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid
gmoptr : Pointer: Pointer to GAMS modeling object

gevCallSolverHandleDelete

Delete instance of solver job if called with gevSolveLinkAsyncGrid (0 deleted, 1 unknown job handle, 2 deletion failed)
Function returns Integer
Arguments:

var jobhandle : Pointer: Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid

gevCallSolverHandleStatus

Check status of solver job if called with gevSolveLinkAsyncGrid (0 job is done, 1 unknown job handle, 2 job is running)
Function returns Integer
Arguments:

jobhandle : Pointer: Handle to solver job in case of solvelink=gevSolveLinkAsyncGrid

gevCallSolverNextGridDir

Creates grid directory for next gevCallSolver call and returns name (if called with gevSolveLinkAsyncGrid or gevSolveLinkAsyncSimulate)
Function returns ShortString

gevCapabilityCheck

Check if solver is capable to handle model type given
Function returns Integer
Arguments:

modeltype : Integer: ModelType
const solvername: ShortString: Name of solver
var capable : Boolean: Flag whether solver is capable or not

gevCompleteEnvironment

Complete initialization of environment
Procedure
Arguments:

palg : Pointer: Pointer to ALGX structure (GAMS Internal)
ivec : Pointer: Array of integer options
rvec : Pointer: Array of real/double options
svec : Pointer: Array of string options

gevDuplicateScratchDir

Duplicates a scratch directory and points to read only files in source scratch directory
Function returns Integer
Arguments:

const scrdir : ShortString: Scratch directory
const logfn : ShortString: Log file name
out cntrfn : ShortString: Name of control file

gevEvalJacLegacy

Legacy Jacobian Evaluation: Evaluate row and store in Jacobian structure
Function returns Integer
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
si : Integer: Solve index for row i
x : PDoubleArray: Input values for variables
var f : Double: Function value
jac : PDoubleArray: Array to store the gradients
var domviol : Integer: Domain violations
var njacsupd : Integer: Number of Jacobian elements updated

gevEvalJacLegacyX

Legacy Jacobian Evaluation: Evaluate set of rows and store in Jacobian structure
Function returns Integer
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
cnt : Integer: count
rowidx : PLongIntArray: Vector of row indicies
x : PDoubleArray: Input values for variables
fvec : PDoubleArray: Vector of function values
jac : PDoubleArray: Array to store the gradients
var domviol : Integer: Domain violations
var njacsupd : Integer: Number of Jacobian elements updated

gevEvalNewPointLegacy

Legacy Jacobian Evaluation: Set new point and do point copy magic
Function returns Integer
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
x : PDoubleArray: Input values for variables

gevFreeJacLegacy

Legacy Jacobian Evaluation: Free row wise Jacobian structure
Procedure
Arguments:

var evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation

gevGetALGX

Pass pointer to ALGX structure
Function returns Pointer

gevGetAnchor

Get anchor line for log (points to file and is clickable in GAMS IDE)
Function returns ShortString
Arguments:

const s : ShortString: String

gevGetCurrentSolver

Name of the select solver
Function returns ShortString
Arguments:

gmoptr : Pointer: Pointer to GAMS modeling object

gevGetDblOpt

Get double valued option (see enumerated constants)
Function returns Double
Arguments:

const optname : ShortString: Name of option (see enumerated constants)

gevGetIntOpt

Get integer valued option (see enumerated constants)
Function returns Integer
Arguments:

const optname : ShortString: Name of option (see enumerated constants)

gevGetLShandle

Returns handle to last log and status stream stored by gevSwitchLogStat (Workaround for problem with vptr in Python)
Function returns Pointer

gevGetScratchName

Get scratch file name plus scratch extension including path of scratch directory
Function returns ShortString
Arguments:

const s : ShortString: String

gevGetSlvExeInfo

Name of solver executable
Function returns Integer
Arguments:

const solvername: ShortString: Name of solver
out exename : ShortString: Name of solver executable

gevGetSlvLibInfo

Solver library name, prefix, and API version
Function returns Integer
Arguments:

const solvername: ShortString: Name of solver
out libname : ShortString: Name of solver library
out prefix : ShortString: Prefix of solver
out ifversion : Integer: Version of solver interface

gevGetSolver

Name of the solver chosen for modeltype (if non is chosen, it is the default)
Function returns ShortString
Arguments:

modeltype : Integer: ModelType

gevGetSolverDefault

Name of the default solver for modeltype
Function returns ShortString
Arguments:

modeltype : Integer: ModelType

gevGetStrOpt

Get string valued option (see enumerated constants)
Function returns ShortString
Arguments:

const optname : ShortString: Name of option (see enumerated constants)

gevId2Solver

Solver name
Function returns ShortString
Arguments:

solverid : Integer: Internal ID of solver

gevInitEnvironmentLegacy

Initialization in legacy mode (from control file)
Function returns Integer
Arguments:

const cntrfn : ShortString: Name of control file

gevInitJacLegacy

Legacy Jacobian Evaluation: Initialize row wise Jacobian structure
Function returns Integer
Arguments:

var evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
gmoptr : Pointer: Pointer to GAMS modeling object

gevLog

Send string to log stream
Procedure
Arguments:

const s : ShortString: String

gevLogPChar

Send PChar to log stream, no newline added
Procedure
Arguments:

const p : PAnsiChar: Pointer to array of characters

gevLogStat

Send string to log and status streams and copy to listing file
Procedure
Arguments:

const s : ShortString: String

gevLogStatFlush

Flush status streams (does not work with callback)
Procedure

gevLogStatNoC

Send string to log and status streams
Procedure
Arguments:

const s : ShortString: String

gevLogStatPChar

Send string to log and status streams, no newline added
Procedure
Arguments:

const p : PAnsiChar: Pointer to array of characters

gevLSTAnchor

Put a line to log that points to the current lst line"
Procedure
Arguments:

const s : ShortString: String

gevMIPReport

Print MIP report to log and lst
Procedure
Arguments:

gmoptr : Pointer: Pointer to GAMS modeling object
fixobj : Double
fixiter : Integer
agap : Double
rgap : Double

gevNextNLLegacy

Legacy Jacobian Evaluation: Provide next nonlinear row, start with M
Function returns Integer
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
si : Integer: Solve index for row i

gevNSolves

Number of solves
Property of type Double
Actions
- r

gevNumSolvers

Number of solvers in the system
Function returns Integer

gevRegisterWriteCallback

Register callback for log and status streams
Procedure
Arguments:

lsw : Tgevlswrite: Pointer to callback for log and status streams Procedure(const msg:ShortString, mode:Integer, usrmem:Pointer)
const logenabled: Boolean: Flag to enable log or not
usrmem : Pointer: User memory

gevRestoreLogStat

Restore log status stream settings
Function returns Boolean
Arguments:

var lshandle : Pointer: Log and status handle for later restoring

gevRestoreLogStatRewrite

Restore log status stream settings but never append to former log
Function returns Boolean
Arguments:

var lshandle : Pointer: Log and status handle for later restoring

gevRowGms2SlvLegacy

Legacy Jacobian Evaluation: Provide permuted row index
Function returns Integer
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
si : Integer: Solve index for row i

gevSetColRowPermLegacy

Legacy Jacobian Evaluation: Set column and row permutation GAMS to solver
Procedure
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
n : Integer: Number of variables
cgms2slv : PLongIntArray: GAMS to solver permutation of columns
m : Integer: Number of constraints
rgms2slv : PLongIntArray: GAMS to solver permutation of rows

gevSetDblOpt

Set double valued option (see enumerated constants)
Procedure
Arguments:

const optname : ShortString: Name of option (see enumerated constants)
rval : Double: Real/Double value

gevSetIntOpt

Set integer valued option (see enumerated constants)
Procedure
Arguments:

const optname : ShortString: Name of option (see enumerated constants)
ival : Integer: Integer value

gevSetJacPermLegacy

Legacy Jacobian Evaluation: Set Jacobian permutation GAMS to solver
Procedure
Arguments:

evalptr : Pointer: Pointer to structure for legacy Jacobian evaluation
njacs : Integer: Number of Jacobian elements in jacs and jgms2slv arrays
jacs : PLongIntArray: Array of original indices of Jacobian elements (1-based), length njacs
jgms2slv : PLongIntArray: GAMS to solver permutation of Jacobian elements, length njacs

gevSetStrOpt

Set string valued option (see enumerated constants)
Procedure
Arguments:

const optname : ShortString: Name of option (see enumerated constants)
const sval : ShortString: String value

gevSkipIOLegacy(Set)

Prevent log and status file to be opened
Property of type Boolean
Actions
- w

gevSolver2Id

Internal ID of solver, 0 for failure
Function returns Integer
Arguments:

const solvername: ShortString: Name of solver

gevSolverVisibility

Provide information if solver is hidden
Function returns Integer
Arguments:

const solvername: ShortString: Name of solver
var hidden : Boolean
var defaultok : Boolean

gevStat

Send string to status stream
Procedure
Arguments:

const s : ShortString: String

gevStatA

GAMS internal status stream operation {=A}
Procedure
Arguments:

const s : ShortString: String

gevStatAddE

GAMS internal status stream operation {=5}
Procedure
Arguments:

mi : Integer: Index or constraint
const s : ShortString: String

gevStatAddJ

GAMS internal status stream operation {=7}
Procedure
Arguments:

mi : Integer: Index or constraint
mj : Integer: Index or variable
const s : ShortString: String

gevStatAddV

GAMS internal status stream operation {=6}
Procedure
Arguments:

mj : Integer: Index or variable
const s : ShortString: String

gevStatAppend

Append status file to current status file
Function returns Integer
Arguments:

const statfn : ShortString: Status file name
out msg : ShortString: Message

gevStatAudit

GAMS internal status stream operation {=0}
Procedure
Arguments:

const s : ShortString: String

gevStatB

GAMS internal status stream operation {=B}
Procedure
Arguments:

const s : ShortString: String

gevStatC

Send string to status and copy to listing file
Procedure
Arguments:

const s : ShortString: String

gevStatCoff

GAMS internal status stream operation {=2}
Procedure

gevStatCon

GAMS internal status stream operation {=1}
Procedure

gevStatE

GAMS internal status stream operation {=E}
Procedure
Arguments:

const s : ShortString: String
mi : Integer: Index or constraint
const s2 : ShortString: String

gevStatEdit

GAMS internal status stream operation {=9}
Procedure
Arguments:

C : AnsiChar: Character

gevStatEject

GAMS internal status stream operation {=8}
Procedure

gevStatEOF

GAMS internal status stream operation {=3}
Procedure

gevStatPChar

Send PChar to status stream, no newline added
Procedure
Arguments:

const p : PAnsiChar: Pointer to array of characters

gevStatSysout

GAMS internal status stream operation {=4}
Procedure

gevStatT

GAMS internal status stream operation {=T}
Procedure

gevStatV

GAMS internal status stream operation {=V}
Procedure
Arguments:

const s : ShortString: String
mj : Integer: Index or variable
const s2 : ShortString: String

gevSwitchLogStat

Switch log and status streams to another file or callback
Function returns Boolean
Arguments:

lo : Integer: logoption (0..3)
const logfn : ShortString: Log file name
const logappend : Boolean: Flag whether to append to log stream or not
const statfn : ShortString: Status file name
const statappend: Boolean: Flag whether to append to status stream or not
lsw : Tgevlswrite: Pointer to callback for log and status streams Procedure(const msg:ShortString, mode:Integer, usrmem:Pointer)
usrmem : Pointer: User memory
var lshandle : Pointer: Log and status handle for later restoring