Loading...
Searching...
No Matches
gamsenum.h
1/*
2 * GAMS - General Algebraic Modeling System C++ API
3 *
4 * Copyright (c) 2017-2024 GAMS Software GmbH <support@gams.com>
5 * Copyright (c) 2017-2024 GAMS Development Corp. <support@gams.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in all
15 * copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26#ifndef GAMSENUM_H
27#define GAMSENUM_H
28// TODO(jm) generator-change-request: #pragma once in some cases behaves differently to standard IFDEF guard
29// TODO(JM) generator-change-request: XML-Tags in comments -> no c++ style
30// TODO(JM) generator-change-request: add static functions to get enums as string
31
32#include <string>
33#include "gamslib_global.h" // LIBSPEC
34
35namespace gams {
36
38class LIBSPEC GAMSEnum
39{
40public:
41
43 enum SymbolType
44 {
45 SymTypeSet = 0,
46 SymTypePar,
47 SymTypeVar,
48 SymTypeEqu
49 };
50
52 static std::string text(GAMSEnum::SymbolType type);
53
54
55 // TODO(AF) difference gmomcc.h/gmoEquType(=> B) and gclgms.h/GMS_EQUTYPE_MAX(=> MAX)?
57 enum EquType
58 {
59 E = 0,
60 G = 1,
61 L = 2,
62 N = 3,
63 X = 4,
64 C = 5,
65 MAX = 6
66 };
67
69 static std::string text(GAMSEnum::EquType type);
70
72 enum SetType
73 {
74 Multi,
75 Singleton
76 };
77
79 static std::string text(GAMSEnum::SetType type);
80
82 enum VarType
83 {
84 Unknown,
85 Binary,
86 Integer,
87 Positive,
88 Negative,
89 Free,
90 SOS1,
91 SOS2,
92 SemiCont,
93 SemiInt
94 };
95
97 static std::string text(GAMSEnum::VarType type);
98
100 enum SolveStat
101 {
102 Normal = 1,
103 Iteration,
104 Resource,
105 Solver,
106 EvalError,
107 Capability,
108 License,
109 User,
110 SetupErr,
111 SolverErr,
112 InternalErr,
113 Skipped,
114 SystemErr
115 };
116
118 enum ModelStat
119 {
120 OptimalGlobal = 1,
121 OptimalLocal,
122 Unbounded,
123 InfeasibleGlobal,
124 InfeasibleLocal,
125 InfeasibleIntermed,
126 Feasible,
127 IntegerSolution,
128 NonIntegerIntermed,
129 IntegerInfeasible,
130 LicenseError,
131 ErrorUnknown,
132 ErrorNoSolution,
133 NoSolutionReturned,
134 SolvedUnique,
135 Solved,
136 SolvedSingular,
137 UnboundedNoSolution,
138 InfeasibleNoSolution
139 };
140
142 enum GAMSExitCode
143 {
144 NormalReturn = 0,
145 SolverToBeCalled,
146 CompilationError,
147 ExecutionError,
148 SystemLimitsReached,
149 FileError,
150 ParameterError,
151 LicensingError,
152 GAMSSystemError,
153 GAMSCouldNotBeStarted,
154 OutOfMemory,
155 OutOfDisk,
156 CouldNotCreateScratchDir = 109,
157 TooManyScratchDirs = 110,
158 CouldNotDeleteScratchDir = 112,
159 CouldNotWriteGamsNext = 113,
160 CouldNotWriteParamFile = 114,
161 CouldNotReadEnvVar = 115,
162 CouldNotSpawnGAMScmex = 400,
163 CurDirNotFound = 401,
164 CurDirNotSet = 402,
165 BlankInSysDir = 404,
166 BlankInCurDir = 405,
167 BlankInScrExt = 406,
168 UnexpectedCmexRC = 407,
169 ProcDirNotFound = 408,
170 CmexLibNotFound = 409,
171 CmexLibEPNotFound = 410,
172 BlankInProcDir = 411,
173 BlankInScrDir = 412,
174 CannotAddPath = 909,
175 MissingCommandLineParameter = 1000,
176 CannotInstallInterrupt = 2000,
177 CouldNotGetCurrentDir = 3000,
178 CmexNotFound = 4000,
179 OptNotFound = 5000
180 };
181
183 static std::string text(GAMSEnum::GAMSExitCode type);
184
186 enum SymbolUpdateAction
187 {
188 Param = 0,
189 Upper = 1,
190 Lower = 2,
191 Fixed = 3,
192 Primal = 4,
193 Dual = 5
194 };
195
197 enum DebugLevel
198 {
199 Off = 0,
200 KeepFilesOnError,
201 KeepFiles,
202 ShowLog,
203 Verbose
204 };
205
207 enum SymbolUpdateType
208 {
209 Default = 0,
210 BaseCase = 1,
211 Accumulate = 2,
212
213 Inherit = 3
214 // // TODO(AF): this is not part of the C API (gmdUpdateType)!
215 };
216
218 enum EAction
219 {
220 RestartAfterSolve = 0,
221 CompileOnly,
222 ExecuteOnly,
223 CompileAndExecute,
224 GlueCodeGeneration,
225 TraceReport
226 };
227
229 static std::string text(GAMSEnum::EAction type);
230
232 static std::string code(GAMSEnum::EAction type);
233
235 static EAction eActionFromCode(std::string str);
236
237};
238
239}
240#endif // GAMSENUM_H
gams::GAMSEnum
The collection of all common GAMS enumerations.
Definition: gamsenum.h:39
gams::GAMSEnum::text
static std::string text(GAMSEnum::EAction type)
Get a GAMSEnum::EAction as text.
gams::GAMSEnum::VarType
VarType
Variable subtype.
Definition: gamsenum.h:83
gams::GAMSEnum::Negative
@ Negative
Negative variable.
Definition: gamsenum.h:88
gams::GAMSEnum::Free
@ Free
Free variable.
Definition: gamsenum.h:89
gams::GAMSEnum::Unknown
@ Unknown
Unknown variable type.
Definition: gamsenum.h:84
gams::GAMSEnum::SemiCont
@ SemiCont
Semi-continuous variable.
Definition: gamsenum.h:92
gams::GAMSEnum::Positive
@ Positive
Positive variable.
Definition: gamsenum.h:87
gams::GAMSEnum::Integer
@ Integer
Integer Variable.
Definition: gamsenum.h:86
gams::GAMSEnum::SOS1
@ SOS1
Special Ordered Set 1.
Definition: gamsenum.h:90
gams::GAMSEnum::SOS2
@ SOS2
Special Ordered Set 2.
Definition: gamsenum.h:91
gams::GAMSEnum::Binary
@ Binary
Binary variable.
Definition: gamsenum.h:85
gams::GAMSEnum::DebugLevel
DebugLevel
GAMS Debug Level.
Definition: gamsenum.h:198
gams::GAMSEnum::KeepFilesOnError
@ KeepFilesOnError
Keep temporary files only if GamsExceptionExecution was raised in GamsJob.run() or GamsJob....
Definition: gamsenum.h:200
gams::GAMSEnum::KeepFiles
@ KeepFiles
Keep temporary files.
Definition: gamsenum.h:201
gams::GAMSEnum::ShowLog
@ ShowLog
Send GAMS log to stdout and keep temporary files.
Definition: gamsenum.h:202
gams::GAMSEnum::EquType
EquType
Equation subtype.
Definition: gamsenum.h:58
gams::GAMSEnum::eActionFromCode
static EAction eActionFromCode(std::string str)
Get a GAMSEnum::EAction from a std::string.
gams::GAMSEnum::text
static std::string text(GAMSEnum::SetType type)
Get a GAMSEnum::SetType as string.
gams::GAMSEnum::text
static std::string text(GAMSEnum::SymbolType type)
Get a GAMSEnum::SymbolType as string.
gams::GAMSEnum::text
static std::string text(GAMSEnum::EquType type)
Get a GAMSEnum::EquType as string.
gams::GAMSEnum::GAMSExitCode
GAMSExitCode
GAMS exit code.
Definition: gamsenum.h:143
gams::GAMSEnum::ExecutionError
@ ExecutionError
There was an execution error.
Definition: gamsenum.h:147
gams::GAMSEnum::CompilationError
@ CompilationError
There was a compilation error.
Definition: gamsenum.h:146
gams::GAMSEnum::GAMSSystemError
@ GAMSSystemError
There was a GAMS system error.
Definition: gamsenum.h:152
gams::GAMSEnum::OutOfMemory
@ OutOfMemory
Out of memory.
Definition: gamsenum.h:154
gams::GAMSEnum::FileError
@ FileError
There was a file error.
Definition: gamsenum.h:149
gams::GAMSEnum::ParameterError
@ ParameterError
There was a parameter error.
Definition: gamsenum.h:150
gams::GAMSEnum::GAMSCouldNotBeStarted
@ GAMSCouldNotBeStarted
GAMS cold not be started.
Definition: gamsenum.h:153
gams::GAMSEnum::SolverToBeCalled
@ SolverToBeCalled
Solver is to be called, the system should never return this number.
Definition: gamsenum.h:145
gams::GAMSEnum::SystemLimitsReached
@ SystemLimitsReached
System limits were reached.
Definition: gamsenum.h:148
gams::GAMSEnum::LicensingError
@ LicensingError
There was a licensing error.
Definition: gamsenum.h:151
gams::GAMSEnum::OutOfDisk
@ OutOfDisk
Out of disk.
Definition: gamsenum.h:155
gams::GAMSEnum::SymbolUpdateType
SymbolUpdateType
Symbol update type.
Definition: gamsenum.h:208
gams::GAMSEnum::EAction
EAction
GAMS processing requests.
Definition: gamsenum.h:219
gams::GAMSEnum::CompileAndExecute
@ CompileAndExecute
Compile and Execute.
Definition: gamsenum.h:223
gams::GAMSEnum::CompileOnly
@ CompileOnly
CompileOnly.
Definition: gamsenum.h:221
gams::GAMSEnum::ExecuteOnly
@ ExecuteOnly
ExecuteOnly.
Definition: gamsenum.h:222
gams::GAMSEnum::GlueCodeGeneration
@ GlueCodeGeneration
Glue Code Generation.
Definition: gamsenum.h:224
gams::GAMSEnum::SetType
SetType
Set subtype.
Definition: gamsenum.h:73
gams::GAMSEnum::Multi
@ Multi
Multi Set - default.
Definition: gamsenum.h:74
gams::GAMSEnum::ModelStat
ModelStat
Model Solution Status.
Definition: gamsenum.h:119
gams::GAMSEnum::Unbounded
@ Unbounded
Unbounded model found.
Definition: gamsenum.h:122
gams::GAMSEnum::IntegerInfeasible
@ IntegerInfeasible
No feasible integer solution could be found.
Definition: gamsenum.h:129
gams::GAMSEnum::NoSolutionReturned
@ NoSolutionReturned
No solution returned.
Definition: gamsenum.h:133
gams::GAMSEnum::InfeasibleGlobal
@ InfeasibleGlobal
Infeasible model found.
Definition: gamsenum.h:123
gams::GAMSEnum::OptimalLocal
@ OptimalLocal
Local optimal solution achieved.
Definition: gamsenum.h:121
gams::GAMSEnum::LicenseError
@ LicenseError
Licensing problem.
Definition: gamsenum.h:130
gams::GAMSEnum::IntegerSolution
@ IntegerSolution
Integer solution found.
Definition: gamsenum.h:127
gams::GAMSEnum::InfeasibleIntermed
@ InfeasibleIntermed
Solver terminated early and model was still infeasible.
Definition: gamsenum.h:125
gams::GAMSEnum::SolvedUnique
@ SolvedUnique
Unique solution in a CNS models.
Definition: gamsenum.h:134
gams::GAMSEnum::InfeasibleLocal
@ InfeasibleLocal
Locally infeasible model found.
Definition: gamsenum.h:124
gams::GAMSEnum::Solved
@ Solved
Feasible solution in a CNS models.
Definition: gamsenum.h:135
gams::GAMSEnum::Feasible
@ Feasible
Feasible solution.
Definition: gamsenum.h:126
gams::GAMSEnum::ErrorUnknown
@ ErrorUnknown
Error - No cause known.
Definition: gamsenum.h:131
gams::GAMSEnum::ErrorNoSolution
@ ErrorNoSolution
Error - No solution attained.
Definition: gamsenum.h:132
gams::GAMSEnum::NonIntegerIntermed
@ NonIntegerIntermed
Solver terminated early with a non integer solution found.
Definition: gamsenum.h:128
gams::GAMSEnum::SolvedSingular
@ SolvedSingular
Singular in a CNS models.
Definition: gamsenum.h:136
gams::GAMSEnum::UnboundedNoSolution
@ UnboundedNoSolution
Unbounded - no solution.
Definition: gamsenum.h:137
gams::GAMSEnum::code
static std::string code(GAMSEnum::EAction type)
Get a GAMSEnum::EAction as code.
gams::GAMSEnum::SymbolType
SymbolType
This enum defines the type of a symbol (The type Alias is not supported and shows as Set).
Definition: gamsenum.h:44
gams::GAMSEnum::SymTypeVar
@ SymTypeVar
Symbol type is a Variable.
Definition: gamsenum.h:47
gams::GAMSEnum::SymTypePar
@ SymTypePar
Symbol type is a Parameter.
Definition: gamsenum.h:46
gams::GAMSEnum::text
static std::string text(GAMSEnum::VarType type)
Get a GAMSEnum::VarType as string.
gams::GAMSEnum::SymbolUpdateAction
SymbolUpdateAction
What field to update.
Definition: gamsenum.h:187
gams::GAMSEnum::SolveStat
SolveStat
Solver termination condition.
Definition: gamsenum.h:101
gams::GAMSEnum::License
@ License
Solver terminated with a license error.
Definition: gamsenum.h:108
gams::GAMSEnum::InternalErr
@ InternalErr
Solver terminated with error.
Definition: gamsenum.h:112
gams::GAMSEnum::Iteration
@ Iteration
Solver ran out of iterations.
Definition: gamsenum.h:103
gams::GAMSEnum::Resource
@ Resource
Solver exceeded time limit.
Definition: gamsenum.h:104
gams::GAMSEnum::Skipped
@ Skipped
Solve skipped.
Definition: gamsenum.h:113
gams::GAMSEnum::SetupErr
@ SetupErr
Solver terminated on setup error.
Definition: gamsenum.h:110
gams::GAMSEnum::EvalError
@ EvalError
Solver quit with nonlinear term evaluation errors.
Definition: gamsenum.h:106
gams::GAMSEnum::User
@ User
Solver terminated on users request (e.g. Ctrl-C)
Definition: gamsenum.h:109
gams::GAMSEnum::Solver
@ Solver
Solver quit with a problem.
Definition: gamsenum.h:105
gams::GAMSEnum::SolverErr
@ SolverErr
Solver terminated with error.
Definition: gamsenum.h:111
gams::GAMSEnum::Capability
@ Capability
Solver terminated because the model is beyond the solvers capabilities.
Definition: gamsenum.h:107
gams::GAMSEnum::text
static std::string text(GAMSEnum::GAMSExitCode type)
Get a GAMSEnum::GAMSExitCode as text.
gams
Definition: gams.h:91