GAMS [ Home | Downloads | Documentation | Solvers | APIs | Tools | Model Libraries | Resources | Sales | Support | Contact Us | Search ]

The GAMS Call

The entire GAMS system appears to the user as a single call that reads the input files and produces output files. Several options are available at this level to customize the GAMS run and define the output desired. Although details will vary with the type of computer and operating system used, the general operating principles are the same on all machines.

The Generic 'no frills' GAMS Call

The simplest way to start GAMS is to enter the command

> gams myfile

from the system prompt and GAMS will compile and execute the GAMS statements in the file myfile. If a file with this name cannot be found, GAMS will look for a file with the extended name myfile.gms. The output will be written by default on the file myfile.lst. For example, the following statement compiles and executes the example problem [TRNSPORT] from the GAMS model library,

> gams trnsport

The output goes by default to the file trnsport.lst.

Specifying Options through the Command Line

GAMS allows for certain options to be passed through the command line. The syntax of the simple GAMS call described in Section List of Command Line Parameters is extended to look as follows,

> gams myfile key1=value1, key2=value2, ...

where key1 is the name of the option that is being set on the command line, and value1 is the value to which the option is set. Depending on the option, value1 could be a character string, an integer number or a real number. For example, consider the following commands to run [TRNSPORT] from the GAMS model library,

gams trnsport  o myrun.lst lo 2
gams trnsport -o myrun.lst -lo 2
gams trnsport  o=myrun.lst lo=2
gams trnsport -o=myrun.lst -lo=2

All the four commands above are equivalent, and each directs the output listing to the file myrun.lst. o is the name of the option, and it is set to myrun.lst. In addition, in each case, the log of the run is redirected to the file trnsport.log.

List of Command Line Parameters

The folowing sections briefly describes the various options in each of the categories. Section Detailed Description of Command Line Parameters contains a reference list of all options available through the command line with detailed description for each.

General options

Option Description Default
Action GAMS processing requests CE
AppendExpand Expand file append option 1
AppendLog Log file append option 0
AppendOut Output file append option 0
AsyncSolLst Print solution listing when asynchronous solve (Grid or Threads) is used 0
Case Output case option for LST file 0
CErr Compile time error limit 0
CharSet Character set flag 1
CurDir Current directory
DFormat Date format 0
DumpOpt Writes preprocessed input to the file input.dmp 0
DumpParms GAMS parameter logging 0
DumpParmsLogPrefix Prefix of lines triggered by DumpParms>1 ***
EolOnly Single key-value pairs (immediate switch) 0
ErrMsg Placing of compilation error messages 0
ErrNam Name of error message file
Error Force a compilation error with message
ErrorLog Max error message lines written to the log for each error 0
ETLim Elapsed time limit in seconds
ExecErr Execution time error limit 0
ExecMode Limits on external programs that are allowed to be executed 0
Expand Expanded (include) input file name
FDDelta Step size for finite differences 1.000000000000000E-5
FDOpt Options for finite differences 0
FErr Alternative error message file
FileCase Casing of new file names (put, gdx, ref etc.) 0
FileStem Sets the file stem for output files which use the input file name as stem by default <input file basename>
ForceWork Force newer GAMS systems to translate and read save files generated by older systems 0
ForLim GAMS looping limit maxint
FSave Force workfile save 0
G205 Use GAMS version 2.05 syntax 0
GDX Gams data exchange file name
gdxCompress Compression of generated gdx file 0
gdxConvert Version of gdx files generated (for backward compatibility) v7
gdxUels Unload UELs to GDX either squeezed or full squeezed
GridDir Grid file directory Scratch directory
GridScript Grid submission script gmsgrid
HeapLimit Maximum Heap size allowed in MB
IDE Integrated Development Environment flavor 0
Input Input file Filename
InputDir Input file directories
InputDir1 Input file directory number N
InputDir10 Input file directory number N
InputDir11 Input file directory number N
InputDir12 Input file directory number N
InputDir13 Input file directory number N
InputDir14 Input file directory number N
InputDir15 Input file directory number N
InputDir16 Input file directory number N
InputDir17 Input file directory number N
InputDir18 Input file directory number N
InputDir19 Input file directory number N
InputDir2 Input file directory number N
InputDir20 Input file directory number N
InputDir21 Input file directory number N
InputDir22 Input file directory number N
InputDir23 Input file directory number N
InputDir24 Input file directory number N
InputDir25 Input file directory number N
InputDir26 Input file directory number N
InputDir27 Input file directory number N
InputDir28 Input file directory number N
InputDir29 Input file directory number N
InputDir3 Input file directory number N
InputDir30 Input file directory number N
InputDir31 Input file directory number N
InputDir32 Input file directory number N
InputDir33 Input file directory number N
InputDir34 Input file directory number N
InputDir35 Input file directory number N
InputDir36 Input file directory number N
InputDir37 Input file directory number N
InputDir38 Input file directory number N
InputDir39 Input file directory number N
InputDir4 Input file directory number N
InputDir40 Input file directory number N
InputDir5 Input file directory number N
InputDir6 Input file directory number N
InputDir7 Input file directory number N
InputDir8 Input file directory number N
InputDir9 Input file directory number N
InteractiveSolver Allow solver to interact via command line 0
JobTrace Job trace string to be written to the trace file at the end of a Gams job
Keep Toggles keep of process dir and scratch files 0
LibIncDir LibInclude directory <GAMS System Directory>/inclib
License Use alternative license file <GAMS System Directory>/gamslice.txt
LogFile Log file name <input file basename>.log
LogLine Amount of line tracing to the log file 2
LogOption Log option 1
MaxProcDir Maximum number of 225* process directories 700
MCPRHoldfx Print list of rows that are perpendicular to variables removed due to the holdfixed setting 0
MultiPass Multipass facility 0
NoNewVarEqu Triggers a compilation error when new equations or variable symbols are introduced 0
On115 Generate errors for unknown unique element in an equation 0
Output Output file <input file basename>.lst
PageContr Output file page control option 3
PageSize Output file page size (=0 no paging) 58
PageWidth Output file page width 255
ParmFile Command Line Parameter include file
PLicense Privacy license file name
PrefixLoadPath Prepend GAMS system directory to library load path (this is ignored for Windows and AIX) 0
ProcDir Process Directory 225a, 225b, ...
Profile Execution profiling 0
ProfileFile Write profile information to this file
ProfileTol Minimum time a statement must use to appear in profile generated output 0.00
PutDir Put file directory Working directory
Reference Symbol reference file
Restart Restart file
RestartNamed Provide names from another matching restart file
Save Save file
SaveObfuscate Obfuscated save file
ScrDir Scratch directory Process directory
ScrExt Scratch extension to be used with temporary files dat
ScrNam Work file names stem
Seed Random number seed 3141
StepSum Summary of computing resources used by job steps 0
strictSingleton Error if assignment to singleton set has multiple elements 1
StringChk String substitution options 0
Suppress Compiler listing option 0
Symbol Symbol table file
SymPrefix Prefix all symbols encountered during compilation in save file
Sys10 Changes rpower to ipower when the exponent is constant and within e-12 of an integer 0
Sys11 Dynamic resorting if indices in assignment/data statements are not in natural order 0
Sys15 Automatic switching of data structures used in search records 0
Sys16 Disable search record memory (aka execute this as pre-GAMS 24.5) 0
Sys17 Disable sparsity trees growing with permutation (aka execute this as pre-GAMS 24.5) 0
SysDir GAMS system directory where GAMS executables reside
SysIncDir SysInclude directory GAMS system directory
TabIn Tab spacing 8
TFormat Time format 0
ThreadsAsync Number of threads to be used for asynchronous solve (SolveLink=6) -1
Timer Instruction timer threshold in milli seconds 0
Trace Trace file name
TraceLevel Solvestat threshold used in conjunction with a=GT 0
TraceOpt Trace file format option 0
User1 User string N
User2 User string N
User3 User string N
User4 User string N
User5 User string N
Warnings Number of warnings permitted before a run terminates maxint
WorkDir Working directory Current directory
XSave Write compressed save file
XSaveObfuscate Write compressed obfuscated save file
ZeroRes The results of certain operations will be set to zero if abs(result) LE ZeroRes 0.00
ZeroResRep Report underflow as a warning when abs(results) LE ZeroRes and result set to zero 0

Solver related options

Option Description Default
Bratio Basis acceptance threshold 0.25
CNS Constrained Nonlinear Systems - default solver
DNLP Non-Linear Programming with Discontinuous Derivatives - default solver
DomLim Domain violation limit solver default 0
EMP Extended Mathematical Programs - default solver
ForceOptFile Overwrites other option file section mechanism 0
HoldFixed Treat fixed variables as constants 0
Integer1 Integer communication cell N
Integer2 Integer communication cell N
Integer3 Integer communication cell N
Integer4 Integer communication cell N
Integer5 Integer communication cell N
IntVarUp Set default upper bound on integer variables 1
IterLim Iteration limit of solver 2000000000
LimCol Maximum number of columns listed in one variable block 3
LimRow Maximum number of rows listed in one equation block 3
LP Linear Programming - default solver
MCP Mixed Complementarity Problems - default solver
MINLP Mixed-Integer Non-Linear Programming - default solver
MIP Mixed-Integer Programming - default solver
MIQCP Mixed Integer Quadratically Constrained Programs - default solver
MPEC Mathematical Programs with Equilibrium Constraints - default solver
NLP Non-Linear Programming - default solver
NodLim Node limit in branch and bound tree 0
OptCA Absolute Optimality criterion solver default 0.00
OptCR Relative Optimality criterion solver default 0.10
OptDir Option file directory
OptFile Default option file 0
QCP Quadratically Constrained Programs - default solver
ResLim Wall-clock time limit for solver 1000.00
RMINLP Relaxed Mixed-Integer Non-Linear Programming - default solver
RMIP Relaxed Mixed-Integer Programming - default solver
RMIQCP Relaxed Mixed Integer Quadratically Constrained Programs - default solver
RMPEC Relaxed Mathematical Programs with Equilibrium Constraints - default solver
SavePoint Save solver point in GDX file 0
ScriptExit Program or script to be executed at the end of a GAMS run
ScriptFrst First line to be written to GAMSNEXT file.
ScriptNext Script mailbox file name (GAMSNEXT) gamsnext
SolPrint Solution report print option 1
SolveLink Solver link option 0
Solver Default solver for all model types that the solver is capable to process
SolverCntr Solver control file name
SolverDict Solver dictionary file name
SolverInst Solver instruction file name
SolverMatr Solver matrix file name
SolverSolu Solver solution file name
SolverStat Solver status file name
SubSys Name of subsystem configuration file gmscmpnt.txt (Win), gmscmpun.txt (Unix)
SysOut Solver Status file reporting option 0
Threads Number of threads to be used by a solver 1
WorkFactor Memory Estimate multiplier for some solvers 1.00
WorkSpace Work space for some solvers in MB

Detailed Description of Command Line Parameters

This section describes each of the command line parameters in detail. These parameters are in alphabetical order for easy reference. In each of the following options, an abbreviation and the default value, if available, are bracketed.

Action (string): GAMS processing requests

Synonym: A

GAMS currently processes the input file in multiple passes. The three passes in order are:

  • Compilation During this pass, the file is compiled, and syntax errors are checked for. Data initialization statements like scalar, parameter, and table statements are also processed during this stage.
  • Execution During this stage, all assignment statements are executed.
  • Model Generation During this stage, the variables and equations involved in the model being solved are generated.

Default: CE

valuemeaning
R Restart After Solve
C CompileOnly
E ExecuteOnly
CE Compile and Execute
G Glue Code Generation
GT Trace Report

AppendExpand (integer): Expand file append option

Synonym: AE

This option controls the manner of file opening of the Expand.

Default: 1

valuemeaning
0 reset expand file
1 append to expand file

AppendLog (integer): Log file append option

Synonym: AL

This option is used in conjunction with the lo=2 setting where the log from the GAMS run is redirected to a file. Setting this option to 1 will ensure that the log file is appended to and not rewritten.

Default: 0

valuemeaning
0 reset log file
1 append to logfile

AppendOut (integer): Output file append option

Synonym: AO

Setting this option to 1 will ensure that the listing file is appended to and not rewritten.

Default: 0

valuemeaning
0 reset listing file
1 append to listing file

AsyncSolLst (integer): Print solution listing when asynchronous solve (Grid or Threads) is used

Default: 0

valuemeaning
0 Do not print solution listing into lst file for asynchronous solves
1 Print solution listing into lst file for asynchronous solves

Bratio (real): Basis acceptance threshold

The value specified for bratio causes a basis to be discarded if the number of basic variables is smaller than bratio times the number of equations.

Certain (pivotal) solution procedures can restart from an advanced basis that is constructed automatically. This option is used to specify whether or not basis information (probably from an earlier solve) is used. The use of this basis is rejected if the number of basic variables is smaller than bratio times the size of the basis. Setting bratio to 1 will cause all existing basis information to be discarded, which is sometimes needed with nonlinear problems. A bratio of 0 accepts any basis, and a bratio of 1 always rejects the basis. Setting bratio to 0 forces GAMS to construct a basis using whatever information is available. If bratio has been set to 0 and there was no previous solve, an all slack (sometimes called all logical) basis will be provided. This option is not useful for MIP solvers.

Range: [0, 1]

Default: 0.25

Case (integer): Output case option for LST file

Default: 0

valuemeaning
0 write listing file in mixed case
1 write listing file in upper case only

CErr (integer): Compile time error limit

The compilation will be aborted after n errors have occurred. By default, there is no error limit and GAMS compiles the entire input file and collects all the compilation errors that occur. If the file is too long and the compilation process is time consuming, cerr could be used to set to a low value while debugging the input file.

0no compile time error limit
nstop after n compile time errors

Default: 0

valuemeaning
0 no error limit (default)
n stop after n errors

CharSet (integer): Character set flag

Default: 1

valuemeaning
0 use limited GAMS characters set
1 accept any character in comments and text items (foreign language characters)

CNS (string): Constrained Nonlinear Systems - default solver

CurDir (string): Current directory

Synonym: CDir

This option sets the current directory. It is useful when GAMS is called from an external system like Visual Basic. If not specified, it will be set to the directory the GAMS module is called from.

DFormat (integer): Date format

Synonym: DF

This option controls the date format in the listing file. The three date formats correspond to the various conventions used around the world. For example, the date December 2, 1996 will be written as 12/02/96 with the default df value of 0, as 02.12.96 with df=1, and as 96-12-02 with df=2.

Default: 0

valuemeaning
0 date as mm/dd/yy
1 date as dd.mm.yy
2 date as yy-mm-dy

DNLP (string): Non-Linear Programming with Discontinuous Derivatives - default solver

DomLim (integer): Domain violation limit solver default

This controls the maximum number of domain errors (undefined operations like division by zero) a nonlinear solver will perform, while calculating function and derivative values, before it terminates the run return solver status 5 EVALUATION ERROR LIMIT. Nonlinear solvers have difficulty recovering after attempting an undefined operation. Note, that some solvers operate in a mode where trial function evaluations are performed; these solvers will not move to points at which evaluation errors occur, so the evaluation errors at trial points are not counted against the limit.

Default: 0

DumpOpt (integer): Writes preprocessed input to the file input.dmp

This option creates a GAMS file of input that will reproduce results encapsulating all include files into one GAMS file. If activated a file will be written containing GAMS source code for the entire problem. The file name is the input file name plus the extension dmp

To illustrate the use of the dumpopt option, [TRNSPORT] has been split into two files. The first file (say trans1.gms) contains most of the original file except for the solve statement, and looks as follows,

sets
i canning plants / seattle, san-diego /
j markets / new-york, chicago, topeka / ;
parameters
a(i) capacity of plant i in cases
/ seattle 350
san-diego 600 /
b(j) demand at market j in cases
/ new-york 325
chicago 300
topeka 275 / ;
table d(i,j) distance in thousands of miles
new-york chicago topeka
seattle 2.5 1.7 1.8
san-diego 2.5 1.8 1.4 ;
scalar f freight in dollars per case per thousand miles /90/ ;
parameter c(i,j) transport cost in thousands of dollars per case ;
c(i,j) = f * d(i,j) / 1000 ;
variables
x(i,j) shipment quantities in cases
z total transportation costs in thousands of dollars ;
positive variable x ;
equations
cost define objective function
supply(i) observe supply limit at plant i
demand(j) satisfy demand at market j ;
cost .. z =e= sum((i,j), c(i,j)*x(i,j)) ;
supply(i) .. sum(j, x(i,j)) =l= a(i) ;
demand(j) .. sum(i, x(i,j)) =g= b(j) ;
model transport /all/ ;

All comments have been removed from [TRNSPORT] for brevity. Running this model and saving the work files through the save parameter leads to the generation of eight work files. The second file (say trans2.gms) generated from [TRNSPORT] looks as follows,

solve transport using lp minimizing z ;
display x.l, x.m ;

One can then run trans2.gms restarting from the saved work files generated from running trans1.gms. The result obtained is equivalent to running [TRNSPORT].

Attention
In order to use the dumpopt parameter effectively, it is required that the first line in the restart file is the solve statement.

To illustrate the use of the dumpopt option, run the second model using the following command

gams trans2 r=trans dumpopt=1

where trans is the name of the saved files generated through the save parameter from trans1.gms. A new file trans2.dmp is created as a result of this call, and looks as follows,

* This file was written with DUMPOPT=1 at 11/30/11 08:43:06
*
* INPUT = C:\Fred\GAMS options\test\trnsport2.gms
* DUMP = C:\Fred\GAMS options\test\trnsport2.dmp
* RESTART = C:\Fred\GAMS options\test\trans1.g0?
*
* with time stamp of 11/30/11 08:40:41
*
* You may have to edit this file and the input file.
* There are 5 labels
Set WorkFileLabelOrder dummy set to establish the proper order /
seattle,san-diego,new-york,chicago,topeka /;
Model transport;
Variable z total transportation costs in thousands of dollars;
Set i(*) canning plants /
seattle,san-diego /
Set j(*) markets /
new-york,chicago,topeka /
Parameter c(i,j) transport cost in thousands of dollars per case /
seattle.new-york 0.225,seattle.chicago 0.153,seattle.topeka 0.162,
san-diego.new-york 0.225,san-diego.chicago 0.162,san-diego.topeka 0.126 /
Positive Variable x(i,j) shipment quantities in cases;
Parameter a(i) capacity of plant i in cases /
seattle 350,san-diego 600 /
Parameter b(j) demand at market j in cases /
new-york 325,chicago 300,topeka 275 /
Equation demand(j) satisfy demand at market j;
Equation supply(i) observe supply limit at plant i;
Equation cost define objective function;
* *** EDITS FOR INPUT FILE ***
*** END OF DUMP ***

Note that all the data entering the model in the solve statement has been regenerated. The parameter d has not been regenerated since it does not appear in the model, but the parameter c is. Changing the value of the parameter dumpopt will result in alternate names being used for the identifiers in the regenerated file.

Default: 0

valuemeaning
0 no dumpfile
1 extract referenced data from the restart file using original set element names
2 extract referenced data from the restart file using new set element names
3 extract referenced data from the restart file using new set element names and drop symbol text
4 extract referenced symbol declarations from the restart file
11 write processed input file without comments
21 write processed input file with all comments

DumpParms (integer): GAMS parameter logging

Synonym: DP

This keyword provides more detailed information about the parameters changed or set by the user, GAMS or the IDE during the current run.

Note that with dp=2, all the file operations are listed including the full path of each file on which any operation is performed.

Default: 0

valuemeaning
0 no logging
1 lists accepted/set parameters
2 log of file operations plus list of accepted/set parameters

DumpParmsLogPrefix (string): Prefix of lines triggered by DumpParms>1

Synonym: DPLP

Default: ***

EMP (string): Extended Mathematical Programs - default solver

EolOnly (integer): Single key-value pairs (immediate switch)

Synonym: EY

This keyword controls formatting of parameters on the command line and is useful in conjunction with the parmfile parameter.

By default, any number of keyword-value pairs can be present on the same line. This parameter is an immediate switch that forces only one keyword-value pair to be read on a line. If there are more than one such pairs on a line, then this option will force only the first pair to be read while all the other pairs are ignored.

Default: 0

valuemeaning
0 any number of keys or values
1 only one key-value pair on a line

ErrMsg (integer): Placing of compilation error messages

This option controls the location in the listing file of the messages explaining the compilation errors To illustrate the option, consider the following slice of GAMS code:

set i /1*10/ ; set j(i) /10*11/;
parameter a(jj) / 12 25.0 / ;

The listing file that results from running this model contains the following section,

1 set i /1*10/ ; set j(i) /10*11/;
**** $170
2 parameter a(jj) / 12 25.0 / ;
**** $120
3
120 Unknown identifier entered as set
170 Domain violation for element
**** 2 ERROR(S) 0 WARNING(S)

Note that numbers ($170 and $120) flag the two errors as they occur, but the errors are explained only at the end of the source listing. However, if the code is run using the option errmsg=1, the resulting listing file contains the following,

1 set i /1*10/ ; set j(i) /10*11/;
**** $170
**** 170 Domain violation for element
2 parameter a(jj) / 12 25.0 / ;
**** $120
**** 120 Unknown identifier entered as set
3
**** 2 ERROR(S) 0 WARNING(S)

Note that the explanation for each error is provided immediately following the error marker.

Default: 0

valuemeaning
0 Place error messages at the end of compiler listing
1 Place error messages immediately following the line with the error
2 Suppress error messages

ErrNam (string): Name of error message file

Used to change the name GAMSERRS.TXT. The name text will be used as is.

Error (string): Force a compilation error with message

Forces a parameter error with given message string. This option is useful if one needs to incorporate GAMS within another batch file and need to have control over the conditions when GAMS is called. To illustrate the use of the error option, the default GAMS log file from running a model with the option error=hullo.

*** ERROR = hullo
*** Status: Terminated due to parameter errors
--- Erasing scratch files
Exit code = 6

ErrorLog (integer): Max error message lines written to the log for each error

Synonym: ER

0write no error messages to the log file
nwrite up to n error message per error to the log file

Under The IDE, the default is reset to 99.

Default: 0

valuemeaning
0 no error messages to LOG file
n Number of lines for each error that will be written to LOG file

ETLim (real): Elapsed time limit in seconds

Synonym: ETL

This option controls the time limit for a GAMS job. The system will terminate with a compilation or execution error if the limit is reached. A GAMS job will terminate if the elapsed time in seconds exceeds the value of Etlim.

Default:

ExecErr (integer): Execution time error limit

Entering or processing a solve statement with more than execerr errors will abort.

0no executiom time errors allowed
nstop after n execution time errors

Default: 0

valuemeaning
0 no errors allowed limit
n max number allowed

ExecMode (integer): Limits on external programs that are allowed to be executed

A higher value denote a more restrictive alternative. If the restriction level n is chosen, then the restriction levels less than n are also active. For example, if restriction level 3 is chosen, then restrictions 2 and 1 apply also.

Default: 0

valuemeaning
0 everything allowed
1 interactive shells in $call and execute commands are prohibited
2 all $call and execute commands are prohibited
3 $echo or put commands can only write to directories in or below the working or scratchdir
4 $echo and put commands are not allowed

Expand (string): Expanded (include) input file name

Synonym: EF

The expand parameter generates a file that contains information about all the input files processed during a particular compilation. The names of the inTput files are composed by completing the name with the current directory. The following example illustrates the use of the expand parameter. Consider the following slice of code,

parameter a ; a = 0 ;
$include file2.inc
$include file2.inc

The content of the include file file2.inc is shown below,

a = a+1 ;
display a ;

Running the model with the command line flag expand myfile.fil results in the creation of the file myfile.fil. The content of this file is provided below,

1 INPUT 0 0 0 1 7 E:\TEMP\FILE1.GMS
2 INCLUDE 1 1 2 2 4 E:\TEMP\FILE2.INC
3 INCLUDE 1 1 3 5 7 E:\TEMP\FILE2.INC

The first row always refers the parent file called by the GAMS call. The first column gives the sequence number of the input files encountered. The second column refers to the type of file being referenced. The various types of files are

0    INPUT
1    INCLUDE
2    BATINCLUDE
3    LIBINCLUDE
4    SYSINCLUDE

The third column provides the sequence number of the parent file for the file being referenced. The fifth column gives the local line number in the parent file where the $include appeared. The sixth column gives the global (expanded) line number which contained the $include statement. The seventh column provides the total number of lines in the file after it is processed. The eighth and last column provides the name of the file.

FDDelta (real): Step size for finite differences

Range: [1.000000000000000E-9, 1]

Default: 1.000000000000000E-5

FDOpt (integer): Options for finite differences

Default: 0

valuemeaning
0 All derivatives analytically, for numerical Hessian use gradient values, scale delta
1 All derivatives analytically, for numerical Hessian use function values, scale delta
2 Gradient analytically, force Hessian numerically using gradient values, scale delta
3 Gradient analytically, force Hessian numerically using function values, scale delta
4 Force gradient and Hessian numerically, scale delta
10 Same as 0, but no scale of delta
11 Same as 1, but no scale of delta
12 Same as 2, but no scale of delta
13 Same as 3, but no scale of delta
14 Same as 4, but no scale of delta

FErr (string): Alternative error message file

Redirects compilation error messages to a file and names the file. Instructs GAMS to write error messages into a file. Completing the name with the scratch directory and the scratch extension composes the file name. The default is no compilation error messages. This option can be used when GAMS is being integrated into other environments like Visual Basic. The error messages that are reported in the listing file can be extracted through this option and their display can be controlled from the environment that is calling GAMS.

To illustrate the option, consider the following slice of GAMS code used to explain the errmsg option. Calling GAMS on this code with ferr=myfile.err, will result in a file called myfile.err being created in the scratch directory. This file contains the following lines:

0 0 0 0 D:\GAMS\NEW.LST
1 1 170 31 D:\GAMS\NEW.GMS
2 2 120 14 D:\GAMS\NEW.GMS

The first column refers to the global row number of the error in the listing file. The second column refers to the row number of the error in the individual file where the problem occurs. This will be different from the first column only if the error occurs in an include file. In this case, the second column will contain the line number in the include file where the error occurs, while the first number will contain the global line number (as reported in the listing file) where the error occurs. The number in the third column refers to the error number of the error. The fourth number refers to the column number of the error in the source file. The fifth column contains the individual file in which the error occurred.

FileCase (integer): Casing of new file names (put, gdx, ref etc.)

This option allows one to alter the file name casing GAMS uses in saving put, gdx, ref etc. files. It only works with new file names but for example it won't create trnsport.REF if TRNSPORT.ref already exists.

Default: 0

valuemeaning
0 causes GAMS to use default casing
1 causes GAMS to uppercase filenames
2 causes GAMS to lowercase filenames

FileStem (string): Sets the file stem for output files which use the input file name as stem by default

Sets the base of the file name for all output files which use the input file name as base by default (as long as those names are not set explicitly). In particular, the following files can be set by fileStem: dump file (see DumpOpt), GDX file (if GDX was set to default), log file (see LogFile), lst file (see Output), reference file (if Reference was set to default), and trace summary file.

Default: <input file basename>

ForceOptFile (integer): Overwrites other option file section mechanism

Default: 0

ForceWork (integer): Force newer GAMS systems to translate and read save files generated by older systems

Synonym: FW

Most of the work files generated by GAMS using the save option are in binary format. The information inside these files will change from version to version. Every attempt is made to be backward compatible and ensure that all new GAMS systems are ablse to read save files generated by older GAMS systems. However, at certain versions, we are forced to concede default incompatibility (regarding save files, not source files) in order to protect efficiency. The forcework option is used to force newer GAMS systems into translating and reading save files generated by older systems.

Default: 0

valuemeaning
0 no translation
1 try translation

ForLim (integer): GAMS looping limit

Specifies tthe maximum number of allowable executions of control structures involving a For, While or Repeat before GAMS signals an execution error and terminates the control structure.

Default: maxint

FSave (integer): Force workfile save

This option allows to save a file even in the face of execution or other errors. How it works depends on the Save option.

The option value 1 is mainly used by solvers that can be interrupted from the terminal.

Default: 0

valuemeaning
0 workfile only written to file specified by SAVE if no errors occur
1 workfile always written to file specified by SAVE or if SAVE is not present to a name made up by GAMS

G205 (integer): Use GAMS version 2.05 syntax

This option sets the level of the GAMS syntax. This is mainly used for backward compatibility. New key words have been introduced in the GAMS language since Release 2.05. Models developed earlier that use identifiers that have since become keywords will cause errors when run with the latest version of GAMS. This option will allow one to run such models.

For example, the word if is a key word in GAMS introduced with the first version of Release 2.25. Setting the g205=1 option allows if to be used as an identifier since it was not a keyword in Release 2.05. As another example, the word for is a key word in GAMS introduced with the later versions of Release 2.25. Setting the g205=2 option allows for to be used as an identifier since it was not a keyword in the first version of Release 2.25.

Attention
Using values of 1 or 2 for g205 will not permit the use of enhancements to the language introduced in the later versions.

Default: 0

valuemeaning
0 use only latest syntax
1 allow version 2.05 syntax only
2 allow version 2.25 syntax only

GDX (string): Gams data exchange file name

This option specifies the name of the GAMS data exchange file and causes such a file (a GDX file) to be written containing all data in the model at the end of the job. Setting gdx to the string 'default' causes GAMS to create a gdx file with the gms file root name and a gdx extension. Thus gams trnsport with gdx=default will cause GAMS to write the gdx file trnsport.gdx.

gdxCompress (integer): Compression of generated gdx file

This option specifies whether the files are compressed or not.

Default: 0

valuemeaning
0 do not compress gdx files
1 compress gdx files

gdxConvert (string): Version of gdx files generated (for backward compatibility)

This option specifies in which format the gdx files will be written.

Default: v7

valuemeaning
v5 version 5 gdx file, does not support compression
v6 version 6 gdx file
v7 version 7 gdx file

gdxUels (string): Unload UELs to GDX either squeezed or full

Default: squeezed

valuemeaning
Squeezed write only the UELs to Universe, that are used by the exported symbols
Full write all UELs to Universe

GridDir (string): Grid file directory

Synonym: GDir

This option sets the grid file directory.

Default: Scratch directory

GridScript (string): Grid submission script

Synonym: GScript

This option provides the name of a script file to submit grid computing jobs. If only the file name is given the file is assumed to be located in the system directory. A fully qualified name can be given as well. The script needs to be similar to gmsgrid.cmd on windows machines with arguments giving name and location of the solver executable, the solver control file name and the name of the scratch directory. Advanced knowledge of how GAMS sets up and calls solvers is needed for successful use.

Default: gmsgrid

HeapLimit (real): Maximum Heap size allowed in MB

Synonym: HL

This option allows to limit the amount of memory a GAMS job can use during compilation and execution. If the needed data storage exceeds this limit, the job will be terminate.

Default:

HoldFixed (integer): Treat fixed variables as constants

This option can reduce the problem size by treating fixed variables as constants.

Default: 0

valuemeaning
0 fixed variables are not treated as constants
1 fixed variables are treated as constants

IDE (integer): Integrated Development Environment flavor

The ide option instructs GAMS to write special instructions to the log file that are in turn read by the IDE.

Default: 0

valuemeaning
0 unknown environment
1 runs under GAMS IDE

Input (string): Input file

Synonym: I

Completing the input file name with the current directory composes the final name. If such a file does not exist and the extension was not specified, the standard input extension is attached and a second attempt is made to open an input file.

Default: Filename

InputDir (string): Input file directories

Synonym: IDIR

In general, GAMS searches for input and include files in the current working directory only. This option allows the user to specify additional directories for GAMS to search for include and batinclude files. A maximum of 40 separate directories can be included with the directories separated by Operating System specific symbols. On a PC the separator is a semicolon (;) character, and under Unix it is the colon (:) character. Note that libinclude and sysinclude files are handled differently, and their paths are specified by libincdir and sysincdir.

Consider the following illustration:

gams myfile idir \mydir;\mydir2

The search order for the file myfile (or myfile.gms) and all included files in PC systems is as follows: (1) current directory, (2) directories specified by inputdir (\mydir and \mydir2 directories) in order. Under Unix, the corresponding command is

gams myfile idir \mydir:\mydir2

InputDir1 (string): Input file directory number N

Synonym: IDIR1

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir10 (string): Input file directory number N

Synonym: IDIR10

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir11 (string): Input file directory number N

Synonym: IDIR11

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir12 (string): Input file directory number N

Synonym: IDIR12

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir13 (string): Input file directory number N

Synonym: IDIR13

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir14 (string): Input file directory number N

Synonym: IDIR14

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir15 (string): Input file directory number N

Synonym: IDIR15

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir16 (string): Input file directory number N

Synonym: IDIR16

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir17 (string): Input file directory number N

Synonym: IDIR17

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir18 (string): Input file directory number N

Synonym: IDIR18

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir19 (string): Input file directory number N

Synonym: IDIR19

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir2 (string): Input file directory number N

Synonym: IDIR2

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir20 (string): Input file directory number N

Synonym: IDIR20

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir21 (string): Input file directory number N

Synonym: IDIR21

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir22 (string): Input file directory number N

Synonym: IDIR22

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir23 (string): Input file directory number N

Synonym: IDIR23

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir24 (string): Input file directory number N

Synonym: IDIR24

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir25 (string): Input file directory number N

Synonym: IDIR25

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir26 (string): Input file directory number N

Synonym: IDIR26

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir27 (string): Input file directory number N

Synonym: IDIR27

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir28 (string): Input file directory number N

Synonym: IDIR28

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir29 (string): Input file directory number N

Synonym: IDIR29

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir3 (string): Input file directory number N

Synonym: IDIR3

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir30 (string): Input file directory number N

Synonym: IDIR30

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir31 (string): Input file directory number N

Synonym: IDIR31

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir32 (string): Input file directory number N

Synonym: IDIR32

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir33 (string): Input file directory number N

Synonym: IDIR33

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir34 (string): Input file directory number N

Synonym: IDIR34

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir35 (string): Input file directory number N

Synonym: IDIR35

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir36 (string): Input file directory number N

Synonym: IDIR36

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir37 (string): Input file directory number N

Synonym: IDIR37

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir38 (string): Input file directory number N

Synonym: IDIR38

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir39 (string): Input file directory number N

Synonym: IDIR39

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir4 (string): Input file directory number N

Synonym: IDIR4

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir40 (string): Input file directory number N

Synonym: IDIR40

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir5 (string): Input file directory number N

Synonym: IDIR5

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir6 (string): Input file directory number N

Synonym: IDIR6

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir7 (string): Input file directory number N

Synonym: IDIR7

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir8 (string): Input file directory number N

Synonym: IDIR8

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

InputDir9 (string): Input file directory number N

Synonym: IDIR9

This keyword gives the name of the directories to be searched by GAMS given a file name with number 1 being first then number 2 etc up to 40 when encountering an include or batinclude. Directory names must be listed in a form consistent with the way of indicating directory names on the operating system being employed.

The same information as in inputdir can be transferred to GAMS by entering the individual directories separately. A maximum of 40 directories can be passed on in this manner. The number appended to inputdir is important because the earlier inputdir directories are searched first.

The example used to illustrate the inputdir option can also be equivalently called as

gams myfile idir1 mydir1 idir2 mydir2

Note that the search order in this case is as follows:

  1. current directory
  2. mydir1
  3. mydir2

However, if the command was altered to be

gams myfile idir3 \mydir1 idir2 \mydir2

then the search order is altered to be as follows: Note that the search order in this case is as follows:

  1. current directory
  2. mydir2
  3. mydir1

Note that it is not the order in which they are specified that matters but the number of the inputdir that they have been assigned to.

Integer1 (integer): Integer communication cell N

This integer communication cell that can contain any integer number.

Integer2 (integer): Integer communication cell N

This integer communication cell that can contain any integer number.

Integer3 (integer): Integer communication cell N

This integer communication cell that can contain any integer number.

Integer4 (integer): Integer communication cell N

This integer communication cell that can contain any integer number.

Integer5 (integer): Integer communication cell N

This integer communication cell that can contain any integer number.

InteractiveSolver (integer): Allow solver to interact via command line

Default: 0

valuemeaning
0 Interaction with solvelink 0 is not supported
1 Interaction with solvelink 0 is supported

IntVarUp (integer): Set default upper bound on integer variables

Synonyms: PF4 PoolFree4

Default: 1

valuemeaning
0 set default upper bound for integer variables to +INF
1 pass a value of 100 instead of +INF to the solver as upper bound for integer variables
2 same as 0 but writes a message to the log if the level of an integer variable is greater than 100
3 same as 2 but issues an execution error if the level of an integer variable is greater than 100

IterLim (integer): Iteration limit of solver

This option specifies the maximum number of allowable solver iterations, before the solver terminates the run. If this limit is hit, the solver will terminate and return solver status 2 ITERATION INTERRUPT. It is up to the solver link to decide what it thought of as an "iteration". For LP solvers, iterlim often refers to the number of simplex iterations (i.e., pivots). For a MIP solver, iterlim often refers to the cumulative number of simplex iterations over all solves of LP relaxations. For iterations that iterlim does not apply to (e.g., barrier iterations, major iterations in a nonlinear solver), solver specific options need to be set.

Default: 2000000000

JobTrace (string): Job trace string to be written to the trace file at the end of a Gams job

Synonym: JT

The string is written to the Trace at the end of a GAMS job.

Keep (integer): Toggles keep of process dir and scratch files

This option controls whether or not to keep the process directory, which is where the temporary/scratch files are located unless the scrDir or procDir options are used.

Default: 0

valuemeaning
0 delete process dir
1 keep process dir

LibIncDir (string): LibInclude directory

Synonym: LDIR

Name of the directory to be used by GAMS for libinclude files that do not have a full path specification. An absolute or relative path can be specified. If the ldir option is not set, it will be set to the sub-directory inclib of the GAMS system directory. A relative path is relative to the GAMS System Directory. This option is used to complete a file name for $libinclude.

Attention
  • Unlike idir, additional directories cannot be set with ldir. The string passed will be treated as one directory. Passing additional directories will cause errors.
  • Note that if the ldir parameter is set, the default library include directory is not searched.

Consider the following illustration,

gams myfile ldir mydir

GAMS searches for any referenced $libinclude file in the directory <GAMS System Directory>/mydir.

Default: <GAMS System Directory>/inclib

License (string): Use alternative license file

This option should only be used by advanced users attempting to override internal license information. The file name is used as given. The default license file is gamslice.txt in the GAMS system directory.

Default: <GAMS System Directory>/gamslice.txt

LimCol (integer): Maximum number of columns listed in one variable block

This controls the number of columns that are listed for each variable in the COLUMN LISTING section of the listing file. Specify zero to suppress the COLUMN LISTING altogether.

Default: 3

LimRow (integer): Maximum number of rows listed in one equation block

This controls the number of rows that are listed for each equation in the EQUATION LISTING section of the listing file. Specify zero to suppress the LISTING altogether

Default: 3

LogFile (string): Log file name

Synonym: LF

This option is used in conjunction with the LogOption. If lo is set to 2, then this option will specify the name of the log file name. The name provided by the option is completed using the current directory. If no logfile is given but the value of lo is 2, then the file name will be input file name with the extension .log.

To illustrate the use of the logfile option, run [TRNSPORT] with the options lo=2 and lf=myfile.log. The resulting log file is redirected to myfile.log, and looks as follows:

--- Starting compilation
--- trnsport.gms(69) 3 Mb
--- Starting execution: elapsed 0:00:00.002
--- trnsport.gms(44) 4 Mb
--- Generating LP model transport
--- trnsport.gms(65) 4 Mb
--- 6 rows 7 columns 19 non-zeroes
--- Executing CPLEX: elapsed 0:00:00.007
IBM ILOG CPLEX Jul 14, 2011 23.7.1 WEX 26779.26792 WEI x86_64/MS Windows
Cplex 12.3.0.0
Reading data...
Starting Cplex...
Tried aggregator 1 time.
LP Presolve eliminated 1 rows and 1 columns.
Reduced LP has 5 rows, 6 columns, and 12 nonzeros.
Presolve time = 0.00 sec.
Iteration Dual Objective In Variable Out Variable
1 73.125000 x(seattle.new-york) demand(new-york) slack
2 119.025000 x(seattle.chicago) demand(chicago) slack
3 153.675000 x(san-diego.topeka) demand(topeka) slack
4 153.675000 x(san-diego.new-york) supply(seattle) slack
LP status(1): optimal
Optimal solution found.
Objective : 153.675000
--- Restarting execution
--- trnsport.gms(65) 2 Mb
--- Reading solution for model transport
--- Executing after solve: elapsed 0:00:00.046
--- trnsport.gms(67) 3 Mb
*** Status: Normal completion
--- Job trnsport.gms Stop 11/30/11 05:27:11 elapsed 0:00:00.046

Default: <input file basename>.log

LogLine (integer): Amount of line tracing to the log file

Synonym: LL

This option is used to limit the number of line tracing sent out to the log file during the compilation phase of a GAMS run. Values of 0~and~1 are special. Setting ll=0 will cause the line tracing to be suppressed for all phases of the GAMS processing.

The log file that results from running [TRNSPORT] with the option ll=0 is shown below,

--- Starting compilation
--- Starting execution: elapsed 0:00:00.003
--- Generating LP model transport
--- 6 rows 7 columns 19 non-zeroes
--- Executing CPLEX: elapsed 0:00:00.007
IBM ILOG CPLEX Jul 14, 2011 23.7.1 WEX 26779.26792 WEI x86_64/MS Windows
Cplex 12.3.0.0
Reading data...
Starting Cplex...
Tried aggregator 1 time.
LP Presolve eliminated 1 rows and 1 columns.
Reduced LP has 5 rows, 6 columns, and 12 nonzeros.
Presolve time = 0.00 sec.
Iteration Dual Objective In Variable Out Variable
1 73.125000 x(seattle.new-york) demand(new-york) slack
2 119.025000 x(seattle.chicago) demand(chicago) slack
3 153.675000 x(san-diego.topeka) demand(topeka) slack
4 153.675000 x(san-diego.new-york) supply(seattle) slack
LP status(1): optimal
Optimal solution found.
Objective : 153.675000
--- Restarting execution
--- Reading solution for model transport
--- Executing after solve: elapsed 0:00:00.096
*** Status: Normal completion
--- Job trnsport.gms Stop 11/30/11 05:42:55 elapsed 0:00:00.097

Comparing this output to the one shown in the example of option logfile, one can see that the line numbers are absent from the log file.

Default: 2

valuemeaning
0 no line tracing
1 minimum line tracing
2 automatic and visually pleasing

LogOption (integer): Log option

Synonym: lo

This option controls the location of the output log of a GAMS run. By default, GAMS directs the log of the run to the screen/console. If lo=2, the log is redirected to a file. With lo=3 all the output goes to the standard output. If no file name is provided for the log through the lf option, the file name will be the input file name with the extension .log.

To illustrate the use of the lo option, run [TRNSPORT] To illustrate the use of the lo option, run [TRNSPORT] with the options lo=2. The resulting log file, trnsport.log, looks exactly as shown in the example of option logfile.

Default: 1

valuemeaning
0 no log output
1 log output to screen (console)
2 log output to logfile
3 log output to standard output
4 log output to logfile and standard output

LP (string): Linear Programming - default solver

MaxProcDir (integer): Maximum number of 225* process directories

This option controls the maximum number of workfile directories that can be generated by GAMS. By default they are called 225a, 225b, ..., 225aa, 225ab ...

Default: 700

MCP (string): Mixed Complementarity Problems - default solver

MCPRHoldfx (integer): Print list of rows that are perpendicular to variables removed due to the holdfixed setting

Range: [0, 1]

Default: 0

MINLP (string): Mixed-Integer Non-Linear Programming - default solver

MIP (string): Mixed-Integer Programming - default solver

MIQCP (string): Mixed Integer Quadratically Constrained Programs - default solver

MPEC (string): Mathematical Programs with Equilibrium Constraints - default solver

MultiPass (integer): Multipass facility

Synonym: MP

This keyword tells GAMS whether to use a quick syntax checking compilation facility which does not require all items to be declared. This is useful when a large model is being put together from smaller pieces.

This option allows slices of GAMS code to be independently checked for syntax errors. This option is useful when a large model is being put together from smaller pieces.

Consider the following example,

a(i) = b(i)*5 ;
b(i) = c(j) ;

By default, running a file containing just the two statements shown above results in the following listing file,

1 a(i) = b(i)*5 ;
**** $140$120$140
2 b(i) = c(j) ;
**** $140$120$149
120 Unknown identifier entered as set
140 Unknown symbol
149 Uncontrolled set entered as constant
**** 6 ERROR(S) 0 WARNING(S)

None of the sets i, or j have been defined or initialized, and the identifiers a, b, and c have not been defined. Further, an assignment cannot be made without the right hand side of the assignment being known. In both assignments in the example above, there is no data available for the right hand side. Running the model with the setting mp=1 results in the following listing file,

1 a(i) = b(i)*5 ;
2 b(i) = c(j) ;
**** $149
Error Messages
149 Uncontrolled set entered as constant
**** 1 ERROR(S) 0 WARNING(S)

Note that the statements in the example have now been processed independently of its context. They are now checked only for consistency. GAMS now assumes that sets i and j, as well as the identifiers a, b, and c are defined and, if necessary, initialized elsewhere. The only error that is reported is the inconsistency of indices in the second statement.

Default: 0

valuemeaning
0 standard compilation
1 check-out compilation
2 as 1, and skip $call and ignore missing file errors with $include and $gdxin

NLP (string): Non-Linear Programming - default solver

NodLim (integer): Node limit in branch and bound tree

This option specifies the maximum number of nodes to process in the branch and bound tree search for a MIP problem. If this limit is hit, the solver will terminate and return solver status 4 TERMINATED BY SOLVER. A value of 0 is interpreted as 'not set'.

Default: 0

NoNewVarEqu (integer): Triggers a compilation error when new equations or variable symbols are introduced

Default: 0

valuemeaning
0 AllowNewVarEqu
1 DoNotAllowNewVarEqu

On115 (integer): Generate errors for unknown unique element in an equation

This option generates errors for unknown unique elements in an equation.

Default: 0

valuemeaning
0 No error messages
1 Issue error messages

OptCA (real): Absolute Optimality criterion solver default

This attribute specifies an absolute termination tolerance for a global solver. General problems are often extremely difficult to solve, and proving that a solution found for a nonconvex problem is the best possible can use enormous amounts of resources. The absolute gap is defined to be |PB-DB|, where the primal bound PB is the objective function value of the best feasible solution found thus far and the dual bound DB is the current bound on the problem's optimal value (i.e., lower bound in case of minimization and upper bound in case of maximization). If the absolute gap is no greater than optca, the solver will terminate and return solver status 1 NORMAL COMPLETION and model status 8 INTEGER SOLUTION (for a problem with discrete variables) or 2 LOCAL OPTIMAL or 7 FEASIBLE SOLUTION (for a problem without discrete variables). Note that this is a termination test only; setting this option should not change the global search.

Default: 0.00

OptCR (real): Relative Optimality criterion solver default

This attribute specifies a relative termination tolerance for a global solver. General problems are often extremely difficult to solve, and proving that a solution found for a nonconvex problem is the best possible can use enormous amounts of resources. The precise definition of optcr depends on the solver. GAMS and some solvers use the formula |PB-DB|/max(|PB|,|DB|) to compute the optimality gap, where the primal bound PB is the objective function value of the best feasible solution found thus far and the dual bound DB is the current bound on the problem's optimal value (i.e., lower bound in case of minimization and upper bound in case of maximization). However, also |PB-DB|/|PB| and |PB-DB|/|DB| are commonly used formulas. Different adjustments when the denominator approaches zero or bounds are of different signs are applied. The solver will stop as soon as it has found a feasible solution proven to be within optcr of optimal, that is, the optimality gap falls below optcr.

Default: 0.10

OptDir (string): Option file directory

This keyword gives the name of the directory to be used by GAMS for solver option files. If not specified, it will be set to the current working directory.

OptFile (integer): Default option file

This option initializes the modelname.optfile parameter to the value set. Modelname is the name of the model specified in the model statement. For example, the file myfile contains the slice of GAMS code

model m /all/ ;
solve m using nlp maximizing dollars ;

Consider the following call,

gams myfile optfile=1

The option file that is being used after this assignment is solvername.opt, where solvername is the name of the solver that is specified. For CONOPT, the option file is called conopt.opt; for MINOS, it is minos.opt. The names that you can use are listed in the Solver Manual.

Attention
Setting modelname.optfile in the GAMS input file overrides the value of the optfile parameter passed through the command line.

To allow different option file names for the same solver, the optfile parameter can take other values as well. Formally, the rule is optfile=n will use solvename.opt if n=1, and solvername.opX, solvername.oXX or solvername.XXX, where X's are the characters representing the value of n, for n > 1 and will use no option file at all for n=0. For example, the following optfile values profile the option file names for the CONOPT solver

0    no option file used
1    conopt.opt
2    conopt.op2
26    conopt.o26
345    conopt.345
1234    conopt.1234

Default: 0

valuemeaning
0 no option file will be used
1 the option file solvername.opt will be used
2 the option file solvername.op2 will be used
3 the option file solvername.op3 will be used
15 the option file solvername.o15 will be used
222 the option file solvername.222 will be used
1234 the option file solvername.1234 will be used

Output (string): Output file

Synonym: O

If no name is given, the input file name is combined with the current directory and the standard output file extension (LST) is applied. If the output parameter is given as a file name without an absolute path, using the current directory composes the final name. If the absolute path is included in the file name, then the name is used as given.

Consider the following examples,

gams trnsport
gams trnsport o=trnsport.out
gams trnsport o=c:\test\trnsport.out

The first call will create an output file called trnsport.lst (for PC and Unix platforms) in the current directory. The second call will create a file called trnsport.out in the current directory. The last call will create the file as listed. If the directory c:\test does not exist, GAMS will exit with a parameter error.

Default: <input file basename>.lst

PageContr (integer): Output file page control option

Synonym: PC

This option affects the page control in the listing file.

Default: 3

valuemeaning
0 no page control, with padding
1 FORTRAN style line printer format
2 no page control, no padding
3 Formfeed character for new page

PageSize (integer): Output file page size (=0 no paging)

Synonym: PS

This is the number of lines that are used on a page for printing the listing file. The lower bound is 0 which is interpreted as +inf. That means that everything is printed to one page.

Default: 58

PageWidth (integer): Output file page width

Synonym: PW

This option sets the print width on a page in the listing file with a possible range from 72 to 32767. Note that under the IDE the default is set to 80. If the value is outside the allowed range, the default value will be used.

The option can also be used to specify the pagewidth for the put facility, i.e.

file f /myfile.txt/; put f; f.pw=80;

In this case the range is from 0 to 32767 and if the value is above the range, then it is set to 32767.

Range: [72, 32767]

Default: 255

ParmFile (string): Command Line Parameter include file

Synonym: PF

This option specifies the name of a secondary customization parameter file to use. It is used to augment the command line adding more command line parameters from a file. It is read from the current directory unless a path is specified.

PLicense (string): Privacy license file name

This keyword tells the name of a privacy license file that contains file encryption codes. A full path should be used.

PrefixLoadPath (integer): Prepend GAMS system directory to library load path (this is ignored for Windows and AIX)

Default: 0

valuemeaning
0 Do not set GAMS system directory at beginning of library load path
1 Set GAMS system directory at beginning of library load path

ProcDir (string): Process Directory

This option specifies the name of the process directory. If specified, the directory must already exist and it will not be deleted when GAMS cleans up. By default, the process directory name is chosen automatically from the list 225a, 225b, ..., 225aa, 225ab ..., by skipping over existing entries, and the directory will be deleted during cleanup if the keep option is not used. Very little is written to the process directory, but the scratch directory is used more, and the scrDir option takes it default from the process dir.

Default: 225a, 225b, ...

Profile (integer): Execution profiling

This option initializes the profile option (see The Option Statement) to the value set, and allows the profile of a GAMS run to be printed in the listing file. The profile contains the individual and cumulative time required for the various sections of the GAMS model.

Attention
Setting the profile option through the option statement in the GAMS input file overrides the value of the profile parameter passed through the command line.
0no profiling
1minimum profiling
nprofiling depth for nested control structures

A value of 0 does not cause an execution profile to be generated. A value of 1 reports execution times for each statement and the number of set elements over which the particular statement is executed. A value of 2 reports specific times for statements inside control structures like loops etc. Running [TRNSPORT] with profile=1 provides the following additional information in the listing file,

---- 1 ExecInit 0.000 0.000 SECS 3 Mb
---- 44 Assignment c 0.000 0.000 SECS 4 Mb 6
---- 65 Solve Init transport 0.000 0.000 SECS 4 Mb
---- 57 Equation cost 0.000 0.000 SECS 4 Mb 1
---- 59 Equation supply 0.000 0.000 SECS 4 Mb 2
---- 61 Equation demand 0.000 0.000 SECS 4 Mb 3
---- 65 Solve Fini transport 0.000 0.000 SECS 4 Mb 19
---- 65 GAMS Fini 0.015 0.015 SECS 4 Mb
---- 1 ExecInit 0.000 0.000 SECS 2 Mb
---- 65 Solve Read transport 0.000 0.000 SECS 2 Mb
---- 67 Display 0.000 0.000 SECS 3 Mb
---- 67 GAMS Fini 0.000 0.000 SECS 3 Mb

The first column provides the line number in the input file of the statement being executed. The second column provides the type of statement being executed.

ExecInit denotes the beginning of the execution phase of the GAMS input file.
GAMS Fini denotes the end of this phase.

Note that GAMS finishes processing of an input file as soon as a solve statement is processed, and passes control to the solver being called. After the solver is done, GAMS restarts. This causes two ExecInit GAMS Fini pairs to be generated for [TRNSPORT].

Assignment c denotes an assignment statement involving the identifier c.
Solve Init, Solver Fini are book ends enclosing the generation of the model [TRNSPORT].

Note that only equations are listed, and not variables. This happens because GAMS uses an equation based scheme to generate a model. The third and fourth columns provide the individual time needed to execute the statement, and the cumulative time taken by the GAMS system so far. The last column gives the number of assignments generated in the specified line.

At the end of the log file a profile summary is created which contains (up to) ten of the slowest execution steps. For example such a summary looks like this:

--- Profile Summary (184 records processed)
0.062 3621 GAMS Fini
0.047 3621 Solve Read wsisn
0.046 3529 Equation divcnlsea (86)
0.032 3621 Solve Fini wsisn (39489)
0.016 3274 Assignment wnr (2502)
0.016 3447 Equation cost (15)
0.016 3475 Equation laborc (180)
0.016 3519 Equation waterbaln (180)
0.016 3546 Equation subirrc (84)
0.015 3030 Assignment gwtsa (273)

Note that this summary does not belong to [TRNSPORT] but is more capable for illustration because the summary of [TRNSPORT] is empty.

Default: 0

valuemeaning
0 no profiling
1 minimum profiling
n profiling depth for nested control structures

ProfileFile (string): Write profile information to this file

Synonym: PFILE

This option causes profiling information to be written to a file. Note that profiling information is only created with profile=1 or profile=2. For example such a file looks like this:

1 -1 0.000 0.003 ExecInit
45 6 0.000 0.004 Assignment c
66 -1 0.000 0.004 Solve Init transport
58 1 0.000 0.004 Equation cost
60 2 0.000 0.004 Equation supply
62 3 0.000 0.004 Equation demand
66 19 0.015 0.004 Solve Fini transport
66 -1 0.000 0.004 GAMS Fini
1 -1 0.000 0.002 ExecInit
66 -1 0.000 0.002 Solve Read transport
68 -1 0.000 0.003 Display
68 -1 0.000 0.003 GAMS Fini

ProfileTol (real): Minimum time a statement must use to appear in profile generated output

Synonym: PTOL

This option sets profile tolerance in seconds. All statements that take less time to execute than this tolerance are not reported in the listing file.

Default: 0.00

PutDir (string): Put file directory

Synonym: PDir

This option specifies the directory where the put files are generated and saved. If not specified, it will be set to the working directory. This option does not work if an absolute file name is provided through the file statement.

Default: Working directory

QCP (string): Quadratically Constrained Programs - default solver

Reference (string): Symbol reference file

Synonym: RF

If specified, all symbol references will be written to this file. Setting rf or Reference to the string 'default' causes GAMS to create a reference file with the GMS file root name and a REF extension. Thus gams trnsport with rf=default will cause GAMS to write the reference file trnsport.ref.

ResLim (real): Wall-clock time limit for solver

This option specifies the maximum time in seconds that the solver can run before it terminates and returns the solver status 3 RESOURCE INTERRUPT. The solver should start the clock fairly early, so that time required to read in the problem and do any reformulation, preprocessing, or presolving is included in the time limit. For a multi-threaded solve, the time limit applies to the wall clock time.

Default: 1000.00

Restart (string): Restart file

Synonym: R

Name of a file containing a workfile written by a SAVE command that allows the GAMS program to be restarted. This option provides the name of the save files to restart from. The final name is composed by completing the file name with the current directory and the standard workfile extension. The name provided for the restart file follows the same convention as that of the save file (see command line parameter Save).

RestartNamed (string): Provide names from another matching restart file

Synonym: RN

RMINLP (string): Relaxed Mixed-Integer Non-Linear Programming - default solver

RMIP (string): Relaxed Mixed-Integer Programming - default solver

RMIQCP (string): Relaxed Mixed Integer Quadratically Constrained Programs - default solver

RMPEC (string): Relaxed Mathematical Programs with Equilibrium Constraints - default solver

Save (string): Save file

Synonym: S

This option specifies the name of a workfile to be written that allows the GAMS program to be restarted. The file written is platform independent.

The final name is composed by completing the save file name with the current directory and the standard workfile extension. Eight save files are generated, so the name provided by the user for the save file should be such that GAMS can generate eight names from it. GAMS distinguishes file names from their extensions. If no extension is provided by the user, GAMS adds the extensions g01 through g08 to name the eight saved work files. The presence of a ? character in the save file name is used by GAMS to substitute the numbers 1 through 8 in its place.

The following table illustrates through examples, the generation of names for the save files by GAMS from the name proided through the save parameter.

myfile: myfile.g01, myfile.g02, ..., myfile.g08
myfile?: myfile1.g01, myfile2.g02, ..., myfile8.g08
myfile.00?: myfile.001, myfile.002, ..., myfile.008
myfile?.wrk: myfile1.wrk, myfile2.wrk, ..., myfile8.wrk
myfile?.???: myfile1.111, myfile2.222, ..., myfile8.888
Attention
On Unix platforms the ? character is a special character and may require a backslash character (\) in front of it in order to be interpreted correctly. The name myfile? should be written on this platform as myfile\?.

SaveObfuscate (string): Obfuscated save file

Synonym: SO

SavePoint (integer): Save solver point in GDX file

Synonym: SP

This option tells GAMS to save a point format GDX file that contains the information on the current solution point.

Default: 0

valuemeaning
0 no point gdx file is to be saved
1 a point gdx file from the last solve is to be saved
2 a point gdx file from every solve is to be saved

ScrDir (string): Scratch directory

Synonym: SD

This option specifies the name of the scratch directory. By default, it takes its value from the process directory procDir. Typically the two are the same, so the scratch directory is created and deleted during the GAMS run. If specified, the directory must already exist and will not be cleaned up (i.e. deleted) by GAMS.

The scratch directory is where intermediate files used internally by GAMS are located. The GAMSSolveLink option can be used to reduce or eliminate the need for these files.

Default: Process directory

ScrExt (string): Scratch extension to be used with temporary files

Synonym: SE

This keyword gives the name of the extension for the GAMS temporary files generated during execution.

Default: dat

ScriptExit (string): Program or script to be executed at the end of a GAMS run

By default GAMS does not call an exit script anymore. If this is required, the GAMS parameter ScriptExit has to be set explicitly to the script that should be called after GAMS terminates. An empty template of an exit script can be found in the GAMS system directory (gmsxitnt.cmd (Windows) or gmsxitus.run (Unix)).

ScriptFrst (string): First line to be written to GAMSNEXT file.

Synonym: SF

The default is an empty string and the first line is not written.

ScriptNext (string): Script mailbox file name (GAMSNEXT)

Synonym: SCRIPT

Default: gamsnext

ScrNam (string): Work file names stem

Synonym: SN

Name stem used to complete the names of intermediate work files. This name stem has to have at least one '?'. Name will be completed with the scratch directory and the standard scratch name extension.

Seed (integer): Random number seed

This option specifies the seed used for the pseudo random number generator.

Default: 3141

SolPrint (integer): Solution report print option

This option controls the printing of the model solution to the listing file.

Default: 1

valuemeaning
0 remove solution listings following solves
1 include solution listings following solves
2 suppress all solution information

SolveLink (integer): Solver link option

Synonym: SL

This option controls GAMS function when linking to solve.

Default: 0

valuemeaning
0 GAMS operates as it has for years
1 solver is called from a shell and GAMS remains open
2 solver is called with a spawn (if possible) or a shell (if spawn is not possible) and GAMS remains open
3 GAMS starts the solution and continues in a Grid computing environment
4 GAMS starts the solution and wait (same submission process as 3) in a Grid computing environment
5 the problem is passed to the solver in core without use of temporary files
6 the problem is passed to the solver in core without use of temporary files, GAMS does not wait for the solver to come back
7 the problem is passed to the solver in core without use of temporary files, GAMS waits for the solver to come back but uses same submission process as 6

Solver (string): Default solver for all model types that the solver is capable to process

The command line option solver=abc initializes the default solver for the model types solver abc is capable of to abc. This initialization is done before the default solvers of individual model types are set via command line options. So a command line with lp=conopt solver=bdmlp will first set BDMLP as the default solver for model types LP, RMIP, and MIP (these are the model types BDMLP can handle) and then reset Conopt as the default solver for LP. The order of these parameters on the command line has no impact (i.e. lp=conopt solver=bdmlp behaves identically to solver=bdmlp lp=conopt). If multiple occurrences of option solver appear, the last one sets the option as it is with other options, including LP, MIP, ...

SolverCntr (string): Solver control file name

Synonym: SCNTR

Name completed with scratch directory and scratch extension.

SolverDict (string): Solver dictionary file name

Synonym: SDICT

Name completed with scratch directory and scratch extension.

SolverInst (string): Solver instruction file name

Synonym: SINST

Name completed with scratch directory and scratch extension.

SolverMatr (string): Solver matrix file name

Synonym: SMATR

Name completed with scratch directory and scratch extension.

SolverSolu (string): Solver solution file name

Synonym: SSOLU

Name completed with scratch directory and scratch extension.

SolverStat (string): Solver status file name

Synonym: SSTAT

Name completed with scratch directory and scratch extension.

StepSum (integer): Summary of computing resources used by job steps

This option controls the generation of a step summary of the processing times taken by GAMS during a given run.

To illustrate the use of the stepsum option, the default GAMS listing file from running [TRNSPORT] with the option stepsum=1 contains the following step summaries.

STEP SUMMARY:     0.000       0.000 STARTUP
                  0.000       0.000 COMPILATION
                  0.000       0.000 EXECUTION
                  0.000       0.000 CLOSEDOWN
                  0.000       0.000 TOTAL SECONDS
                  0.008       0.008 ELAPSED SECONDS
                  3.949       3.949 MAX HEAP SIZE (Mb)

STEP SUMMARY:     0.000       0.000 STARTUP
                  0.000       0.000 COMPILATION
                  0.000       0.000 EXECUTION
                  0.000       0.000 CLOSEDOWN
                  0.000       0.000 TOTAL SECONDS
                  0.089       0.096 ELAPSED SECONDS
                  2.884       3.949 MAX HEAP SIZE (Mb)

The first step summary occurs before the model is sent to the solver, and the second occurs after the solver completes its task and returns control back to GAMS. The first column reports time for the individual section of the run, while the second column reports accumulated times including previous sections.

Default: 0

valuemeaning
0 no step summary
1 step summary printed

strictSingleton (integer): Error if assignment to singleton set has multiple elements

This option affects the behavior of a membership assignment to a singleton set. With strictSingleton = 0 GAMS does not complain about an assignment with more than one element on the right hand side but takes the first one. With strictSingleton = 1 such an assignment creates an error.

Default: 1

valuemeaning
0 Take first record if assignment to singleton set has multiple elements
1 Error if assignment to singleton set has multiple elements

StringChk (integer): String substitution options

This option affects the result of the check for %xxx% symbols.

Default: 0

valuemeaning
0 no substitution if symbol undefined and no error
1 error if symbol undefined
2 remove entire symbol reference if undefined and no error

SubSys (string): Name of subsystem configuration file

That file contains solver defaults and other information. This option is only to be used by advanced users attempting to override internal sub-system information.

Default: gmscmpnt.txt (Win), gmscmpun.txt (Unix)

Suppress (integer): Compiler listing option

This option suppresses the echoing of the contents of the input file(s) to the listing file. This parameter is similar in functionality to the $offlisting dollar control option.

Attention
The $offlisting and $onlisting dollar control options effect the listing file only if suppress is set to 0. If suppress is set to 1, the input file(s) is not echoed to the listing file, and these dollar control options have no effect on the listing file.

Default: 0

valuemeaning
0 standard compiler listing
1 suppress compiler listing

Symbol (string): Symbol table file

Writes a partial symbol table to be used in conjunction with reference files.

SymPrefix (string): Prefix all symbols encountered during compilation in save file

Sys10 (integer): Changes rpower to ipower when the exponent is constant and within e-12 of an integer

Default: 0

valuemeaning
0 Disable conversion
1 Enable conversion

Sys11 (integer): Dynamic resorting if indices in assignment/data statements are not in natural order

Speed-up for expressions containing constant indices or indices that are not in the natural order at the cost of increased memory use.

Default: 0

valuemeaning
0 Automatic optimization/restructuring of data
1 no optimization
2 always optimize/restructure

Sys15 (integer): Automatic switching of data structures used in search records

Default: 0

valuemeaning
0 Automatic switching to dense data structures
1 No switching
2 Always switch
1x Print additional information in lst file

Sys16 (integer): Disable search record memory (aka execute this as pre-GAMS 24.5)

Range: [0, 1]

Default: 0

Sys17 (integer): Disable sparsity trees growing with permutation (aka execute this as pre-GAMS 24.5)

Range: [0, 1]

Default: 0

SysDir (string): GAMS system directory where GAMS executables reside

This option sets the GAMS system directory. This option is useful if there are multiple systems installed on the machine, or when GAMS is called from an external system like Visual Basic.

SysIncDir (string): SysInclude directory

Synonym: SDIR

Used to complete a file name for $sysinclude. If the sdir option is not set, the GAMS system directory is searched.

Attention
  • Unlike idir, additional directories cannot be set with sdir. The string passed will be treated as one directory. Passing additional directories will cause errors.
  • Note that if the sdir parameter is set, the default system include directory is not searched.

Consider the following illustration,

gams myfile sdir mydir

GAMS searches for any referenced $sysinclude file in the directory mydir.

Default: GAMS system directory

SysOut (integer): Solver Status file reporting option

This option controls the printing of all solver messages (i.e., the solver status file) to the GAMS listing file. The contents of the solver status file are useful for debugging or to get additional information about a solver run. Normally, only those messages flagged by the solver as destined for the listing file get listed. If the solver crashes or encounters any unexpected difficulties, the contents of the solver status file will be automatically sent to the listing file. sysout exists only as a global option, that is, it can only be set from the command line by using an integer (e.g., sysout=1).

Default: 0

valuemeaning
0 suppress additional solver generated output
1 include additional solver generated output

TabIn (integer): Tab spacing

This option sets the tab spacing. By default, tabs are not allowed in GAMS. However, the most common setting is 8 which results in the positions of the tabs corresponding to columns 1, 9, 17,... and the intermediate columns being replaced by blanks.

0tabs are not allowed (default)
1tabs are replaced by blanks
ntabs are 1, n+1, 2n+1,...

Default: 8

valuemeaning
0 tabs are not allowed
1 tabs are replaced by blanks
n tabs are 1, n+1, 2n+1,.. (default: n=8)

TFormat (integer): Time format

Synonym: TF

This option controls the time format in the listing file. The three date formats correspond to the various conventions used around the world. For example, the time 7:45~PM will be written as 19:45:00 with the default tf value of 0, and as 19.45.00 with tf=1.

Default: 0

valuemeaning
0 time as hh:mm:ss
1 time as hh.mm.ss

Threads (integer): Number of threads to be used by a solver

This option controls the number of threads or CPU cores to be used by a solver. If number is greater than number of available CPU cores it will be reduced to the number of cores available. Use 0 if you want to use all available cores. Use -n if you want to leave n cores free for other tasks.

-nnumber of cores to leave free for other tasks
0use all available cores
nuse n cores (will be reduced to the available number of cores if n is too large)

Default: 1

valuemeaning
0 use number of available cores
n use n threads
minus_n number of cores to leave free for other tasks

ThreadsAsync (integer): Number of threads to be used for asynchronous solve (SolveLink=6)

Default: -1

valuemeaning
0 use number of available cores
n use n threads
minus_n number of cores to leave free for other tasks

Timer (integer): Instruction timer threshold in milli seconds

Only details about internal GAMS intructions that took more than n milli seconds are echoed to the log.

0interpreted as +inf, no details echoed
necho all details about internal GAMS instructions that took more than n milli seconds to the log

Default: 0

valuemeaning
0 interpreted as +inf, no details echoed
n echo all details about internal GAMS instructions that took more than n milli seconds to the log

Trace (string): Trace file name

The tracefile option appends to any previous trace file. If a previous trace file of the same name already exists, then all new data output will be appended. Users should be careful to make sure that all old versions of the trace file are deleted if the same filename is used.

TraceLevel (integer): Solvestat threshold used in conjunction with a=GT

Synonym: TL

Default: 0

TraceOpt (integer): Trace file format option

The trace feature supports several options. Several different types of trace files can be created, depending on what output information is desired. The different trace file options are obtained by specifying traceopt=(integer).

Default: 0

valuemeaning
0 solver and GAMS step trace without headers
1 solver and GAMS step trace
2 solver step trace only
3 trace file format used for GAMS performance world
5 trace file with all available trace fields

User1 (string): User string N

Synonym: U1

This option permits user entry of text for up to 5 user-defined options.

User2 (string): User string N

Synonym: U2

This option permits user entry of text for up to 5 user-defined options.

User3 (string): User string N

Synonym: U3

This option permits user entry of text for up to 5 user-defined options.

User4 (string): User string N

Synonym: U4

This option permits user entry of text for up to 5 user-defined options.

User5 (string): User string N

Synonym: U5

This option permits user entry of text for up to 5 user-defined options.

Warnings (integer): Number of warnings permitted before a run terminates

This option specifies the maximum number of allowable warnings, before the run terminates.

Default: maxint

WorkDir (string): Working directory

Synonym: WDir

This option sets the working directory. This option is useful when GAMS is called from an external system like Visual Basic. If not specified, it will be set to the curdir directory.

Default: Current directory

WorkFactor (real): Memory Estimate multiplier for some solvers

This option tells the solver how much workspace to allocate for problem solution relative to the solver-computed estimate. E.g., setting workfactor=2 doubles the memory estimate. In cases where a solver allocates memory dynamically as it is needed, this option will have no effect. In cases where workfactor and workspace are both specified, the workspace setting takes precedence.

Default: 1.00

WorkSpace (real): Work space for some solvers in MB

This option tells the solver how much workspace in Megabytes to allocate. If not given by the user, the solver can estimate the size. In cases where a solver allocates memory dynamically as it is needed, this option will have no effect, or it may be used as a memory limit. workspace exists only as a model-specific option.

XSave (string): Write compressed save file

Synonym: XS

In older GAMS systems (versions older than 21.7) the name of a save file written in ASCII format so it is platform independent and can be moved to machines with different operating systems, otherwise like save. In GAMS systems from release 22.3 and newer it causes writing of compressed save files.

XSaveObfuscate (string): Write compressed obfuscated save file

Synonym: XSO

ZeroRes (real): The results of certain operations will be set to zero if abs(result) LE ZeroRes

This option specifies the threshold value for internal rounding to zero in certain operations.

Default: 0.00

ZeroResRep (integer): Report underflow as a warning when abs(results) LE ZeroRes and result set to zero

This option causes GAMS to issue warnings whenever a rounding occurs because of zerores.

Default: 0

valuemeaning
0 no warning when a rounding occurs because of ZeroRes
1 issue warnings whenever a rounding occurs because of ZeroRes