ConfiEnvironment (CFG) Documentation

Generated for GAMS 37.1.0

Functions, Procedures, and Properties

 

GAMS Solvers

Integer cfgNumAlgs
 Number of solvers
 
Integer cfgDefaultAlg
 Number of default solver for model type proc
 
ShortString cfgAlgName
 Name of solver
 
ShortString cfgAlgCode
 Code of solver
 
Boolean cfgAlgHidden
 Returns true, if alg should be hidden
 
Boolean cfgAlgAllowsModifyProblem
 Solver can modify problem
 
Integer cfgAlgLibInfo
 Get link library info for solver
 
Integer cfgAlgThreadSafeIndic
 Get thread safety indicator for solver
 
Integer cfgAlgNumber
 Number of solver
 
Boolean cfgAlgCapability
 Solver Modeltype capability matrix
 
Boolean cfgAlgCreate
 Create solver link object
 
Integer cfgAlgReadyAPI
 Call solver readyapi
 
Integer cfgAlgModifyProblem
 Call solver modifyproblem
 
Integer cfgAlgCallSolver
 Call solver modifyproblem
 
void cfgAlgFree
 Call solver modifyproblem
 
Boolean cfgDefFileName
 Gives name of definition file for given solver (Returns true on success, false in case of problem)
 

Initialization

Integer cfgReadConfig
 Read GAMS configuration file
 
Integer cfgReadConfigGUC
 Read GAMS configuration file plus gamsconfig.yaml
 

Other

ShortString cfgModelTypeName
 Modeltype name
 
Integer cfgModelTypeNumber
 Modeltype number
 
Integer cfgNumMsg
 Number of pending messages
 
ShortString cfgGetMsg
 Pending messages
 

Enumerated Constants

 
cfgProcType cfgProc_none  = 0
  cfgProc_lp  = 1
  cfgProc_mip  = 2
  cfgProc_rmip  = 3
  cfgProc_nlp  = 4
  cfgProc_mcp  = 5
  cfgProc_mpec  = 6
  cfgProc_rmpec  = 7
  cfgProc_cns  = 8
  cfgProc_dnlp  = 9
  cfgProc_rminlp  = 10
  cfgProc_minlp  = 11
  cfgProc_qcp  = 12
  cfgProc_miqcp  = 13
  cfgProc_rmiqcp  = 14
  cfgProc_emp  = 15
  cfgProc_nrofmodeltypes  = 16
 

Definitions

cfgAlgAllowsModifyProblem 

Solver can modify problem

Type
Function returns Boolean
Parameters
   Integer    alg
     Solver number

cfgAlgCallSolver 

Call solver modifyproblem

Type
Function returns Integer
Parameters
   Integer    alg
     Solver number
   Pointer    psl
   Pointer    gmo

cfgAlgCapability 

Solver Modeltype capability matrix

Type
Function returns Boolean
Parameters
   Integer    alg
     Solver number
   Integer    proc
     Model type number

cfgAlgCode 

Code of solver

Type
Function returns ShortString
Parameters
   Integer    alg
     Solver number

cfgAlgCreate 

Create solver link object

Type
Function returns Boolean
Parameters
   Integer    alg
     Solver number
  var  Pointer    psl
  const  ShortString    sysDir
     GAMS System Directory
  out  ShortString    msg

cfgAlgFree 

Call solver modifyproblem

Type
Procedure
Parameters
   Integer    alg
     Solver number
  var  Pointer    vpsl

cfgAlgHidden 

Returns true, if alg should be hidden

Type
Function returns Boolean
Parameters
   Integer    alg
     Solver number

cfgAlgLibInfo 

Get link library info for solver

Type
Function returns Integer
Parameters
   Integer    alg
     Solver number
  out  ShortString    name
  out  ShortString    prefix

cfgAlgModifyProblem 

Call solver modifyproblem

Type
Function returns Integer
Parameters
   Integer    alg
     Solver number
   Pointer    psl

cfgAlgName 

Name of solver

Type
Function returns ShortString
Parameters
   Integer    alg
     Solver number

cfgAlgNumber 

Number of solver

Type
Function returns Integer
Parameters
  const  ShortString    id
     Solver name

cfgAlgReadyAPI 

Call solver readyapi

Type
Function returns Integer
Parameters
   Integer    alg
     Solver number
   Pointer    psl
   Pointer    gmo

cfgAlgThreadSafeIndic 

Get thread safety indicator for solver

Type
Function returns Integer
Parameters
   Integer    alg
     Solver number

cfgDefaultAlg 

Number of default solver for model type proc

Type
Function returns Integer
Parameters
   Integer    proc
     Model type number

cfgDefFileName 

Gives name of definition file for given solver (Returns true on success, false in case of problem)

Type
Function returns Boolean
Parameters
  const  ShortString    id
     Solver name
  out  ShortString    defFileName
     Name of definition file

cfgGetMsg 

Pending messages

Type
Function returns ShortString

cfgModelTypeName 

Modeltype name

Type
Function returns ShortString
Parameters
   Integer    proc
     Model type number

cfgModelTypeNumber 

Modeltype number

Type
Function returns Integer
Parameters
  const  ShortString    id
     Solver name

cfgNumAlgs 

Number of solvers

Type
Function returns Integer

cfgNumMsg 

Number of pending messages

Type
Function returns Integer

cfgReadConfig 

Read GAMS configuration file

Type
Function returns Integer
Parameters
  const  ShortString    filename
     Configuration file name

cfgReadConfigGUC 

Read GAMS configuration file plus gamsconfig.yaml

Type
Function returns Integer
Parameters
  const  ShortString    filename
     Configuration file name
  const  ShortString    sysDir
     GAMS System Directory