Loading...
Searching...
No Matches
gamsoptions.h
1/*
2 *
3 * GAMS - General Algebraic Modeling System C++ API
4 *
5 * Copyright (c) 2017-2024 GAMS Development Corp. <support@gams.com>
6 * Copyright (c) 2017-2024 GAMS Software GmbH <support@gams.com>
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in all
16 * copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 *
26 * This file was generated.
27 */
28
29#ifndef GAMSOPTIONS_H
30#define GAMSOPTIONS_H
31#include "gamslib_global.h"
32#include <vector>
33#include <map>
34#include <string>
35#include "gamsworkspace.h"
36
37namespace gams {
38
39class GAMSOptionsImpl;
40
54class LIBSPEC GAMSOptions
55{
56 friend class GAMSModelInstanceImpl;
57 friend class GAMSJobImpl;
58 friend class GAMSWorkspaceImpl;
59
60public:
62 struct EAction
63 {
66 {
67 RestartAfterSolve = 0,
68 CompileOnly = 1,
69 ExecuteOnly = 2,
70 CompileAndExecute = 3,
71 GlueCodeGeneration = 4,
72 TraceReport = 5
73 };
74 };
77 {
80 {
81 Reset = 0,
82 Append = 1
83 };
84 };
87 {
90 {
91 Reset = 0,
92 Append = 1
93 };
94 };
97 {
100 {
101 Off = 0,
102 On = 1
103 };
104 };
107 {
110 {
111 Off = 0,
112 On = 1
113 };
114 };
116 struct ECase
117 {
120 {
121 MixedCase = 0,
122 UpperCase = 1
123 };
124 };
126 struct ECharSet
127 {
130 {
131 LimitedGAMSCharSet = 0,
132 AnyChar = 1
133 };
134 };
137 {
140 {
141 Off = 0,
142 On = 1
143 };
144 };
146 struct EDFormat
147 {
150 {
151 Slash = 0,
152 Dot = 1,
153 Dash = 2
154 };
155 };
157 struct EDigit
158 {
161 {
162 OffDigit = 0,
163 OnDigit = 1
164 };
165 };
167 struct EDumpOpt
168 {
171 {
172 No = 0,
173 RefDataOriginalSetElementNames = 1,
174 RefDataNewSetElementNames = 2,
175 RefDataNewSetElementNamesDropSymbolText = 3,
176 RefSymbol = 4,
177 Deprecated_10 = 10,
178 InputFileWOComments = 11,
179 Deprecated_12 = 12,
180 Deprecated_19 = 19,
181 Deprecated_20 = 20,
182 InputFileWithComments = 21,
183 SplitBlocksDumpWithComments = 22
184 };
185 };
188 {
191 {
192 No = 0,
193 AcceptedParameters = 1,
194 FileOperationsAcceptedParameters = 2
195 };
196 };
199 {
202 {
203 OffECImplicitLoad = 0,
204 OnECImplicitLoad = 1
205 };
206 };
208 struct EEmpty
209 {
212 {
213 OffEmpty = 0,
214 OnEmpty = 1
215 };
216 };
218 struct EErrMsg
219 {
222 {
223 EndOfCompilerListing = 0,
224 FollowingError = 1,
225 Suppress = 2
226 };
227 };
230 {
233 {
234 EverythingAllowed = 0,
235 InteractiveShellsProhibited = 1,
236 CallAndExecuteProhibited = 2,
237 EchoAndPutOnlyToWorkdir = 3,
238 EchoAndPutProhibited = 4
239 };
240 };
242 struct EFDOpt
243 {
246 {
247 GHAnalyticHNumericGradScale = 0,
248 GHAnalyticHNumericFuncScale = 1,
249 GAnalyticFHNumericGradScale = 2,
250 GAnalyticFHNumericFuncScale = 3,
251 FGHNumericScale = 4,
252 GHAnalyticHNumericGradNoScale = 10,
253 GHAnalyticHNumericFuncNoScale = 11,
254 GAnalyticFHNumericGradNoScale = 12,
255 GAnalyticFHNumericFuncNoScale = 13,
256 FGHNumericNoScale = 14
257 };
258 };
261 {
264 {
265 DefaultCase = 0,
266 UpperCase = 1,
267 LowerCase = 2,
268 UpperCaseFileOnly = 3,
269 LowerCaseFileOnly = 4
270 };
271 };
274 {
277 {
278 OffFiltered = 0,
279 OnFiltered = 1
280 };
281 };
284 {
287 {
288 NoTranslation = 0,
289 TryTranslation = 1
290 };
291 };
294 {
297 {
298 Off = 0,
299 On = 1
300 };
301 };
304 {
307 {
308 DoNotCompressGDX = 0,
309 CompressGDX = 1
310 };
311 };
314 {
317 {
318 Version5 = 0,
319 Version6 = 1,
320 Version7 = 2
321 };
322 };
324 struct EgdxUels
325 {
328 {
329 squeezed = 0,
330 full = 1
331 };
332 };
335 {
338 {
339 FixedVarsNotTreatedAsConstants = 0,
340 FixedVarsTreatedAsConstants = 1
341 };
342 };
345 {
348 {
349 Off = 0,
350 On = 1
351 };
352 };
355 {
358 {
359 OffImplicitAssign = 0,
360 OnImplicitAssign = 1
361 };
362 };
365 {
368 {
369 NoInteraction = 0,
370 AllowInteraction = 1
371 };
372 };
375 {
378 {
379 INF = 0,
380 Pass100ToSolver = 1,
381 INFandLog = 2,
382 Pass100ToSolverAndError = 3
383 };
384 };
386 struct EKeep
387 {
390 {
391 DeleteProcDir = 0,
392 KeepProcDir = 1
393 };
394 };
396 struct EListing
397 {
400 {
401 OffListing = 0,
402 OnListing = 1
403 };
404 };
406 struct ELogLine
407 {
410 {
411 NoTracing = 0,
412 MinimumTracing = 1,
413 Automatic = 2
414 };
415 };
418 {
421 {
422 Off = 0,
423 On = 1
424 };
425 };
427 struct EMIIMode
428 {
431 {
432 Off = 0,
433 SingleMI = 1,
434 MultiMI = 2
435 };
436 };
439 {
442 {
443 AllowNewVarEqu = 0,
444 DoNotAllowNewVarEqu = 1
445 };
446 };
448 struct EOn115
449 {
452 {
453 NoMessages = 0,
454 IssueMessages = 1
455 };
456 };
459 {
462 {
463 NoPageContrWithPadding = 0,
464 FortranStyle = 1,
465 NoPageContrNoPadding = 2,
466 FormfeedCharNewPage = 3
467 };
468 };
471 {
474 {
475 Off = 0,
476 On = 1
477 };
478 };
481 {
484 {
485 Off = 0,
486 On = 1
487 };
488 };
491 {
494 {
495 Off = 0,
496 On = 1
497 };
498 };
500 struct EPutNR
501 {
504 {
505 ForE = 0,
506 Rounded = 1,
507 Scientific = 2,
508 RoundedFloatingDec = 3,
509 ForEFloatingDec = 4
510 };
511 };
514 {
517 {
518 ActualLineNumber = 0,
519 StatementStart = 1
520 };
521 };
523 struct EReplace
524 {
527 {
528 Merge = 0,
529 Replace = 1
530 };
531 };
534 {
537 {
538 NoPointFile = 0,
539 LastSolvePointFile = 1,
540 EverySolvePointFile = 2,
541 LastSolvePointFileScrDir = 3,
542 EverySolvePointFileScrDir = 4
543 };
544 };
547 {
550 {
551 InternalAccounting = 0,
552 RSS = 1,
553 VSS = 2
554 };
555 };
558 {
561 {
562 RemoveSolLstFollowingSolves = 0,
563 IncludeSolLstFollowingSolves = 1,
564 SuppressAllSolInfo = 2
565 };
566 };
569 {
572 {
573 ChainScript = 0,
574 CallScript = 1,
575 CallModule = 2,
576 AsyncGrid = 3,
577 AsyncSimulate = 4,
578 LoadLibrary = 5,
579 LoadLibraryAsync = 6,
580 LoadLibraryAsyncSimulate = 7
581 };
582 };
585 {
588 {
589 Merge = 0,
590 Replace = 1,
591 Clear = 2
592 };
593 };
595 struct EStepSum
596 {
599 {
600 NoStepSummmary = 0,
601 StepSummary = 1
602 };
603 };
606 {
609 {
610 FirstRecord = 0,
611 Error = 1
612 };
613 };
616 {
619 {
620 NoError = 0,
621 Error = 1,
622 NoErrorRemoveSymbol = 2
623 };
624 };
627 {
630 {
631 OffSuffixDLVars = 0,
632 OnSuffixDLVars = 1
633 };
634 };
637 {
640 {
641 OffSuffixAlgebraVars = 0,
642 OnSuffixAlgebraVars = 1
643 };
644 };
647 {
650 {
651 StandardCompilerListing = 0,
652 SuppressCompilerListing = 1
653 };
654 };
656 struct ESys10
657 {
660 {
661 Disable = 0,
662 Enable = 1
663 };
664 };
666 struct ESys11
667 {
670 {
671 AutomaticOptimization = 0,
672 NoOptimization = 1,
673 AlwaysOptimize = 2
674 };
675 };
677 struct ESysOut
678 {
681 {
682 SuppressAdditionalSolverOutput = 0,
683 IncludeAdditionalSolverOutput = 1
684 };
685 };
687 struct ETFormat
688 {
691 {
692 Colon = 0,
693 Dot = 1
694 };
695 };
698 {
701 {
702 SolverAndGAMSStepTraceWOHeaders = 0,
703 SolverAndGAMSStepTrace = 1,
704 SolverStepTraceOnly = 2,
705 TraceFileFormatGAMSPerformanceWorld = 3,
706 TraceFileFormatSupportingNLPEC = 4,
707 TraceFileWithAllAvailableTraceFields = 5
708 };
709 };
712 {
715 {
716 NoWarning = 0,
717 IssueWarning = 1
718 };
719 };
720
723
725 static const char* gamsBuild();
726
728 static const char* gamsVersion();
729
732 LogId logID();
733
735 void writeOptionFile(const std::string& optFileName);
736
738 void setAllModelTypes(const std::string& solver);
739
742
744 void addInputDir(const std::string value);
745
747 std::string getInputDir(const int index);
748
750 void setInputDir(const std::string value, const int index);
751
753 void removeInputDir(const int index);
754
756 void setDefine(const std::string &key, const std::string &value);
757
759 std::string getDefine(const std::string& key);
760
762 bool removeDefine(const std::string& key);
763
765 std::string gdx();
766
768 void setGdx(const std::string& value);
769
772
775
777 static EAction::EActionEnum eActionFromCode(const std::string &str);
778
781
784
787
790
793
796
799
802
804 double bratio();
805
807 void setBratio(const double value);
808
811
814
816 int lstCase();
817
819 void setLstCase(const int value);
820
822 int cErr();
823
825 void setCErr(const int value);
826
829
832
835
838
840 std::string decryptKey();
841
843 void setDecryptKey(const std::string& value);
844
847
850
853
856
858 static EDigit::EDigitEnum eDigitFromCode(const std::string &str);
859
862
865
867 int domLim();
868
870 void setDomLim(const int value);
871
874
877
879 std::string dumpOptGDX();
880
882 void setDumpOptGDX(const std::string& value);
883
886
889
891 std::string dumpParmsLogPrefix();
892
894 void setDumpParmsLogPrefix(const std::string& value);
895
898
901
904
907
910
913
916
918 static EEmpty::EEmptyEnum eEmptyFromCode(const std::string &str);
919
922
925
927 std::string encryptKey();
928
930 void setEncryptKey(const std::string& value);
931
933 std::string eolCom();
934
936 void setEolCom(const std::string& value);
937
940
943
945 int errorLog();
946
948 void setErrorLog(const int value);
949
951 double eTLim();
952
954 void setETLim(const double value);
955
958
961
963 std::string expand();
964
966 void setExpand(const std::string& value);
967
969 double fDDelta();
970
972 void setFDDelta(const double value);
973
976
979
981 std::string fErr();
982
984 void setFErr(const std::string& value);
985
988
991
993 std::string fileStem();
994
996 void setFileStem(const std::string& value);
997
999 std::string fileStemApFromEnv();
1000
1002 void setFileStemApFromEnv(const std::string& value);
1003
1006
1009
1011 static EFiltered::EFilteredEnum eFilteredFromCode(const std::string &str);
1012
1015
1018
1021
1023 void setForceOptFile(const int value);
1024
1027
1030
1032 int forLim();
1033
1035 void setForLim(const int value);
1036
1039
1042
1045
1048
1051
1054
1057
1060
1063
1066
1069
1071 static EgdxUels::EgdxUelsEnum egdxUelsFromCode(const std::string &str);
1072
1075
1078
1080 std::string gridDir();
1081
1083 void setGridDir(const std::string& value);
1084
1086 std::string gridScript();
1087
1089 void setGridScript(const std::string& value);
1090
1092 double heapLimit();
1093
1095 void setHeapLimit(const double value);
1096
1099
1102
1105
1108
1110 std::string iDCGDXInput();
1111
1113 void setIDCGDXInput(const std::string& value);
1114
1116 std::string iDCGDXOutput();
1117
1119 void setIDCGDXOutput(const std::string& value);
1120
1123
1126
1129
1132
1135
1137 std::string inlineCom();
1138
1140 void setInlineCom(const std::string& value);
1141
1144
1146 void setInteger1(const int value);
1147
1150
1152 void setInteger2(const int value);
1153
1156
1158 void setInteger3(const int value);
1159
1162
1164 void setInteger4(const int value);
1165
1168
1170 void setInteger5(const int value);
1171
1174
1177
1180
1183
1185 int iterLim();
1186
1188 void setIterLim(const int value);
1189
1191 std::string jobTrace();
1192
1194 void setJobTrace(const std::string& value);
1195
1198
1201
1203 std::string libIncDir();
1204
1206 void setLibIncDir(const std::string& value);
1207
1209 std::string license();
1210
1212 void setLicense(const std::string& value);
1213
1215 int limCol();
1216
1218 void setLimCol(const int value);
1219
1221 int limRow();
1222
1224 void setLimRow(const int value);
1225
1228
1231
1233 static EListing::EListingEnum eListingFromCode(const std::string &str);
1234
1237
1240
1243
1246
1249
1252
1255
1257 void setMaxExecError(const int value);
1258
1261
1263 void setMaxProcDir(const int value);
1264
1267
1270
1272 static EMIIMode::EMIIModeEnum eMIIModeFromCode(const std::string &str);
1273
1276
1279
1281 std::string multi();
1282
1284 void setMulti(const std::string& value);
1285
1287 int nodLim();
1288
1290 void setNodLim(const int value);
1291
1294
1297
1300
1303
1305 double optCA();
1306
1308 void setOptCA(const double value);
1309
1311 double optCR();
1312
1314 void setOptCR(const double value);
1315
1317 std::string optDir();
1318
1320 void setOptDir(const std::string& value);
1321
1323 int optFile();
1324
1326 void setOptFile(const int value);
1327
1329 std::string output();
1330
1332 void setOutput(const std::string& value);
1333
1336
1339
1342
1344 void setPageSize(const int value);
1345
1348
1350 void setPageWidth(const int value);
1351
1353 std::string pLicense();
1354
1356 void setPLicense(const std::string& value);
1357
1360
1363
1366
1369
1372
1375
1378
1380 void setProcTreeMemTicks(const int value);
1381
1383 int profile();
1384
1386 void setProfile(const int value);
1387
1389 std::string profileFile();
1390
1392 void setProfileFile(const std::string& value);
1393
1395 double profileTol();
1396
1398 void setProfileTol(const double value);
1399
1401 std::string putDir();
1402
1404 void setPutDir(const std::string& value);
1405
1407 int putND();
1408
1410 void setPutND(const int value);
1411
1414
1417
1419 int putPS();
1420
1422 void setPutPS(const int value);
1423
1425 int putPW();
1426
1428 void setPutPW(const int value);
1429
1431 std::string reference();
1432
1434 void setReference(const std::string& value);
1435
1438
1441
1444
1447
1450
1453
1456
1458 static EReplace::EReplaceEnum eReplaceFromCode(const std::string &str);
1459
1462
1465
1467 double resLim();
1468
1470 void setResLim(const double value);
1471
1474
1477
1479 std::string scriptExit();
1480
1482 void setScriptExit(const std::string& value);
1483
1485 int seed();
1486
1488 void setSeed(const int value);
1489
1492
1495
1498
1501
1504
1507
1510
1513
1516
1519
1522
1525
1528
1531
1534
1537
1540
1543
1546
1549
1552
1555
1558
1561
1564
1567
1569 std::string symbol();
1570
1572 void setSymbol(const std::string& value);
1573
1575 std::string symPrefix();
1576
1578 void setSymPrefix(const std::string& value);
1579
1582
1585
1588
1591
1593 int sys12();
1594
1596 void setSys12(const int value);
1597
1599 std::string sysIncDir();
1600
1602 void setSysIncDir(const std::string& value);
1603
1606
1609
1611 int tabIn();
1612
1614 void setTabIn(const int value);
1615
1618
1621
1623 int threads();
1624
1626 void setThreads(const int value);
1627
1630
1632 void setThreadsAsync(const int value);
1633
1635 int timer();
1636
1638 void setTimer(const int value);
1639
1641 std::string trace();
1642
1644 void setTrace(const std::string& value);
1645
1648
1650 void setTraceLevel(const int value);
1651
1654
1657
1659 std::string user1();
1660
1662 void setUser1(const std::string& value);
1663
1665 std::string user2();
1666
1668 void setUser2(const std::string& value);
1669
1671 std::string user3();
1672
1674 void setUser3(const std::string& value);
1675
1677 std::string user4();
1678
1680 void setUser4(const std::string& value);
1681
1683 std::string user5();
1684
1686 void setUser5(const std::string& value);
1687
1690
1692 void setWarnings(const int value);
1693
1695 double workFactor();
1696
1698 void setWorkFactor(const double value);
1699
1701 double workSpace();
1702
1704 void setWorkSpace(const double value);
1705
1707 double zeroRes();
1708
1710 void setZeroRes(const double value);
1711
1714
1717
1719 std::string LP();
1720
1722 void setLP(const std::string& value);
1723
1725 std::string MIP();
1726
1728 void setMIP(const std::string& value);
1729
1731 std::string RMIP();
1732
1734 void setRMIP(const std::string& value);
1735
1737 std::string NLP();
1738
1740 void setNLP(const std::string& value);
1741
1743 std::string MCP();
1744
1746 void setMCP(const std::string& value);
1747
1749 std::string MPEC();
1750
1752 void setMPEC(const std::string& value);
1753
1755 std::string RMPEC();
1756
1758 void setRMPEC(const std::string& value);
1759
1761 std::string CNS();
1762
1764 void setCNS(const std::string& value);
1765
1767 std::string DNLP();
1768
1770 void setDNLP(const std::string& value);
1771
1773 std::string RMINLP();
1774
1776 void setRMINLP(const std::string& value);
1777
1779 std::string MINLP();
1780
1782 void setMINLP(const std::string& value);
1783
1785 std::string QCP();
1786
1788 void setQCP(const std::string& value);
1789
1791 std::string MIQCP();
1792
1794 void setMIQCP(const std::string& value);
1795
1797 std::string RMIQCP();
1798
1800 void setRMIQCP(const std::string& value);
1801
1803 std::string EMP();
1804
1806 void setEMP(const std::string& value);
1807
1809 std::string getSolver(const std::string& modelType);
1810
1812 void setSolver(const std::string& modelType, const std::string& solver);
1813
1814private:
1815 std::shared_ptr<GAMSOptionsImpl> mImpl;
1816 GAMSOptions(GAMSWorkspace workspace, const GAMSOptions* optFrom);
1817 GAMSOptions(GAMSWorkspace workspace, const std::string& optFile = "");
1818 int appendLog();
1819 void setAppendLog(const int value);
1820 std::string connectIn();
1821 void setConnectIn(const std::string& value);
1822 std::string connectOut();
1823 void setConnectOut(const std::string& value);
1824 std::string curDir();
1825 void setCurDir(const std::string& value);
1826 int debug();
1827 void setDebug(const int value);
1828 int debugPort();
1829 void setDebugPort(const int value);
1830 std::string docFile();
1831 void setDocFile(const std::string& value);
1832 std::string epsToZero();
1833 void setEpsToZero(const std::string& value);
1834 std::string errNam();
1835 void setErrNam(const std::string& value);
1836 int fSave();
1837 void setFSave(const int value);
1838 int g205();
1839 void setG205(const int value);
1840 std::string gdxSymbols();
1841 void setgdxSymbols(const std::string& value);
1842 std::string iDCGenerateGDX();
1843 void setIDCGenerateGDX(const std::string& value);
1844 std::string iDCGenerateGDXInput();
1845 void setIDCGenerateGDXInput(const std::string& value);
1846 std::string iDCGenerateGDXOutput();
1847 void setIDCGenerateGDXOutput(const std::string& value);
1848 std::string iDCGenerateJSON();
1849 void setIDCGenerateJSON(const std::string& value);
1850 std::string iDCJSON();
1851 void setIDCJSON(const std::string& value);
1852 int iDCProtect();
1853 void setIDCProtect(const int value);
1854 int iDE();
1855 void setIDE(const int value);
1856 int incrementalMode();
1857 void setIncrementalMode(const int value);
1858 std::string input();
1859 void setInput(const std::string& value);
1860 std::string logFile();
1861 void setLogFile(const std::string& value);
1862 int logOption();
1863 void setLogOption(const int value);
1864 int maxGenericFiles();
1865 void setMaxGenericFiles(const int value);
1866 int mCPRHoldfx();
1867 void setMCPRHoldfx(const int value);
1868 int multiPass();
1869 void setMultiPass(const int value);
1870 int noCr();
1871 void setNoCr(const int value);
1872 int opt();
1873 void setOpt(const int value);
1874 int pID2Error();
1875 void setPID2Error(const int value);
1876 std::string procDir();
1877 void setProcDir(const std::string& value);
1878 std::string procDirPath();
1879 void setProcDirPath(const std::string& value);
1880 int relPath();
1881 void setRelPath(const int value);
1882 std::string restart();
1883 void setRestart(const std::string& value);
1884 std::string restartNamed();
1885 void setRestartNamed(const std::string& value);
1886 std::string save();
1887 void setSave(const std::string& value);
1888 std::string saveObfuscate();
1889 void setSaveObfuscate(const std::string& value);
1890 std::string scrDir();
1891 void setScrDir(const std::string& value);
1892 std::string scrExt();
1893 void setScrExt(const std::string& value);
1894 std::string scriptFrst();
1895 void setScriptFrst(const std::string& value);
1896 std::string scriptNext();
1897 void setScriptNext(const std::string& value);
1898 std::string scrNam();
1899 void setScrNam(const std::string& value);
1900 int serverRun();
1901 void setServerRun(const int value);
1902 std::string solver();
1903 void setSolver(const std::string& value);
1904 std::string solverCntr();
1905 void setSolverCntr(const std::string& value);
1906 std::string solverDict();
1907 void setSolverDict(const std::string& value);
1908 std::string solverInst();
1909 void setSolverInst(const std::string& value);
1910 std::string solverMatr();
1911 void setSolverMatr(const std::string& value);
1912 std::string solverSolu();
1913 void setSolverSolu(const std::string& value);
1914 std::string solverStat();
1915 void setSolverStat(const std::string& value);
1916 std::string sparseRun();
1917 void setSparseRun(const std::string& value);
1918 std::string sqaCmex();
1919 void setSqaCmex(const std::string& value);
1920 std::string subSys();
1921 void setSubSys(const std::string& value);
1922 int sys14();
1923 void setSys14(const int value);
1924 int sys15();
1925 void setSys15(const int value);
1926 int sys16();
1927 void setSys16(const int value);
1928 int sys17();
1929 void setSys17(const int value);
1930 int sys18();
1931 void setSys18(const int value);
1932 int sys19();
1933 void setSys19(const int value);
1934 std::string sysDir();
1935 void setSysDir(const std::string& value);
1936 int useDLL();
1937 void setUseDLL(const int value);
1938 std::string workDir();
1939 void setWorkDir(const std::string& value);
1940 int writeOutput();
1941 void setwriteOutput(const int value);
1942 std::string xSave();
1943 void setXSave(const std::string& value);
1944 std::string xSaveObfuscate();
1945 void setXSaveObfuscate(const std::string& value);
1946
1947};
1948}
1949#endif // GAMSOPTIONS_H
1950
void setProfileTol(const double value)
Set Minimum time a statement must use to appear in profile generated output.
void setFDDelta(const double value)
Set Step size for finite differences.
void setMIIMode(const GAMSOptions::EMIIMode::EMIIModeEnum value)
Set Model Instance Mode.
int cErr()
Get Compile time error limit.
static std::string eActionText(GAMSOptions::EAction::EActionEnum type)
Get GAMS processing request as text.
void setInlineCom(const std::string &value)
Set Switch default for "$on/offInline" and "$inlineCom".
std::string dumpOptGDX()
Get Defines a GDX file name stem created when using DumpOpt.
void setInteger3(const int value)
Set Integer communication cell N.
std::string symbol()
Get Symbol table file.
void setThreadsAsync(const int value)
Set Limit on number of threads to be used for asynchronous solves (solveLink=6)
GAMSOptions::ESys10::ESys10Enum sys10()
Get Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
static std::string eSuffixAlgebraVarsCode(GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum type)
Get Switch default for "$on/offSuffixAlgebraVars" as code.
void setETLim(const double value)
Set Elapsed time limit in seconds.
GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum asyncSolLst()
Get Print solution listing when asynchronous solve (Grid or Threads) is used.
GAMSOptions::ECaptureModelInstance::ECaptureModelInstanceEnum captureModelInstance()
Get Switch to capture all model instances within a run.
std::string MINLP()
Get default MINLP solver.
static std::string eMIIModeCode(GAMSOptions::EMIIMode::EMIIModeEnum type)
Get Model Instance Mode as code.
static std::string eReplaceText(GAMSOptions::EReplace::EReplaceEnum type)
Get Switch between merge and replace when reading from GDX into non-empty symbol as text.
static EDigit::EDigitEnum eDigitFromCode(const std::string &str)
Get Switch default for "$on/offDigit" from std::string
static EAction::EActionEnum eActionFromCode(const std::string &str)
Get GAMS processing request from std::string
std::string MIQCP()
Get default MIQCP solver.
GAMSOptions::ESys11::ESys11Enum sys11()
Get Dynamic resorting if indices in assignment/data statements are not in natural order.
static std::string eFilteredText(GAMSOptions::EFiltered::EFilteredEnum type)
Get Switch between filtered and domain-checked read from GDX as text.
GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum eCImplicitLoad()
Get Allow implicit loading of symbols from embedded code or not.
int threadsAsync()
Get Limit on number of threads to be used for asynchronous solves (solveLink=6)
std::string NLP()
Get default NLP solver.
GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum suffixDLVars()
Get Switch default for "$on/offSuffixDLVars".
void setDumpParmsLogPrefix(const std::string &value)
Set Prefix of lines triggered by DumpParms>1.
GAMSOptions::ELstTitleLeftAligned::ELstTitleLeftAlignedEnum lstTitleLeftAligned()
Get Write title of LST file all left aligned.
std::string DNLP()
Get default DNLP solver.
void setInteger5(const int value)
Set Integer communication cell N.
std::string user5()
Get User string N.
void setSys10(const GAMSOptions::ESys10::ESys10Enum value)
Set Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
void setDFormat(const GAMSOptions::EDFormat::EDFormatEnum value)
Set Date format.
void setInteger2(const int value)
Set Integer communication cell N.
void setSysIncDir(const std::string &value)
Set SysInclude directory.
static std::string eECImplicitLoadCode(GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum type)
Get Allow implicit loading of symbols from embedded code or not as code.
GAMSOptions::EFreeEmbeddedPython::EFreeEmbeddedPythonEnum freeEmbeddedPython()
Get Free external resources at the end of each embedded Python code blocks.
GAMSOptions::ETFormat::ETFormatEnum tFormat()
Get Time format.
std::string EMP()
Get default EMP solver.
void setStepSum(const GAMSOptions::EStepSum::EStepSumEnum value)
Set Summary of computing resources used by job steps.
GAMSOptions::ESolPrint::ESolPrintEnum solPrint()
Get Solution report print option.
void setInteger1(const int value)
Set Integer communication cell N.
void setLP(const std::string &value)
Set default LP solver.
void setWorkSpace(const double value)
Set Work space for some solvers in MB.
int pageWidth()
Get Output file page width.
void setIntVarUp(const GAMSOptions::EIntVarUp::EIntVarUpEnum value)
Set Set mode for default upper bounds on integer variables.
static EImplicitAssign::EImplicitAssignEnum eImplicitAssignFromCode(const std::string &str)
Get Switch default for "$on/offImplicitAssign" from std::string
void setForLim(const int value)
Set GAMS looping limit.
static ESuffixAlgebraVars::ESuffixAlgebraVarsEnum eSuffixAlgebraVarsFromCode(const std::string &str)
Get Switch default for "$on/offSuffixAlgebraVars" from std::string
double profileTol()
Get Minimum time a statement must use to appear in profile generated output.
GAMSOptions::EStepSum::EStepSumEnum stepSum()
Get Summary of computing resources used by job steps.
double optCA()
Get Absolute Optimality criterion solver default.
void setMCP(const std::string &value)
Set default MCP solver.
std::string QCP()
Get default QCP solver.
void setSys12(const int value)
Set Pass model with generation errors to solver.
int inputDirSize()
Get the size of the inputdir list.
void setRMPEC(const std::string &value)
Set default RMPEC solver.
GAMSOptions::EDumpParms::EDumpParmsEnum dumpParms()
Get GAMS parameter logging.
void setLimRow(const int value)
Set Maximum number of rows listed in one equation block.
std::string pLicense()
Get Privacy license file name.
int integer2()
Get Integer communication cell N.
GAMSOptions::ECharSet::ECharSetEnum charSet()
Get Character set flag.
std::string LP()
Get default LP solver.
void setAllModelTypes(const std::string &solver)
Set the solver for all model types the solver can handle.
std::string user4()
Get User string N.
static std::string eListingCode(GAMSOptions::EListing::EListingEnum type)
Get Switch default for "$on/offListing" as code.
static EECImplicitLoad::EECImplicitLoadEnum eECImplicitLoadFromCode(const std::string &str)
Get Allow implicit loading of symbols from embedded code or not from std::string
void setPLicense(const std::string &value)
Set Privacy license file name.
GAMSOptions::EZeroResRep::EZeroResRepEnum zeroResRep()
Get Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
void setMIP(const std::string &value)
Set default MIP solver.
GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum noNewVarEqu()
Get Triggers a compilation error when new equations or variable symbols are introduced.
~GAMSOptions()
Destructor.
void setIterLim(const int value)
Set Iteration limit of solver.
GAMSOptions::EHoldFixedAsync::EHoldFixedAsyncEnum holdFixedAsync()
Get Allow HoldFixed for models solved asynchronously as well.
std::string iDCGDXInput()
Get GDX file name with data for implicit input.
void setAppendExpand(const GAMSOptions::EAppendExpand::EAppendExpandEnum value)
Set Expand file append option.
static std::string egdxUelsCode(GAMSOptions::EgdxUels::EgdxUelsEnum type)
Get Unload labels or UELs to GDX either squeezed or full as code.
GAMSOptions::EgdxConvert::EgdxConvertEnum gdxConvert()
Get Version of GDX files generated (for backward compatibility)
void setUser4(const std::string &value)
Set User string N.
int domLim()
Get Domain violation limit solver default.
int putND()
Get Number of decimals for put files.
static std::string eDigitCode(GAMSOptions::EDigit::EDigitEnum type)
Get Switch default for "$on/offDigit" as code.
void setDumpOpt(const GAMSOptions::EDumpOpt::EDumpOptEnum value)
Set Writes preprocessed input to the file input.dmp.
void setRMIP(const std::string &value)
Set default RMIP solver.
int nodLim()
Get Node limit in branch and bound tree.
void setNLP(const std::string &value)
Set default NLP solver.
std::string fErr()
Get Alternative error message file.
static EListing::EListingEnum eListingFromCode(const std::string &str)
Get Switch default for "$on/offListing" from std::string
void setFileStemApFromEnv(const std::string &value)
Set Append a string read from an environment variable to the "FileStem".
void setEmpty(const GAMSOptions::EEmpty::EEmptyEnum value)
Set Switch default for "$on/offEmpty".
void setExpand(const std::string &value)
Set Expanded (include) input file name.
static std::string eSuffixDLVarsCode(GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum type)
Get Switch default for "$on/offSuffixDLVars" as code.
void setDecryptKey(const std::string &value)
Set Key to decrypt a text file that was encrypted via $encrypt.
static std::string eActionCode(GAMSOptions::EAction::EActionEnum type)
Get GAMS processing request as code.
GAMSOptions::EFiltered::EFilteredEnum filtered()
Get Switch between filtered and domain-checked read from GDX.
void setInteger4(const int value)
Set Integer communication cell N.
void setSolver(const std::string &modelType, const std::string &solver)
Get solver by model type.
void setReferenceLineNo(const GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum value)
Set Controls the line numbers written to a reference file.
static EMIIMode::EMIIModeEnum eMIIModeFromCode(const std::string &str)
Get Model Instance Mode from std::string
void setOptCR(const double value)
Set Relative Optimality criterion solver default.
int threads()
Get Number of processors to be used by a solver.
double workFactor()
Get Memory Estimate multiplier for some solvers.
std::string fileStem()
Get Sets the file stem for output files which use the input file name as stem by default.
void setHeapLimit(const double value)
Set Maximum Heap size allowed in MB.
void setPutNR(const GAMSOptions::EPutNR::EPutNREnum value)
Set Numeric round format for put files.
void setTFormat(const GAMSOptions::ETFormat::ETFormatEnum value)
Set Time format.
std::string jobTrace()
Get Job trace string to be written to the trace file at the end of a GAMS job.
static const char * gamsVersion()
Get GAMS version information.
void setTraceLevel(const int value)
Set Modelstat/Solvestat threshold used in conjunction with action=GT.
GAMSOptions::EPageContr::EPageContrEnum pageContr()
Get Output file page control option.
void setAsyncSolLst(const GAMSOptions::EAsyncSolLst::EAsyncSolLstEnum value)
Set Print solution listing when asynchronous solve (Grid or Threads) is used.
void setMulti(const std::string &value)
Set Switch default for "$on/offMulti[R]".
void setFiltered(const GAMSOptions::EFiltered::EFilteredEnum value)
Set Switch between filtered and domain-checked read from GDX.
void setInputDir(const std::string value, const int index)
Replace inputdir at the specified index of the inputdir list.
int integer5()
Get Integer communication cell N.
void setFErr(const std::string &value)
Set Alternative error message file.
void setGridDir(const std::string &value)
Set Grid file directory.
static std::string eSuffixDLVarsText(GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum type)
Get Switch default for "$on/offSuffixDLVars" as text.
void setCheckErrorLevel(const GAMSOptions::ECheckErrorLevel::ECheckErrorLevelEnum value)
Set Check errorLevel automatically after executing external program.
void setSeed(const int value)
Set Random number seed.
void setInteractiveSolver(const GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum value)
Set Allow solver to interact via command line input.
GAMSOptions::EDigit::EDigitEnum digit()
Get Switch default for "$on/offDigit".
void setGridScript(const std::string &value)
Set Grid submission script.
static std::string egdxConvertText(GAMSOptions::EgdxConvert::EgdxConvertEnum type)
Get Version of GDX files generated (for backward compatibility) as text.
void setPreviousWork(const GAMSOptions::EPreviousWork::EPreviousWorkEnum value)
Set Indicator for writing workfile with previous workfile version.
GAMSOptions::EInteractiveSolver::EInteractiveSolverEnum interactiveSolver()
Get Allow solver to interact via command line input.
GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum suffixAlgebraVars()
Get Switch default for "$on/offSuffixAlgebraVars".
std::string gdx()
Get GDX file name.
void setTrace(const std::string &value)
Set Trace file name.
void setDumpParms(const GAMSOptions::EDumpParms::EDumpParmsEnum value)
Set GAMS parameter logging.
void setTabIn(const int value)
Set Tab spacing.
GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum prefixLoadPath()
Get Prepend GAMS system directory to library load path.
void setForceOptFile(const int value)
Set Overwrites other option file section mechanism.
std::string dumpParmsLogPrefix()
Get Prefix of lines triggered by DumpParms>1.
std::string optDir()
Get Option file directory.
double heapLimit()
Get Maximum Heap size allowed in MB.
void setDefine(const std::string &key, const std::string &value)
Set double-dash –key=value option pair.
void setSuffixAlgebraVars(const GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum value)
Set Switch default for "$on/offSuffixAlgebraVars".
int sys12()
Get Pass model with generation errors to solver.
void setDNLP(const std::string &value)
Set default DNLP solver.
void setLimCol(const int value)
Set Maximum number of columns listed in one variable block.
GAMSOptions::ESysOut::ESysOutEnum sysOut()
Get Solver Status file reporting option.
void setReference(const std::string &value)
Set Symbol reference file.
static std::string eListingText(GAMSOptions::EListing::EListingEnum type)
Get Switch default for "$on/offListing" as text.
void setCaptureModelInstance(const GAMSOptions::ECaptureModelInstance::ECaptureModelInstanceEnum value)
Set Switch to capture all model instances within a run.
static std::string egdxConvertCode(GAMSOptions::EgdxConvert::EgdxConvertEnum type)
Get Version of GDX files generated (for backward compatibility) as code.
void setMaxProcDir(const int value)
Set Maximum number of 225* process directories.
void setProfile(const int value)
Set Execution profiling.
void setExecMode(const GAMSOptions::EExecMode::EExecModeEnum value)
Set Limits on external programs that are allowed to be executed.
GAMSOptions::ETraceOpt::ETraceOptEnum traceOpt()
Get Trace file format option.
double workSpace()
Get Work space for some solvers in MB.
void setCNS(const std::string &value)
Set default CNS solver.
void addInputDir(const std::string value)
Add new inputdir at the end of the inputdir list.
static std::string eSuffixAlgebraVarsText(GAMSOptions::ESuffixAlgebraVars::ESuffixAlgebraVarsEnum type)
Get Switch default for "$on/offSuffixAlgebraVars" as text.
std::string libIncDir()
Get LibInclude directory.
void setGdx(const std::string &value)
Set GDX file name.
int forceOptFile()
Get Overwrites other option file section mechanism.
void setTimer(const int value)
Set Instruction timer threshold in milli seconds.
void setgdxUels(const GAMSOptions::EgdxUels::EgdxUelsEnum value)
Set Unload labels or UELs to GDX either squeezed or full.
void setStringChk(const GAMSOptions::EStringChk::EStringChkEnum value)
Set String substitution options.
void setMPEC(const std::string &value)
Set default MPEC solver.
void setSymbol(const std::string &value)
Set Symbol table file.
std::string getDefine(const std::string &key)
Get value of previously set double-dash –key-value option pair.
std::string scriptExit()
Get Program or script to be executed at the end of a GAMS run.
int maxExecError()
Get Execution time error limit.
GAMSOptions::ELogLine::ELogLineEnum logLine()
Get Amount of line tracing to the log file.
void setProcTreeMemMonitor(const GAMSOptions::EProcTreeMemMonitor::EProcTreeMemMonitorEnum value)
Set Monitor the memory used by the GAMS process tree.
void setProcTreeMemTicks(const int value)
Set Set wait interval between memory monitor checks: ticks = milliseconds.
void setQCP(const std::string &value)
Set default QCP solver.
void setZeroRes(const double value)
Set The results of certain operations will be set to zero if abs(result) LE ZeroRes.
std::string sysIncDir()
Get SysInclude directory.
int pageSize()
Get Output file page size (=0 no paging)
void setFDOpt(const GAMSOptions::EFDOpt::EFDOptEnum value)
Set Options for finite differences.
void setOn115(const GAMSOptions::EOn115::EOn115Enum value)
Set Generate errors for unknown unique element in an equation.
int integer1()
Get Integer communication cell N.
static std::string eDigitText(GAMSOptions::EDigit::EDigitEnum type)
Get Switch default for "$on/offDigit" as text.
void setOptDir(const std::string &value)
Set Option file directory.
std::string license()
Get Use alternative license file.
void setOptCA(const double value)
Set Absolute Optimality criterion solver default.
void setCErr(const int value)
Set Compile time error limit.
static std::string eECImplicitLoadText(GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum type)
Get Allow implicit loading of symbols from embedded code or not as text.
std::string eolCom()
Get Switch default for "$on/offEolCom" and "$eolCom".
std::string decryptKey()
Get Key to decrypt a text file that was encrypted via $encrypt.
void setEolCom(const std::string &value)
Set Switch default for "$on/offEolCom" and "$eolCom".
std::string fileStemApFromEnv()
Get Append a string read from an environment variable to the "FileStem".
GAMSOptions::EHoldFixed::EHoldFixedEnum holdFixed()
Get Treat fixed variables as constants.
static std::string eImplicitAssignCode(GAMSOptions::EImplicitAssign::EImplicitAssignEnum type)
Get Switch default for "$on/offImplicitAssign" as code.
void setstrictSingleton(const GAMSOptions::EstrictSingleton::EstrictSingletonEnum value)
Set Error if assignment to singleton set has multiple elements.
int errorLog()
Get Max error message lines written to the log for each error.
void setJobTrace(const std::string &value)
Set Job trace string to be written to the trace file at the end of a GAMS job.
std::string reference()
Get Symbol reference file.
void setFreeEmbeddedPython(const GAMSOptions::EFreeEmbeddedPython::EFreeEmbeddedPythonEnum value)
Set Free external resources at the end of each embedded Python code blocks.
GAMSOptions::EEmpty::EEmptyEnum empty()
Get Switch default for "$on/offEmpty".
void setImplicitAssign(const GAMSOptions::EImplicitAssign::EImplicitAssignEnum value)
Set Switch default for "$on/offImplicitAssign".
static std::string eFilteredCode(GAMSOptions::EFiltered::EFilteredEnum type)
Get Switch between filtered and domain-checked read from GDX as code.
void setPutPS(const int value)
Set Page size for put files.
static std::string eImplicitAssignText(GAMSOptions::EImplicitAssign::EImplicitAssignEnum type)
Get Switch default for "$on/offImplicitAssign" as text.
void setUser5(const std::string &value)
Set User string N.
void setSolveLink(const GAMSOptions::ESolveLink::ESolveLinkEnum value)
Set Solver link option.
double eTLim()
Get Elapsed time limit in seconds.
int timer()
Get Instruction timer threshold in milli seconds.
void setHoldFixed(const GAMSOptions::EHoldFixed::EHoldFixedEnum value)
Set Treat fixed variables as constants.
static EgdxUels::EgdxUelsEnum egdxUelsFromCode(const std::string &str)
Get Unload labels or UELs to GDX either squeezed or full from std::string
bool removeDefine(const std::string &key)
Remove a double-dash option.
static EReferenceLineNo::EReferenceLineNoEnum eReferenceLineNoFromCode(const std::string &str)
Get Controls the line numbers written to a reference file from std::string
GAMSOptions::EgdxUels::EgdxUelsEnum gdxUels()
Get Unload labels or UELs to GDX either squeezed or full.
std::string MPEC()
Get default MPEC solver.
static EFiltered::EFilteredEnum eFilteredFromCode(const std::string &str)
Get Switch between filtered and domain-checked read from GDX from std::string
GAMSOptions::EPutNR::EPutNREnum putNR()
Get Numeric round format for put files.
double fDDelta()
Get Step size for finite differences.
void setSysOut(const GAMSOptions::ESysOut::ESysOutEnum value)
Set Solver Status file reporting option.
void setIDCGDXOutput(const std::string &value)
Set GDX file name for data for implicit output.
GAMSOptions::ESolveOpt::ESolveOptEnum solveOpt()
Get Multiple solve management.
GAMSOptions::EExecMode::EExecModeEnum execMode()
Get Limits on external programs that are allowed to be executed.
GAMSOptions::EStringChk::EStringChkEnum stringChk()
Get String substitution options.
int integer3()
Get Integer communication cell N.
GAMSOptions::EAppendOut::EAppendOutEnum appendOut()
Get Output file append option.
int limCol()
Get Maximum number of columns listed in one variable block.
void writeOptionFile(const std::string &optFileName)
Export options to an option file.
void setIDCGDXInput(const std::string &value)
Set GDX file name with data for implicit input.
void setSuppress(const GAMSOptions::ESuppress::ESuppressEnum value)
Set Compiler listing option.
std::string user3()
Get User string N.
std::string gridDir()
Get Grid file directory.
GAMSOptions::EShowOSMemory::EShowOSMemoryEnum showOSMemory()
Get Show the memory usage reported by the Operating System instead of the internal counting.
std::string output()
Get Listing file name.
static ESuffixDLVars::ESuffixDLVarsEnum eSuffixDLVarsFromCode(const std::string &str)
Get Switch default for "$on/offSuffixDLVars" from std::string
int procTreeMemTicks()
Get Set wait interval between memory monitor checks: ticks = milliseconds.
void setRMIQCP(const std::string &value)
Set default RMIQCP solver.
double zeroRes()
Get The results of certain operations will be set to zero if abs(result) LE ZeroRes.
GAMSOptions::EPreviousWork::EPreviousWorkEnum previousWork()
Get Indicator for writing workfile with previous workfile version.
GAMSOptions::EFDOpt::EFDOptEnum fDOpt()
Get Options for finite differences.
GAMSOptions::EAction::EActionEnum action()
Get GAMS processing request.
void setEMP(const std::string &value)
Set default EMP solver.
void setECImplicitLoad(const GAMSOptions::EECImplicitLoad::EECImplicitLoadEnum value)
Set Allow implicit loading of symbols from embedded code or not.
std::string getSolver(const std::string &modelType)
Get solver by model type.
GAMSOptions::EFileCase::EFileCaseEnum fileCase()
Get Casing of file names and paths (put, gdx, ref, $include, etc.)
std::string RMIQCP()
Get default RMIQCP solver.
void setNoNewVarEqu(const GAMSOptions::ENoNewVarEqu::ENoNewVarEquEnum value)
Set Triggers a compilation error when new equations or variable symbols are introduced.
void setLstTitleLeftAligned(const GAMSOptions::ELstTitleLeftAligned::ELstTitleLeftAlignedEnum value)
Set Write title of LST file all left aligned.
static EReplace::EReplaceEnum eReplaceFromCode(const std::string &str)
Get Switch between merge and replace when reading from GDX into non-empty symbol from std::string
int lstCase()
Get Output case option for LST file.
void setAppendOut(const GAMSOptions::EAppendOut::EAppendOutEnum value)
Set Output file append option.
GAMSOptions::EOn115::EOn115Enum on115()
Get Generate errors for unknown unique element in an equation.
void setBratio(const double value)
Set Basis detection threshold.
void setMINLP(const std::string &value)
Set default MINLP solver.
double optCR()
Get Relative Optimality criterion solver default.
static const char * gamsBuild()
Get GAMS build information.
void setThreads(const int value)
Set Number of processors to be used by a solver.
void setLicense(const std::string &value)
Set Use alternative license file.
void setWarnings(const int value)
Set Number of warnings permitted before a run terminates.
void setAction(const GAMSOptions::EAction::EActionEnum value)
Set GAMS processing request.
void setDomLim(const int value)
Set Domain violation limit solver default.
void setFileCase(const GAMSOptions::EFileCase::EFileCaseEnum value)
Set Casing of file names and paths (put, gdx, ref, $include, etc.)
int maxProcDir()
Get Maximum number of 225* process directories.
std::string RMPEC()
Get default RMPEC solver.
std::string encryptKey()
Get Key to encrypt a text file using $encrypt.
std::string RMIP()
Get default RMIP solver.
std::string profileFile()
Get Write profile information to this file.
void setLibIncDir(const std::string &value)
Set LibInclude directory.
std::string MCP()
Get default MCP solver.
void setDigit(const GAMSOptions::EDigit::EDigitEnum value)
Set Switch default for "$on/offDigit".
void setSymPrefix(const std::string &value)
Set Prefix all symbols encountered during compilation by the specified string in work file.
int forLim()
Get GAMS looping limit.
void setUser2(const std::string &value)
Set User string N.
void setMIQCP(const std::string &value)
Set default MIQCP solver.
std::string getInputDir(const int index)
Get an inputdir at position index of the inputdir list.
static std::string eMIIModeText(GAMSOptions::EMIIMode::EMIIModeEnum type)
Get Model Instance Mode as text.
GAMSOptions::EKeep::EKeepEnum keep()
Get Controls keeping or deletion of process directory and scratch files.
void setKeep(const GAMSOptions::EKeep::EKeepEnum value)
Set Controls keeping or deletion of process directory and scratch files.
GAMSOptions::EgdxCompress::EgdxCompressEnum gdxCompress()
Get Compression of generated GDX file.
void setProfileFile(const std::string &value)
Set Write profile information to this file.
void setErrMsg(const GAMSOptions::EErrMsg::EErrMsgEnum value)
Set Placing of compilation error messages.
void setgdxCompress(const GAMSOptions::EgdxCompress::EgdxCompressEnum value)
Set Compression of generated GDX file.
GAMSOptions::ECheckErrorLevel::ECheckErrorLevelEnum checkErrorLevel()
Get Check errorLevel automatically after executing external program.
GAMSOptions::EDumpOpt::EDumpOptEnum dumpOpt()
Get Writes preprocessed input to the file input.dmp.
static EgdxConvert::EgdxConvertEnum egdxConvertFromCode(const std::string &str)
Get Version of GDX files generated (for backward compatibility) from std::string
GAMSOptions::EErrMsg::EErrMsgEnum errMsg()
Get Placing of compilation error messages.
void setSolPrint(const GAMSOptions::ESolPrint::ESolPrintEnum value)
Set Solution report print option.
GAMSOptions::EProcTreeMemMonitor::EProcTreeMemMonitorEnum procTreeMemMonitor()
Get Monitor the memory used by the GAMS process tree.
std::string putDir()
Get Put file directory.
int putPS()
Get Page size for put files.
void setPrefixLoadPath(const GAMSOptions::EPrefixLoadPath::EPrefixLoadPathEnum value)
Set Prepend GAMS system directory to library load path.
std::string CNS()
Get default CNS solver.
double bratio()
Get Basis detection threshold.
void setOptFile(const int value)
Set Default option file.
std::string RMINLP()
Get default RMINLP solver.
void setSavePoint(const GAMSOptions::ESavePoint::ESavePointEnum value)
Set Save solver point in GDX file.
std::string multi()
Get Switch default for "$on/offMulti[R]".
int seed()
Get Random number seed.
void setPageSize(const int value)
Set Output file page size (=0 no paging)
int profile()
Get Execution profiling.
static EEmpty::EEmptyEnum eEmptyFromCode(const std::string &str)
Get Switch default for "$on/offEmpty" from std::string
int putPW()
Get Page width for put files.
std::string trace()
Get Trace file name.
void setHoldFixedAsync(const GAMSOptions::EHoldFixedAsync::EHoldFixedAsyncEnum value)
Set Allow HoldFixed for models solved asynchronously as well.
static std::string eReferenceLineNoText(GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum type)
Get Controls the line numbers written to a reference file as text.
double resLim()
Get Wall-clock time limit for solver.
static std::string eEmptyText(GAMSOptions::EEmpty::EEmptyEnum type)
Get Switch default for "$on/offEmpty" as text.
GAMSOptions::EDFormat::EDFormatEnum dFormat()
Get Date format.
void setPutDir(const std::string &value)
Set Put file directory.
void setUser1(const std::string &value)
Set User string N.
void setEncryptKey(const std::string &value)
Set Key to encrypt a text file using $encrypt.
void setUser3(const std::string &value)
Set User string N.
int limRow()
Get Maximum number of rows listed in one equation block.
void setNodLim(const int value)
Set Node limit in branch and bound tree.
void setSys11(const GAMSOptions::ESys11::ESys11Enum value)
Set Dynamic resorting if indices in assignment/data statements are not in natural order.
GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum referenceLineNo()
Get Controls the line numbers written to a reference file.
GAMSOptions::ESavePoint::ESavePointEnum savePoint()
Get Save solver point in GDX file.
int traceLevel()
Get Modelstat/Solvestat threshold used in conjunction with action=GT.
std::string symPrefix()
Get Prefix all symbols encountered during compilation by the specified string in work file.
std::string user2()
Get User string N.
GAMSOptions::EReplace::EReplaceEnum replace()
Get Switch between merge and replace when reading from GDX into non-empty symbol.
void setForceWork(const GAMSOptions::EForceWork::EForceWorkEnum value)
Set Force GAMS to process a save file created with a newer GAMS version or with execution errors.
void setScriptExit(const std::string &value)
Set Program or script to be executed at the end of a GAMS run.
GAMSOptions::EImplicitAssign::EImplicitAssignEnum implicitAssign()
Get Switch default for "$on/offImplicitAssign".
void removeInputDir(const int index)
Remove an inputdir at position index of the inputdir list.
int warnings()
Get Number of warnings permitted before a run terminates.
void setPageContr(const GAMSOptions::EPageContr::EPageContrEnum value)
Set Output file page control option.
GAMSOptions::EIntVarUp::EIntVarUpEnum intVarUp()
Get Set mode for default upper bounds on integer variables.
int iterLim()
Get Iteration limit of solver.
void setSuffixDLVars(const GAMSOptions::ESuffixDLVars::ESuffixDLVarsEnum value)
Set Switch default for "$on/offSuffixDLVars".
std::string iDCGDXOutput()
Get GDX file name for data for implicit output.
static std::string eReplaceCode(GAMSOptions::EReplace::EReplaceEnum type)
Get Switch between merge and replace when reading from GDX into non-empty symbol as code.
void setLogLine(const GAMSOptions::ELogLine::ELogLineEnum value)
Set Amount of line tracing to the log file.
void setErrorLog(const int value)
Set Max error message lines written to the log for each error.
static std::string eEmptyCode(GAMSOptions::EEmpty::EEmptyEnum type)
Get Switch default for "$on/offEmpty" as code.
int integer4()
Get Integer communication cell N.
void setZeroResRep(const GAMSOptions::EZeroResRep::EZeroResRepEnum value)
Set Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
std::string gridScript()
Get Grid submission script.
static std::string eReferenceLineNoCode(GAMSOptions::EReferenceLineNo::EReferenceLineNoEnum type)
Get Controls the line numbers written to a reference file as code.
int tabIn()
Get Tab spacing.
void setMaxExecError(const int value)
Set Execution time error limit.
std::string inlineCom()
Get Switch default for "$on/offInline" and "$inlineCom".
void setDumpOptGDX(const std::string &value)
Set Defines a GDX file name stem created when using DumpOpt.
void setListing(const GAMSOptions::EListing::EListingEnum value)
Set Switch default for "$on/offListing".
GAMSOptions::ESuppress::ESuppressEnum suppress()
Get Compiler listing option.
void setTraceOpt(const GAMSOptions::ETraceOpt::ETraceOptEnum value)
Set Trace file format option.
void setPutPW(const int value)
Set Page width for put files.
void setShowOSMemory(const GAMSOptions::EShowOSMemory::EShowOSMemoryEnum value)
Set Show the memory usage reported by the Operating System instead of the internal counting.
void setRMINLP(const std::string &value)
Set default RMINLP solver.
void setFileStem(const std::string &value)
Set Sets the file stem for output files which use the input file name as stem by default.
void setCharSet(const GAMSOptions::ECharSet::ECharSetEnum value)
Set Character set flag.
void setOutput(const std::string &value)
Set Listing file name.
void setSolveOpt(const GAMSOptions::ESolveOpt::ESolveOptEnum value)
Set Multiple solve management.
void setWorkFactor(const double value)
Set Memory Estimate multiplier for some solvers.
GAMSOptions::EMIIMode::EMIIModeEnum mIIMode()
Get Model Instance Mode.
void setLstCase(const int value)
Set Output case option for LST file.
static std::string egdxUelsText(GAMSOptions::EgdxUels::EgdxUelsEnum type)
Get Unload labels or UELs to GDX either squeezed or full as text.
void setResLim(const double value)
Set Wall-clock time limit for solver.
void setPageWidth(const int value)
Set Output file page width.
std::string user1()
Get User string N.
void setPutND(const int value)
Set Number of decimals for put files.
GAMSOptions::EForceWork::EForceWorkEnum forceWork()
Get Force GAMS to process a save file created with a newer GAMS version or with execution errors.
std::string MIP()
Get default MIP solver.
std::string expand()
Get Expanded (include) input file name.
GAMSOptions::ESolveLink::ESolveLinkEnum solveLink()
Get Solver link option.
GAMSOptions::EstrictSingleton::EstrictSingletonEnum strictSingleton()
Get Error if assignment to singleton set has multiple elements.
GAMSOptions::EListing::EListingEnum listing()
Get Switch default for "$on/offListing".
void setReplace(const GAMSOptions::EReplace::EReplaceEnum value)
Set Switch between merge and replace when reading from GDX into non-empty symbol.
int optFile()
Get Default option file.
GAMSOptions::EAppendExpand::EAppendExpandEnum appendExpand()
Get Expand file append option.
void setgdxConvert(const GAMSOptions::EgdxConvert::EgdxConvertEnum value)
Set Version of GDX files generated (for backward compatibility)
Definition: gams.h:91
GAMS processing request.
Definition: gamsoptions.h:63
EActionEnum
GAMS processing request.
Definition: gamsoptions.h:66
Expand file append option.
Definition: gamsoptions.h:77
EAppendExpandEnum
Expand file append option.
Definition: gamsoptions.h:80
Output file append option.
Definition: gamsoptions.h:87
EAppendOutEnum
Output file append option.
Definition: gamsoptions.h:90
Print solution listing when asynchronous solve (Grid or Threads) is used.
Definition: gamsoptions.h:97
EAsyncSolLstEnum
Print solution listing when asynchronous solve (Grid or Threads) is used.
Definition: gamsoptions.h:100
Switch to capture all model instances within a run.
Definition: gamsoptions.h:107
ECaptureModelInstanceEnum
Switch to capture all model instances within a run.
Definition: gamsoptions.h:110
Output case option for LST file.
Definition: gamsoptions.h:117
ECaseEnum
Output case option for LST file.
Definition: gamsoptions.h:120
Character set flag.
Definition: gamsoptions.h:127
ECharSetEnum
Character set flag.
Definition: gamsoptions.h:130
Check errorLevel automatically after executing external program.
Definition: gamsoptions.h:137
ECheckErrorLevelEnum
Check errorLevel automatically after executing external program.
Definition: gamsoptions.h:140
Switch default for "$on/offDigit".
Definition: gamsoptions.h:158
EDigitEnum
Switch default for "$on/offDigit".
Definition: gamsoptions.h:161
Writes preprocessed input to the file input.dmp.
Definition: gamsoptions.h:168
EDumpOptEnum
Writes preprocessed input to the file input.dmp.
Definition: gamsoptions.h:171
GAMS parameter logging.
Definition: gamsoptions.h:188
EDumpParmsEnum
GAMS parameter logging.
Definition: gamsoptions.h:191
Allow implicit loading of symbols from embedded code or not.
Definition: gamsoptions.h:199
EECImplicitLoadEnum
Allow implicit loading of symbols from embedded code or not.
Definition: gamsoptions.h:202
Switch default for "$on/offEmpty".
Definition: gamsoptions.h:209
EEmptyEnum
Switch default for "$on/offEmpty".
Definition: gamsoptions.h:212
Placing of compilation error messages.
Definition: gamsoptions.h:219
EErrMsgEnum
Placing of compilation error messages.
Definition: gamsoptions.h:222
Limits on external programs that are allowed to be executed.
Definition: gamsoptions.h:230
EExecModeEnum
Limits on external programs that are allowed to be executed.
Definition: gamsoptions.h:233
Options for finite differences.
Definition: gamsoptions.h:243
EFDOptEnum
Options for finite differences.
Definition: gamsoptions.h:246
Casing of file names and paths (put, gdx, ref, $include, etc.)
Definition: gamsoptions.h:261
EFileCaseEnum
Casing of file names and paths (put, gdx, ref, $include, etc.)
Definition: gamsoptions.h:264
Switch between filtered and domain-checked read from GDX.
Definition: gamsoptions.h:274
EFilteredEnum
Switch between filtered and domain-checked read from GDX.
Definition: gamsoptions.h:277
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Definition: gamsoptions.h:284
EForceWorkEnum
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Definition: gamsoptions.h:287
Free external resources at the end of each embedded Python code blocks.
Definition: gamsoptions.h:294
EFreeEmbeddedPythonEnum
Free external resources at the end of each embedded Python code blocks.
Definition: gamsoptions.h:297
Allow HoldFixed for models solved asynchronously as well.
Definition: gamsoptions.h:345
EHoldFixedAsyncEnum
Allow HoldFixed for models solved asynchronously as well.
Definition: gamsoptions.h:348
Treat fixed variables as constants.
Definition: gamsoptions.h:335
EHoldFixedEnum
Treat fixed variables as constants.
Definition: gamsoptions.h:338
Switch default for "$on/offImplicitAssign".
Definition: gamsoptions.h:355
EImplicitAssignEnum
Switch default for "$on/offImplicitAssign".
Definition: gamsoptions.h:358
Set mode for default upper bounds on integer variables.
Definition: gamsoptions.h:375
EIntVarUpEnum
Set mode for default upper bounds on integer variables.
Definition: gamsoptions.h:378
Allow solver to interact via command line input.
Definition: gamsoptions.h:365
EInteractiveSolverEnum
Allow solver to interact via command line input.
Definition: gamsoptions.h:368
Controls keeping or deletion of process directory and scratch files.
Definition: gamsoptions.h:387
EKeepEnum
Controls keeping or deletion of process directory and scratch files.
Definition: gamsoptions.h:390
Switch default for "$on/offListing".
Definition: gamsoptions.h:397
EListingEnum
Switch default for "$on/offListing".
Definition: gamsoptions.h:400
Amount of line tracing to the log file.
Definition: gamsoptions.h:407
ELogLineEnum
Amount of line tracing to the log file.
Definition: gamsoptions.h:410
Write title of LST file all left aligned.
Definition: gamsoptions.h:418
ELstTitleLeftAlignedEnum
Write title of LST file all left aligned.
Definition: gamsoptions.h:421
Model Instance Mode.
Definition: gamsoptions.h:428
EMIIModeEnum
Model Instance Mode.
Definition: gamsoptions.h:431
Triggers a compilation error when new equations or variable symbols are introduced.
Definition: gamsoptions.h:439
ENoNewVarEquEnum
Triggers a compilation error when new equations or variable symbols are introduced.
Definition: gamsoptions.h:442
Generate errors for unknown unique element in an equation.
Definition: gamsoptions.h:449
EOn115Enum
Generate errors for unknown unique element in an equation.
Definition: gamsoptions.h:452
Output file page control option.
Definition: gamsoptions.h:459
EPageContrEnum
Output file page control option.
Definition: gamsoptions.h:462
Prepend GAMS system directory to library load path.
Definition: gamsoptions.h:471
EPrefixLoadPathEnum
Prepend GAMS system directory to library load path.
Definition: gamsoptions.h:474
Indicator for writing workfile with previous workfile version.
Definition: gamsoptions.h:481
EPreviousWorkEnum
Indicator for writing workfile with previous workfile version.
Definition: gamsoptions.h:484
Monitor the memory used by the GAMS process tree.
Definition: gamsoptions.h:491
EProcTreeMemMonitorEnum
Monitor the memory used by the GAMS process tree.
Definition: gamsoptions.h:494
Numeric round format for put files.
Definition: gamsoptions.h:501
EPutNREnum
Numeric round format for put files.
Definition: gamsoptions.h:504
Controls the line numbers written to a reference file.
Definition: gamsoptions.h:514
EReferenceLineNoEnum
Controls the line numbers written to a reference file.
Definition: gamsoptions.h:517
Switch between merge and replace when reading from GDX into non-empty symbol.
Definition: gamsoptions.h:524
EReplaceEnum
Switch between merge and replace when reading from GDX into non-empty symbol.
Definition: gamsoptions.h:527
Save solver point in GDX file.
Definition: gamsoptions.h:534
ESavePointEnum
Save solver point in GDX file.
Definition: gamsoptions.h:537
Show the memory usage reported by the Operating System instead of the internal counting.
Definition: gamsoptions.h:547
EShowOSMemoryEnum
Show the memory usage reported by the Operating System instead of the internal counting.
Definition: gamsoptions.h:550
Solution report print option.
Definition: gamsoptions.h:558
ESolPrintEnum
Solution report print option.
Definition: gamsoptions.h:561
Multiple solve management.
Definition: gamsoptions.h:585
ESolveOptEnum
Multiple solve management.
Definition: gamsoptions.h:588
Summary of computing resources used by job steps.
Definition: gamsoptions.h:596
EStepSumEnum
Summary of computing resources used by job steps.
Definition: gamsoptions.h:599
String substitution options.
Definition: gamsoptions.h:616
EStringChkEnum
String substitution options.
Definition: gamsoptions.h:619
Switch default for "$on/offSuffixAlgebraVars".
Definition: gamsoptions.h:637
ESuffixAlgebraVarsEnum
Switch default for "$on/offSuffixAlgebraVars".
Definition: gamsoptions.h:640
Switch default for "$on/offSuffixDLVars".
Definition: gamsoptions.h:627
ESuffixDLVarsEnum
Switch default for "$on/offSuffixDLVars".
Definition: gamsoptions.h:630
Compiler listing option.
Definition: gamsoptions.h:647
ESuppressEnum
Compiler listing option.
Definition: gamsoptions.h:650
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Definition: gamsoptions.h:657
ESys10Enum
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Definition: gamsoptions.h:660
Dynamic resorting if indices in assignment/data statements are not in natural order.
Definition: gamsoptions.h:667
ESys11Enum
Dynamic resorting if indices in assignment/data statements are not in natural order.
Definition: gamsoptions.h:670
Solver Status file reporting option.
Definition: gamsoptions.h:678
ESysOutEnum
Solver Status file reporting option.
Definition: gamsoptions.h:681
Trace file format option.
Definition: gamsoptions.h:698
ETraceOptEnum
Trace file format option.
Definition: gamsoptions.h:701
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Definition: gamsoptions.h:712
EZeroResRepEnum
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Definition: gamsoptions.h:715
Compression of generated GDX file.
Definition: gamsoptions.h:304
EgdxCompressEnum
Compression of generated GDX file.
Definition: gamsoptions.h:307
Version of GDX files generated (for backward compatibility)
Definition: gamsoptions.h:314
EgdxConvertEnum
Version of GDX files generated (for backward compatibility)
Definition: gamsoptions.h:317
Unload labels or UELs to GDX either squeezed or full.
Definition: gamsoptions.h:325
EgdxUelsEnum
Unload labels or UELs to GDX either squeezed or full.
Definition: gamsoptions.h:328
Error if assignment to singleton set has multiple elements.
Definition: gamsoptions.h:606
EstrictSingletonEnum
Error if assignment to singleton set has multiple elements.
Definition: gamsoptions.h:609