Loading...
Searching...
No Matches
gamsoptions.h
1/*
2 *
3 * GAMS - General Algebraic Modeling System C++ API
4 *
5 * Copyright (c) 2017-2023 GAMS Development Corp. <support@gams.com>
6 * Copyright (c) 2017-2023 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 };
184 };
187 {
190 {
191 No = 0,
192 AcceptedParameters = 1,
193 FileOperationsAcceptedParameters = 2
194 };
195 };
198 {
201 {
202 OffECImplicitLoad = 0,
203 OnECImplicitLoad = 1
204 };
205 };
207 struct EEmpty
208 {
211 {
212 OffEmpty = 0,
213 OnEmpty = 1
214 };
215 };
217 struct EErrMsg
218 {
221 {
222 EndOfCompilerListing = 0,
223 FollowingError = 1,
224 Suppress = 2
225 };
226 };
229 {
232 {
233 EverythingAllowed = 0,
234 InteractiveShellsProhibited = 1,
235 CallAndExecuteProhibited = 2,
236 EchoAndPutOnlyToWorkdir = 3,
237 EchoAndPutProhibited = 4
238 };
239 };
241 struct EFDOpt
242 {
245 {
246 GHAnalyticHNumericGradScale = 0,
247 GHAnalyticHNumericFuncScale = 1,
248 GAnalyticFHNumericGradScale = 2,
249 GAnalyticFHNumericFuncScale = 3,
250 FGHNumericScale = 4,
251 GHAnalyticHNumericGradNoScale = 10,
252 GHAnalyticHNumericFuncNoScale = 11,
253 GAnalyticFHNumericGradNoScale = 12,
254 GAnalyticFHNumericFuncNoScale = 13,
255 FGHNumericNoScale = 14
256 };
257 };
260 {
263 {
264 DefaultCase = 0,
265 UpperCase = 1,
266 LowerCase = 2,
267 UpperCaseFileOnly = 3,
268 LowerCaseFileOnly = 4
269 };
270 };
273 {
276 {
277 OffFiltered = 0,
278 OnFiltered = 1
279 };
280 };
283 {
286 {
287 NoTranslation = 0,
288 TryTranslation = 1
289 };
290 };
293 {
296 {
297 Off = 0,
298 On = 1
299 };
300 };
303 {
306 {
307 DoNotCompressGDX = 0,
308 CompressGDX = 1
309 };
310 };
313 {
316 {
317 Version5 = 0,
318 Version6 = 1,
319 Version7 = 2
320 };
321 };
323 struct EgdxUels
324 {
327 {
328 squeezed = 0,
329 full = 1
330 };
331 };
334 {
337 {
338 FixedVarsNotTreatedAsConstants = 0,
339 FixedVarsTreatedAsConstants = 1
340 };
341 };
344 {
347 {
348 Off = 0,
349 On = 1
350 };
351 };
354 {
357 {
358 OffImplicitAssign = 0,
359 OnImplicitAssign = 1
360 };
361 };
364 {
367 {
368 NoInteraction = 0,
369 AllowInteraction = 1
370 };
371 };
374 {
377 {
378 INF = 0,
379 Pass100ToSolver = 1,
380 INFandLog = 2,
381 Pass100ToSolverAndError = 3
382 };
383 };
385 struct EKeep
386 {
389 {
390 DeleteProcDir = 0,
391 KeepProcDir = 1
392 };
393 };
395 struct EListing
396 {
399 {
400 OffListing = 0,
401 OnListing = 1
402 };
403 };
405 struct ELogLine
406 {
409 {
410 NoTracing = 0,
411 MinimumTracing = 1,
412 Automatic = 2
413 };
414 };
417 {
420 {
421 Off = 0,
422 On = 1
423 };
424 };
427 {
430 {
431 AllowNewVarEqu = 0,
432 DoNotAllowNewVarEqu = 1
433 };
434 };
436 struct EOn115
437 {
440 {
441 NoMessages = 0,
442 IssueMessages = 1
443 };
444 };
447 {
450 {
451 NoPageContrWithPadding = 0,
452 FortranStyle = 1,
453 NoPageContrNoPadding = 2,
454 FormfeedCharNewPage = 3
455 };
456 };
459 {
462 {
463 Off = 0,
464 On = 1
465 };
466 };
469 {
472 {
473 Off = 0,
474 On = 1
475 };
476 };
479 {
482 {
483 Off = 0,
484 On = 1
485 };
486 };
488 struct EPutNR
489 {
492 {
493 ForE = 0,
494 Rounded = 1,
495 Scientific = 2,
496 RoundedFloatingDec = 3,
497 ForEFloatingDec = 4
498 };
499 };
502 {
505 {
506 Single = 0,
507 Multi = 1
508 };
509 };
512 {
515 {
516 ActualLineNumber = 0,
517 StatementStart = 1
518 };
519 };
522 {
525 {
526 NoPointFile = 0,
527 LastSolvePointFile = 1,
528 EverySolvePointFile = 2,
529 LastSolvePointFileScrDir = 3,
530 EverySolvePointFileScrDir = 4
531 };
532 };
535 {
538 {
539 InternalAccounting = 0,
540 RSS = 1,
541 VSS = 2
542 };
543 };
546 {
549 {
550 RemoveSolLstFollowingSolves = 0,
551 IncludeSolLstFollowingSolves = 1,
552 SuppressAllSolInfo = 2
553 };
554 };
557 {
560 {
561 ChainScript = 0,
562 CallScript = 1,
563 CallModule = 2,
564 AsyncGrid = 3,
565 AsyncSimulate = 4,
566 LoadLibrary = 5,
567 LoadLibraryAsync = 6,
568 LoadLibraryAsyncSimulate = 7
569 };
570 };
572 struct EStepSum
573 {
576 {
577 NoStepSummmary = 0,
578 StepSummary = 1
579 };
580 };
583 {
586 {
587 FirstRecord = 0,
588 Error = 1
589 };
590 };
593 {
596 {
597 NoError = 0,
598 Error = 1,
599 NoErrorRemoveSymbol = 2
600 };
601 };
604 {
607 {
608 OffSuffixDLVars = 0,
609 OnSuffixDLVars = 1
610 };
611 };
614 {
617 {
618 OffSuffixAlgebraVars = 0,
619 OnSuffixAlgebraVars = 1
620 };
621 };
624 {
627 {
628 StandardCompilerListing = 0,
629 SuppressCompilerListing = 1
630 };
631 };
633 struct ESys10
634 {
637 {
638 Disable = 0,
639 Enable = 1
640 };
641 };
643 struct ESys11
644 {
647 {
648 AutomaticOptimization = 0,
649 NoOptimization = 1,
650 AlwaysOptimize = 2
651 };
652 };
654 struct ESysOut
655 {
658 {
659 SuppressAdditionalSolverOutput = 0,
660 IncludeAdditionalSolverOutput = 1
661 };
662 };
664 struct ETFormat
665 {
668 {
669 Colon = 0,
670 Dot = 1
671 };
672 };
675 {
678 {
679 SolverAndGAMSStepTraceWOHeaders = 0,
680 SolverAndGAMSStepTrace = 1,
681 SolverStepTraceOnly = 2,
682 TraceFileFormatGAMSPerformanceWorld = 3,
683 TraceFileFormatSupportingNLPEC = 4,
684 TraceFileWithAllAvailableTraceFields = 5
685 };
686 };
689 {
692 {
693 NoWarning = 0,
694 IssueWarning = 1
695 };
696 };
697
700
702 static const char* gamsBuild();
703
705 static const char* gamsVersion();
706
709 LogId logID();
710
712 void writeOptionFile(const std::string& optFileName);
713
715 void setAllModelTypes(const std::string& solver);
716
719
721 void addInputDir(const std::string value);
722
724 std::string getInputDir(const int index);
725
727 void setInputDir(const std::string value, const int index);
728
730 void removeInputDir(const int index);
731
733 void setDefine(const std::string &key, const std::string &value);
734
736 std::string getDefine(const std::string& key);
737
739 bool removeDefine(const std::string& key);
740
742 std::string gdx();
743
745 void setGdx(const std::string& value);
746
749
752
754 static EAction::EActionEnum eActionFromCode(const std::string &str);
755
758
761
764
767
770
773
776
779
781 double bratio();
782
784 void setBratio(const double value);
785
788
791
793 int lstCase();
794
796 void setLstCase(const int value);
797
799 int cErr();
800
802 void setCErr(const int value);
803
806
809
812
815
817 std::string decryptKey();
818
820 void setDecryptKey(const std::string& value);
821
824
827
830
833
835 static EDigit::EDigitEnum eDigitFromCode(const std::string &str);
836
839
842
844 int domLim();
845
847 void setDomLim(const int value);
848
851
854
856 std::string dumpOptGDX();
857
859 void setDumpOptGDX(const std::string& value);
860
863
866
868 std::string dumpParmsLogPrefix();
869
871 void setDumpParmsLogPrefix(const std::string& value);
872
875
878
881
884
887
890
893
895 static EEmpty::EEmptyEnum eEmptyFromCode(const std::string &str);
896
899
902
904 std::string encryptKey();
905
907 void setEncryptKey(const std::string& value);
908
910 std::string eolCom();
911
913 void setEolCom(const std::string& value);
914
917
920
922 int errorLog();
923
925 void setErrorLog(const int value);
926
928 double eTLim();
929
931 void setETLim(const double value);
932
935
938
940 std::string expand();
941
943 void setExpand(const std::string& value);
944
946 double fDDelta();
947
949 void setFDDelta(const double value);
950
953
956
958 std::string fErr();
959
961 void setFErr(const std::string& value);
962
965
968
970 std::string fileStem();
971
973 void setFileStem(const std::string& value);
974
976 std::string fileStemApFromEnv();
977
979 void setFileStemApFromEnv(const std::string& value);
980
983
986
988 static EFiltered::EFilteredEnum eFilteredFromCode(const std::string &str);
989
992
995
998
1000 void setForceOptFile(const int value);
1001
1004
1007
1009 int forLim();
1010
1012 void setForLim(const int value);
1013
1016
1019
1022
1025
1028
1031
1034
1037
1040
1043
1046
1048 static EgdxUels::EgdxUelsEnum egdxUelsFromCode(const std::string &str);
1049
1052
1055
1057 std::string gridDir();
1058
1060 void setGridDir(const std::string& value);
1061
1063 std::string gridScript();
1064
1066 void setGridScript(const std::string& value);
1067
1069 double heapLimit();
1070
1072 void setHeapLimit(const double value);
1073
1076
1079
1082
1085
1087 std::string iDCGDXInput();
1088
1090 void setIDCGDXInput(const std::string& value);
1091
1093 std::string iDCGDXOutput();
1094
1096 void setIDCGDXOutput(const std::string& value);
1097
1100
1103
1106
1109
1112
1114 std::string inlineCom();
1115
1117 void setInlineCom(const std::string& value);
1118
1121
1123 void setInteger1(const int value);
1124
1127
1129 void setInteger2(const int value);
1130
1133
1135 void setInteger3(const int value);
1136
1139
1141 void setInteger4(const int value);
1142
1145
1147 void setInteger5(const int value);
1148
1151
1154
1157
1160
1162 int iterLim();
1163
1165 void setIterLim(const int value);
1166
1168 std::string jobTrace();
1169
1171 void setJobTrace(const std::string& value);
1172
1175
1178
1180 std::string libIncDir();
1181
1183 void setLibIncDir(const std::string& value);
1184
1186 std::string license();
1187
1189 void setLicense(const std::string& value);
1190
1192 int limCol();
1193
1195 void setLimCol(const int value);
1196
1198 int limRow();
1199
1201 void setLimRow(const int value);
1202
1205
1208
1210 static EListing::EListingEnum eListingFromCode(const std::string &str);
1211
1214
1217
1220
1223
1226
1229
1232
1234 void setMaxExecError(const int value);
1235
1238
1240 void setMaxProcDir(const int value);
1241
1243 std::string multi();
1244
1246 void setMulti(const std::string& value);
1247
1249 int nodLim();
1250
1252 void setNodLim(const int value);
1253
1256
1259
1262
1265
1267 double optCA();
1268
1270 void setOptCA(const double value);
1271
1273 double optCR();
1274
1276 void setOptCR(const double value);
1277
1279 std::string optDir();
1280
1282 void setOptDir(const std::string& value);
1283
1285 int optFile();
1286
1288 void setOptFile(const int value);
1289
1291 std::string output();
1292
1294 void setOutput(const std::string& value);
1295
1298
1301
1304
1306 void setPageSize(const int value);
1307
1310
1312 void setPageWidth(const int value);
1313
1315 std::string pLicense();
1316
1318 void setPLicense(const std::string& value);
1319
1322
1325
1328
1331
1334
1337
1340
1342 void setProcTreeMemTicks(const int value);
1343
1345 int profile();
1346
1348 void setProfile(const int value);
1349
1351 std::string profileFile();
1352
1354 void setProfileFile(const std::string& value);
1355
1357 double profileTol();
1358
1360 void setProfileTol(const double value);
1361
1363 std::string putDir();
1364
1366 void setPutDir(const std::string& value);
1367
1369 int putND();
1370
1372 void setPutND(const int value);
1373
1376
1379
1381 int putPS();
1382
1384 void setPutPS(const int value);
1385
1387 int putPW();
1388
1390 void setPutPW(const int value);
1391
1394
1397
1399 std::string reference();
1400
1402 void setReference(const std::string& value);
1403
1406
1409
1412
1415
1418
1420 double resLim();
1421
1423 void setResLim(const double value);
1424
1427
1430
1432 std::string scriptExit();
1433
1435 void setScriptExit(const std::string& value);
1436
1438 int seed();
1439
1441 void setSeed(const int value);
1442
1445
1448
1451
1454
1457
1460
1463
1466
1469
1472
1475
1478
1481
1484
1487
1490
1493
1496
1499
1502
1505
1508
1511
1514
1516 std::string symbol();
1517
1519 void setSymbol(const std::string& value);
1520
1522 std::string symPrefix();
1523
1525 void setSymPrefix(const std::string& value);
1526
1529
1532
1535
1538
1540 int sys12();
1541
1543 void setSys12(const int value);
1544
1546 std::string sysIncDir();
1547
1549 void setSysIncDir(const std::string& value);
1550
1553
1556
1558 int tabIn();
1559
1561 void setTabIn(const int value);
1562
1565
1568
1570 int threads();
1571
1573 void setThreads(const int value);
1574
1577
1579 void setThreadsAsync(const int value);
1580
1582 int timer();
1583
1585 void setTimer(const int value);
1586
1588 std::string trace();
1589
1591 void setTrace(const std::string& value);
1592
1595
1597 void setTraceLevel(const int value);
1598
1601
1604
1606 std::string user1();
1607
1609 void setUser1(const std::string& value);
1610
1612 std::string user2();
1613
1615 void setUser2(const std::string& value);
1616
1618 std::string user3();
1619
1621 void setUser3(const std::string& value);
1622
1624 std::string user4();
1625
1627 void setUser4(const std::string& value);
1628
1630 std::string user5();
1631
1633 void setUser5(const std::string& value);
1634
1637
1639 void setWarnings(const int value);
1640
1642 double workFactor();
1643
1645 void setWorkFactor(const double value);
1646
1648 double workSpace();
1649
1651 void setWorkSpace(const double value);
1652
1654 double zeroRes();
1655
1657 void setZeroRes(const double value);
1658
1661
1664
1666 std::string LP();
1667
1669 void setLP(const std::string& value);
1670
1672 std::string MIP();
1673
1675 void setMIP(const std::string& value);
1676
1678 std::string RMIP();
1679
1681 void setRMIP(const std::string& value);
1682
1684 std::string NLP();
1685
1687 void setNLP(const std::string& value);
1688
1690 std::string MCP();
1691
1693 void setMCP(const std::string& value);
1694
1696 std::string MPEC();
1697
1699 void setMPEC(const std::string& value);
1700
1702 std::string RMPEC();
1703
1705 void setRMPEC(const std::string& value);
1706
1708 std::string CNS();
1709
1711 void setCNS(const std::string& value);
1712
1714 std::string DNLP();
1715
1717 void setDNLP(const std::string& value);
1718
1720 std::string RMINLP();
1721
1723 void setRMINLP(const std::string& value);
1724
1726 std::string MINLP();
1727
1729 void setMINLP(const std::string& value);
1730
1732 std::string QCP();
1733
1735 void setQCP(const std::string& value);
1736
1738 std::string MIQCP();
1739
1741 void setMIQCP(const std::string& value);
1742
1744 std::string RMIQCP();
1745
1747 void setRMIQCP(const std::string& value);
1748
1750 std::string EMP();
1751
1753 void setEMP(const std::string& value);
1754
1756 std::string getSolver(const std::string& modelType);
1757
1759 void setSolver(const std::string& modelType, const std::string& solver);
1760
1761private:
1762 std::shared_ptr<GAMSOptionsImpl> mImpl;
1763 GAMSOptions(GAMSWorkspace workspace, const GAMSOptions* optFrom);
1764 GAMSOptions(GAMSWorkspace workspace, const std::string& optFile = "");
1765 int appendLog();
1766 void setAppendLog(const int value);
1767 std::string connectIn();
1768 void setConnectIn(const std::string& value);
1769 std::string connectOut();
1770 void setConnectOut(const std::string& value);
1771 std::string curDir();
1772 void setCurDir(const std::string& value);
1773 int debug();
1774 void setDebug(const int value);
1775 std::string docFile();
1776 void setDocFile(const std::string& value);
1777 std::string epsToZero();
1778 void setEpsToZero(const std::string& value);
1779 std::string errNam();
1780 void setErrNam(const std::string& value);
1781 int fSave();
1782 void setFSave(const int value);
1783 int g205();
1784 void setG205(const int value);
1785 std::string iDCGenerateGDX();
1786 void setIDCGenerateGDX(const std::string& value);
1787 std::string iDCGenerateGDXInput();
1788 void setIDCGenerateGDXInput(const std::string& value);
1789 std::string iDCGenerateGDXOutput();
1790 void setIDCGenerateGDXOutput(const std::string& value);
1791 std::string iDCGenerateJSON();
1792 void setIDCGenerateJSON(const std::string& value);
1793 std::string iDCJSON();
1794 void setIDCJSON(const std::string& value);
1795 int iDCProtect();
1796 void setIDCProtect(const int value);
1797 int iDE();
1798 void setIDE(const int value);
1799 std::string input();
1800 void setInput(const std::string& value);
1801 std::string logFile();
1802 void setLogFile(const std::string& value);
1803 int logOption();
1804 void setLogOption(const int value);
1805 int maxGenericFiles();
1806 void setMaxGenericFiles(const int value);
1807 int mCPRHoldfx();
1808 void setMCPRHoldfx(const int value);
1809 int multiPass();
1810 void setMultiPass(const int value);
1811 int noCr();
1812 void setNoCr(const int value);
1813 int opt();
1814 void setOpt(const int value);
1815 int pID2Error();
1816 void setPID2Error(const int value);
1817 std::string procDir();
1818 void setProcDir(const std::string& value);
1819 std::string procDirPath();
1820 void setProcDirPath(const std::string& value);
1821 int relPath();
1822 void setRelPath(const int value);
1823 std::string restart();
1824 void setRestart(const std::string& value);
1825 std::string restartNamed();
1826 void setRestartNamed(const std::string& value);
1827 std::string save();
1828 void setSave(const std::string& value);
1829 std::string saveObfuscate();
1830 void setSaveObfuscate(const std::string& value);
1831 std::string scrDir();
1832 void setScrDir(const std::string& value);
1833 std::string scrExt();
1834 void setScrExt(const std::string& value);
1835 std::string scriptFrst();
1836 void setScriptFrst(const std::string& value);
1837 std::string scriptNext();
1838 void setScriptNext(const std::string& value);
1839 std::string scrNam();
1840 void setScrNam(const std::string& value);
1841 int serverRun();
1842 void setServerRun(const int value);
1843 std::string solver();
1844 void setSolver(const std::string& value);
1845 std::string solverCntr();
1846 void setSolverCntr(const std::string& value);
1847 std::string solverDict();
1848 void setSolverDict(const std::string& value);
1849 std::string solverInst();
1850 void setSolverInst(const std::string& value);
1851 std::string solverMatr();
1852 void setSolverMatr(const std::string& value);
1853 std::string solverSolu();
1854 void setSolverSolu(const std::string& value);
1855 std::string solverStat();
1856 void setSolverStat(const std::string& value);
1857 std::string sparseRun();
1858 void setSparseRun(const std::string& value);
1859 std::string sqaCmex();
1860 void setSqaCmex(const std::string& value);
1861 std::string subSys();
1862 void setSubSys(const std::string& value);
1863 int sys14();
1864 void setSys14(const int value);
1865 int sys15();
1866 void setSys15(const int value);
1867 int sys16();
1868 void setSys16(const int value);
1869 int sys17();
1870 void setSys17(const int value);
1871 int sys18();
1872 void setSys18(const int value);
1873 int sys19();
1874 void setSys19(const int value);
1875 std::string sysDir();
1876 void setSysDir(const std::string& value);
1877 int useDLL();
1878 void setUseDLL(const int value);
1879 std::string workDir();
1880 void setWorkDir(const std::string& value);
1881 int writeOutput();
1882 void setwriteOutput(const int value);
1883 std::string xSave();
1884 void setXSave(const std::string& value);
1885 std::string xSaveObfuscate();
1886 void setXSaveObfuscate(const std::string& value);
1887
1888};
1889}
1890#endif // GAMSOPTIONS_H
1891
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.
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 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 default for "$on/offFiltered" 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::EPyMultInst::EPyMultInstEnum pyMultInst()
Get GAMS/Python Multiple Instance Interpreter.
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 default for "$on/offFiltered".
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.
void setOptCR(const double value)
Set Relative Optimality criterion solver default.
int threads()
Get Number of threads 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 default for "$on/offFiltered".
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 default for "$on/offFiltered" 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 default for "$on/offFiltered" 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::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.
void setPyMultInst(const GAMSOptions::EPyMultInst::EPyMultInstEnum value)
Set GAMS/Python Multiple Instance Interpreter.
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.
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 threads 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.
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.
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.
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 setWorkFactor(const double value)
Set Memory Estimate multiplier for some solvers.
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".
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:187
EDumpParmsEnum
GAMS parameter logging.
Definition: gamsoptions.h:190
Allow implicit loading of symbols from embedded code or not.
Definition: gamsoptions.h:198
EECImplicitLoadEnum
Allow implicit loading of symbols from embedded code or not.
Definition: gamsoptions.h:201
Switch default for "$on/offEmpty".
Definition: gamsoptions.h:208
EEmptyEnum
Switch default for "$on/offEmpty".
Definition: gamsoptions.h:211
Placing of compilation error messages.
Definition: gamsoptions.h:218
EErrMsgEnum
Placing of compilation error messages.
Definition: gamsoptions.h:221
Limits on external programs that are allowed to be executed.
Definition: gamsoptions.h:229
EExecModeEnum
Limits on external programs that are allowed to be executed.
Definition: gamsoptions.h:232
Options for finite differences.
Definition: gamsoptions.h:242
EFDOptEnum
Options for finite differences.
Definition: gamsoptions.h:245
Casing of file names and paths (put, gdx, ref, $include, etc.)
Definition: gamsoptions.h:260
EFileCaseEnum
Casing of file names and paths (put, gdx, ref, $include, etc.)
Definition: gamsoptions.h:263
Switch default for "$on/offFiltered".
Definition: gamsoptions.h:273
EFilteredEnum
Switch default for "$on/offFiltered".
Definition: gamsoptions.h:276
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Definition: gamsoptions.h:283
EForceWorkEnum
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Definition: gamsoptions.h:286
Free external resources at the end of each embedded Python code blocks.
Definition: gamsoptions.h:293
EFreeEmbeddedPythonEnum
Free external resources at the end of each embedded Python code blocks.
Definition: gamsoptions.h:296
Allow HoldFixed for models solved asynchronously as well.
Definition: gamsoptions.h:344
EHoldFixedAsyncEnum
Allow HoldFixed for models solved asynchronously as well.
Definition: gamsoptions.h:347
Treat fixed variables as constants.
Definition: gamsoptions.h:334
EHoldFixedEnum
Treat fixed variables as constants.
Definition: gamsoptions.h:337
Switch default for "$on/offImplicitAssign".
Definition: gamsoptions.h:354
EImplicitAssignEnum
Switch default for "$on/offImplicitAssign".
Definition: gamsoptions.h:357
Set mode for default upper bounds on integer variables.
Definition: gamsoptions.h:374
EIntVarUpEnum
Set mode for default upper bounds on integer variables.
Definition: gamsoptions.h:377
Allow solver to interact via command line input.
Definition: gamsoptions.h:364
EInteractiveSolverEnum
Allow solver to interact via command line input.
Definition: gamsoptions.h:367
Controls keeping or deletion of process directory and scratch files.
Definition: gamsoptions.h:386
EKeepEnum
Controls keeping or deletion of process directory and scratch files.
Definition: gamsoptions.h:389
Switch default for "$on/offListing".
Definition: gamsoptions.h:396
EListingEnum
Switch default for "$on/offListing".
Definition: gamsoptions.h:399
Amount of line tracing to the log file.
Definition: gamsoptions.h:406
ELogLineEnum
Amount of line tracing to the log file.
Definition: gamsoptions.h:409
Write title of LST file all left aligned.
Definition: gamsoptions.h:417
ELstTitleLeftAlignedEnum
Write title of LST file all left aligned.
Definition: gamsoptions.h:420
Triggers a compilation error when new equations or variable symbols are introduced.
Definition: gamsoptions.h:427
ENoNewVarEquEnum
Triggers a compilation error when new equations or variable symbols are introduced.
Definition: gamsoptions.h:430
Generate errors for unknown unique element in an equation.
Definition: gamsoptions.h:437
EOn115Enum
Generate errors for unknown unique element in an equation.
Definition: gamsoptions.h:440
Output file page control option.
Definition: gamsoptions.h:447
EPageContrEnum
Output file page control option.
Definition: gamsoptions.h:450
Prepend GAMS system directory to library load path.
Definition: gamsoptions.h:459
EPrefixLoadPathEnum
Prepend GAMS system directory to library load path.
Definition: gamsoptions.h:462
Indicator for writing workfile with previous workfile version.
Definition: gamsoptions.h:469
EPreviousWorkEnum
Indicator for writing workfile with previous workfile version.
Definition: gamsoptions.h:472
Monitor the memory used by the GAMS process tree.
Definition: gamsoptions.h:479
EProcTreeMemMonitorEnum
Monitor the memory used by the GAMS process tree.
Definition: gamsoptions.h:482
Numeric round format for put files.
Definition: gamsoptions.h:489
EPutNREnum
Numeric round format for put files.
Definition: gamsoptions.h:492
GAMS/Python Multiple Instance Interpreter.
Definition: gamsoptions.h:502
EPyMultInstEnum
GAMS/Python Multiple Instance Interpreter.
Definition: gamsoptions.h:505
Controls the line numbers written to a reference file.
Definition: gamsoptions.h:512
EReferenceLineNoEnum
Controls the line numbers written to a reference file.
Definition: gamsoptions.h:515
Save solver point in GDX file.
Definition: gamsoptions.h:522
ESavePointEnum
Save solver point in GDX file.
Definition: gamsoptions.h:525
Show the memory usage reported by the Operating System instead of the internal counting.
Definition: gamsoptions.h:535
EShowOSMemoryEnum
Show the memory usage reported by the Operating System instead of the internal counting.
Definition: gamsoptions.h:538
Solution report print option.
Definition: gamsoptions.h:546
ESolPrintEnum
Solution report print option.
Definition: gamsoptions.h:549
Summary of computing resources used by job steps.
Definition: gamsoptions.h:573
EStepSumEnum
Summary of computing resources used by job steps.
Definition: gamsoptions.h:576
String substitution options.
Definition: gamsoptions.h:593
EStringChkEnum
String substitution options.
Definition: gamsoptions.h:596
Switch default for "$on/offSuffixAlgebraVars".
Definition: gamsoptions.h:614
ESuffixAlgebraVarsEnum
Switch default for "$on/offSuffixAlgebraVars".
Definition: gamsoptions.h:617
Switch default for "$on/offSuffixDLVars".
Definition: gamsoptions.h:604
ESuffixDLVarsEnum
Switch default for "$on/offSuffixDLVars".
Definition: gamsoptions.h:607
Compiler listing option.
Definition: gamsoptions.h:624
ESuppressEnum
Compiler listing option.
Definition: gamsoptions.h:627
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Definition: gamsoptions.h:634
ESys10Enum
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Definition: gamsoptions.h:637
Dynamic resorting if indices in assignment/data statements are not in natural order.
Definition: gamsoptions.h:644
ESys11Enum
Dynamic resorting if indices in assignment/data statements are not in natural order.
Definition: gamsoptions.h:647
Solver Status file reporting option.
Definition: gamsoptions.h:655
ESysOutEnum
Solver Status file reporting option.
Definition: gamsoptions.h:658
Trace file format option.
Definition: gamsoptions.h:675
ETraceOptEnum
Trace file format option.
Definition: gamsoptions.h:678
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Definition: gamsoptions.h:689
EZeroResRepEnum
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Definition: gamsoptions.h:692
Compression of generated GDX file.
Definition: gamsoptions.h:303
EgdxCompressEnum
Compression of generated GDX file.
Definition: gamsoptions.h:306
Version of GDX files generated (for backward compatibility)
Definition: gamsoptions.h:313
EgdxConvertEnum
Version of GDX files generated (for backward compatibility)
Definition: gamsoptions.h:316
Unload labels or UELs to GDX either squeezed or full.
Definition: gamsoptions.h:324
EgdxUelsEnum
Unload labels or UELs to GDX either squeezed or full.
Definition: gamsoptions.h:327
Error if assignment to singleton set has multiple elements.
Definition: gamsoptions.h:583
EstrictSingletonEnum
Error if assignment to singleton set has multiple elements.
Definition: gamsoptions.h:586