Loading...
Searching...
No Matches
gamsoptions.h
1/*
2 *
3 * GAMS - General Algebraic Modeling System C++ API
4 *
5 * Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
6 * Copyright (c) 2017-2026 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 StdOut = 2,
94 StdErr = 3
95 };
96 };
99 {
102 {
103 Off = 0,
104 On = 1
105 };
106 };
109 {
112 {
113 Off = 0,
114 On = 1
115 };
116 };
118 struct ECase
119 {
122 {
123 MixedCase = 0,
124 UpperCase = 1
125 };
126 };
128 struct ECharSet
129 {
132 {
133 LimitedGAMSCharSet = 0,
134 AnyChar = 1
135 };
136 };
139 {
142 {
143 Off = 0,
144 On = 1
145 };
146 };
148 struct EDFormat
149 {
152 {
153 Slash = 0,
154 Dot = 1,
155 Dash = 2
156 };
157 };
159 struct EDigit
160 {
163 {
164 OffDigit = 0,
165 OnDigit = 1
166 };
167 };
169 struct EDumpOpt
170 {
173 {
174 No = 0,
175 RefDataOriginalSetElementNames = 1,
176 RefDataNewSetElementNames = 2,
177 RefDataNewSetElementNamesDropSymbolText = 3,
178 RefSymbol = 4,
179 Deprecated_10 = 10,
180 InputFileWOComments = 11,
181 Deprecated_12 = 12,
182 Deprecated_19 = 19,
183 Deprecated_20 = 20,
184 InputFileWithComments = 21,
185 SplitBlocksDumpWithComments = 22
186 };
187 };
190 {
193 {
194 No = 0,
195 AcceptedParameters = 1,
196 FileOperationsAcceptedParameters = 2
197 };
198 };
201 {
204 {
205 OffECImplicitLoad = 0,
206 OnECImplicitLoad = 1
207 };
208 };
211 {
214 {
215 OffECLogLine = 0,
216 OnECLogLine = 1
217 };
218 };
220 struct EEmpty
221 {
224 {
225 OffEmpty = 0,
226 OnEmpty = 1
227 };
228 };
230 struct EErrMsg
231 {
234 {
235 EndOfCompilerListing = 0,
236 FollowingError = 1,
237 Suppress = 2
238 };
239 };
242 {
245 {
246 EverythingAllowed = 0,
247 InteractiveShellsProhibited = 1,
248 CallAndExecuteProhibited = 2,
249 EchoAndPutOnlyToWorkdir = 3,
250 EchoAndPutProhibited = 4
251 };
252 };
254 struct EFDOpt
255 {
258 {
259 GHAnalyticHNumericGradScale = 0,
260 GHAnalyticHNumericFuncScale = 1,
261 GAnalyticFHNumericGradScale = 2,
262 GAnalyticFHNumericFuncScale = 3,
263 FGHNumericScale = 4,
264 GHAnalyticHNumericGradNoScale = 10,
265 GHAnalyticHNumericFuncNoScale = 11,
266 GAnalyticFHNumericGradNoScale = 12,
267 GAnalyticFHNumericFuncNoScale = 13,
268 FGHNumericNoScale = 14
269 };
270 };
273 {
276 {
277 DefaultCase = 0,
278 UpperCase = 1,
279 LowerCase = 2,
280 UpperCaseFileOnly = 3,
281 LowerCaseFileOnly = 4
282 };
283 };
286 {
289 {
290 OffFiltered = 0,
291 OnFiltered = 1
292 };
293 };
296 {
299 {
300 NoTranslation = 0,
301 TryTranslation = 1
302 };
303 };
306 {
309 {
310 Off = 0,
311 On = 1
312 };
313 };
316 {
319 {
320 DoNotCompressGDX = 0,
321 CompressGDX = 1
322 };
323 };
326 {
329 {
330 Version5 = 0,
331 Version6 = 1,
332 Version7 = 2
333 };
334 };
336 struct EgdxUels
337 {
340 {
341 squeezed = 0,
342 full = 1
343 };
344 };
347 {
350 {
351 FixedVarsNotTreatedAsConstants = 0,
352 FixedVarsTreatedAsConstants = 1
353 };
354 };
357 {
360 {
361 Off = 0,
362 On = 1
363 };
364 };
367 {
370 {
371 OffImplicitAssign = 0,
372 OnImplicitAssign = 1
373 };
374 };
377 {
380 {
381 NoInteraction = 0,
382 AllowInteraction = 1
383 };
384 };
387 {
390 {
391 INF = 0,
392 Pass100ToSolver = 1,
393 INFandLog = 2,
394 Pass100ToSolverAndError = 3
395 };
396 };
398 struct EKeep
399 {
402 {
403 DeleteProcDir = 0,
404 KeepProcDir = 1
405 };
406 };
408 struct EListing
409 {
412 {
413 OffListing = 0,
414 OnListing = 1
415 };
416 };
418 struct ELogLine
419 {
422 {
423 NoTracing = 0,
424 MinimumTracing = 1,
425 Automatic = 2
426 };
427 };
430 {
433 {
434 Off = 0,
435 On = 1
436 };
437 };
440 {
443 {
444 Default = 0,
445 Experimental = 1
446 };
447 };
449 struct EMIIMode
450 {
453 {
454 Off = 0,
455 SingleMI = 1,
456 MultiMI = 2
457 };
458 };
461 {
464 {
465 AllowNewVarEqu = 0,
466 DoNotAllowNewVarEqu = 1
467 };
468 };
470 struct EOn115
471 {
474 {
475 NoMessages = 0,
476 IssueMessages = 1
477 };
478 };
481 {
484 {
485 NoPageContrWithPadding = 0,
486 FortranStyle = 1,
487 NoPageContrNoPadding = 2,
488 FormfeedCharNewPage = 3
489 };
490 };
493 {
496 {
497 Off = 0,
498 On = 1
499 };
500 };
503 {
506 {
507 Off = 0,
508 On = 1
509 };
510 };
513 {
516 {
517 Off = 0,
518 On = 1
519 };
520 };
522 struct EPutNR
523 {
526 {
527 ForE = 0,
528 Rounded = 1,
529 Scientific = 2,
530 RoundedFloatingDec = 3,
531 ForEFloatingDec = 4
532 };
533 };
536 {
539 {
540 ActualLineNumber = 0,
541 StatementStart = 1
542 };
543 };
545 struct EReplace
546 {
549 {
550 Merge = 0,
551 Replace = 1
552 };
553 };
556 {
559 {
560 MarginalsSolverChoice = -1,
561 MarginalsNotRequested = 0,
562 MarginalsRequestedButOptional = 1,
563 MarginalsDemanded = 2
564 };
565 };
568 {
571 {
572 NoPointFile = 0,
573 LastSolvePointFile = 1,
574 EverySolvePointFile = 2,
575 LastSolvePointFileScrDir = 3,
576 EverySolvePointFileScrDir = 4
577 };
578 };
581 {
584 {
585 InternalAccounting = 0,
586 RSS = 1,
587 VSS = 2
588 };
589 };
592 {
595 {
596 RemoveSolLstFollowingSolves = 0,
597 IncludeSolLstFollowingSolves = 1,
598 SuppressAllSolInfo = 2
599 };
600 };
603 {
606 {
607 ChainScript = 0,
608 CallScript = 1,
609 CallModule = 2,
610 AsyncGrid = 3,
611 AsyncSimulate = 4,
612 LoadLibrary = 5,
613 LoadLibraryAsync = 6,
614 LoadLibraryAsyncSimulate = 7
615 };
616 };
619 {
622 {
623 Merge = 0,
624 Replace = 1,
625 Clear = 2
626 };
627 };
629 struct EStepSum
630 {
633 {
634 NoStepSummmary = 0,
635 StepSummary = 1
636 };
637 };
640 {
643 {
644 FirstRecord = 0,
645 Error = 1
646 };
647 };
650 {
653 {
654 NoError = 0,
655 Error = 1,
656 NoErrorRemoveSymbol = 2
657 };
658 };
661 {
664 {
665 OffSuffixDLVars = 0,
666 OnSuffixDLVars = 1
667 };
668 };
671 {
674 {
675 OffSuffixAlgebraVars = 0,
676 OnSuffixAlgebraVars = 1
677 };
678 };
681 {
684 {
685 StandardCompilerListing = 0,
686 SuppressCompilerListing = 1
687 };
688 };
690 struct ESys10
691 {
694 {
695 Disable = 0,
696 Enable = 1
697 };
698 };
700 struct ESys11
701 {
704 {
705 AutomaticOptimization = 0,
706 NoOptimization = 1,
707 AlwaysOptimize = 2
708 };
709 };
711 struct ESysOut
712 {
715 {
716 SuppressAdditionalSolverOutput = 0,
717 IncludeAdditionalSolverOutput = 1
718 };
719 };
721 struct ETFormat
722 {
725 {
726 Colon = 0,
727 Dot = 1
728 };
729 };
732 {
735 {
736 SolverAndGAMSStepTraceWOHeaders = 0,
737 SolverAndGAMSStepTrace = 1,
738 SolverStepTraceOnly = 2,
739 TraceFileFormatGAMSPerformanceWorld = 3,
740 TraceFileFormatSupportingNLPEC = 4,
741 TraceFileWithAllAvailableTraceFields = 5
742 };
743 };
746 {
749 {
750 NoWarning = 0,
751 IssueWarning = 1
752 };
753 };
754
757
759 static const char* gamsBuild();
760
762 static const char* gamsVersion();
763
766 LogId logID();
767
769 void writeOptionFile(const std::string& optFileName);
770
772 void setAllModelTypes(const std::string& solver);
773
776
778 void addInputDir(const std::string value);
779
781 std::string getInputDir(const int index);
782
784 void setInputDir(const std::string value, const int index);
785
787 void removeInputDir(const int index);
788
790 void setDefine(const std::string &key, const std::string &value);
791
793 std::string getDefine(const std::string& key);
794
796 bool removeDefine(const std::string& key);
797
799 std::string gdx();
800
802 void setGdx(const std::string& value);
803
806
809
811 static EAction::EActionEnum eActionFromCode(const std::string &str);
812
815
818
821
824
827
830
833
836
838 double bratio();
839
841 void setBratio(const double value);
842
845
848
850 int lstCase();
851
853 void setLstCase(const int value);
854
856 int cErr();
857
859 void setCErr(const int value);
860
863
866
869
872
874 std::string decryptKey();
875
877 void setDecryptKey(const std::string& value);
878
881
884
887
890
892 static EDigit::EDigitEnum eDigitFromCode(const std::string &str);
893
896
899
901 int domLim();
902
904 void setDomLim(const int value);
905
908
911
913 std::string dumpOptGDX();
914
916 void setDumpOptGDX(const std::string& value);
917
920
923
925 std::string dumpParmsLogPrefix();
926
928 void setDumpParmsLogPrefix(const std::string& value);
929
932
935
938
941
944
947
950
952 static EECLogLine::EECLogLineEnum eECLogLineFromCode(const std::string &str);
953
956
959
962
965
967 static EEmpty::EEmptyEnum eEmptyFromCode(const std::string &str);
968
971
974
976 std::string encryptKey();
977
979 void setEncryptKey(const std::string& value);
980
982 std::string eolCom();
983
985 void setEolCom(const std::string& value);
986
989
992
994 int errorLog();
995
997 void setErrorLog(const int value);
998
1000 double eTLim();
1001
1003 void setETLim(const double value);
1004
1007
1010
1012 std::string expand();
1013
1015 void setExpand(const std::string& value);
1016
1018 double fDDelta();
1019
1021 void setFDDelta(const double value);
1022
1025
1028
1030 std::string fErr();
1031
1033 void setFErr(const std::string& value);
1034
1037
1040
1042 std::string fileStem();
1043
1045 void setFileStem(const std::string& value);
1046
1048 std::string fileStemApFromEnv();
1049
1051 void setFileStemApFromEnv(const std::string& value);
1052
1055
1058
1060 static EFiltered::EFilteredEnum eFilteredFromCode(const std::string &str);
1061
1064
1067
1070
1072 void setForceOptFile(const int value);
1073
1076
1079
1081 int forLim();
1082
1084 void setForLim(const int value);
1085
1088
1091
1094
1097
1100
1103
1106
1109
1112
1115
1118
1120 static EgdxUels::EgdxUelsEnum egdxUelsFromCode(const std::string &str);
1121
1124
1127
1129 std::string gridDir();
1130
1132 void setGridDir(const std::string& value);
1133
1135 std::string gridScript();
1136
1138 void setGridScript(const std::string& value);
1139
1141 double heapLimit();
1142
1144 void setHeapLimit(const double value);
1145
1148
1151
1154
1157
1159 std::string iDCGDXInput();
1160
1162 void setIDCGDXInput(const std::string& value);
1163
1165 std::string iDCGDXOutput();
1166
1168 void setIDCGDXOutput(const std::string& value);
1169
1172
1175
1178
1181
1184
1186 std::string inlineCom();
1187
1189 void setInlineCom(const std::string& value);
1190
1193
1195 void setInteger1(const int value);
1196
1199
1201 void setInteger2(const int value);
1202
1205
1207 void setInteger3(const int value);
1208
1211
1213 void setInteger4(const int value);
1214
1217
1219 void setInteger5(const int value);
1220
1223
1226
1229
1232
1234 int iterLim();
1235
1237 void setIterLim(const int value);
1238
1240 std::string jobTrace();
1241
1243 void setJobTrace(const std::string& value);
1244
1247
1250
1252 std::string libIncDir();
1253
1255 void setLibIncDir(const std::string& value);
1256
1258 std::string license();
1259
1261 void setLicense(const std::string& value);
1262
1264 int limCol();
1265
1267 void setLimCol(const int value);
1268
1270 int limRow();
1271
1273 void setLimRow(const int value);
1274
1277
1280
1282 static EListing::EListingEnum eListingFromCode(const std::string &str);
1283
1286
1289
1292
1295
1298
1301
1304
1306 void setMaxExecError(const int value);
1307
1310
1312 void setMaxProcDir(const int value);
1313
1316
1319
1322
1325
1327 static EMIIMode::EMIIModeEnum eMIIModeFromCode(const std::string &str);
1328
1331
1334
1336 std::string multi();
1337
1339 void setMulti(const std::string& value);
1340
1342 int nodLim();
1343
1345 void setNodLim(const int value);
1346
1349
1352
1355
1358
1360 double optCA();
1361
1363 void setOptCA(const double value);
1364
1366 double optCR();
1367
1369 void setOptCR(const double value);
1370
1372 std::string optDir();
1373
1375 void setOptDir(const std::string& value);
1376
1378 int optFile();
1379
1381 void setOptFile(const int value);
1382
1384 std::string output();
1385
1387 void setOutput(const std::string& value);
1388
1391
1394
1397
1399 void setPageSize(const int value);
1400
1403
1405 void setPageWidth(const int value);
1406
1408 std::string pLicense();
1409
1411 void setPLicense(const std::string& value);
1412
1415
1418
1421
1424
1427
1430
1433
1435 void setProcTreeMemTicks(const int value);
1436
1438 int profile();
1439
1441 void setProfile(const int value);
1442
1444 std::string profileFile();
1445
1447 void setProfileFile(const std::string& value);
1448
1450 double profileTol();
1451
1453 void setProfileTol(const double value);
1454
1456 std::string putDir();
1457
1459 void setPutDir(const std::string& value);
1460
1462 int putND();
1463
1465 void setPutND(const int value);
1466
1469
1472
1474 int putPS();
1475
1477 void setPutPS(const int value);
1478
1480 int putPW();
1481
1483 void setPutPW(const int value);
1484
1486 std::string reference();
1487
1489 void setReference(const std::string& value);
1490
1493
1496
1499
1502
1505
1508
1511
1513 static EReplace::EReplaceEnum eReplaceFromCode(const std::string &str);
1514
1517
1520
1523
1526
1528 double resLim();
1529
1531 void setResLim(const double value);
1532
1535
1538
1540 std::string scriptExit();
1541
1543 void setScriptExit(const std::string& value);
1544
1546 int seed();
1547
1549 void setSeed(const int value);
1550
1553
1556
1559
1562
1565
1568
1571
1574
1577
1580
1583
1586
1589
1592
1595
1598
1601
1604
1607
1610
1613
1616
1619
1622
1625
1628
1630 std::string symbol();
1631
1633 void setSymbol(const std::string& value);
1634
1636 std::string symPrefix();
1637
1639 void setSymPrefix(const std::string& value);
1640
1643
1646
1649
1652
1654 int sys12();
1655
1657 void setSys12(const int value);
1658
1660 std::string sysIncDir();
1661
1663 void setSysIncDir(const std::string& value);
1664
1667
1670
1672 int tabIn();
1673
1675 void setTabIn(const int value);
1676
1679
1682
1684 int threads();
1685
1687 void setThreads(const int value);
1688
1691
1693 void setThreadsAsync(const int value);
1694
1696 int timer();
1697
1699 void setTimer(const int value);
1700
1702 std::string trace();
1703
1705 void setTrace(const std::string& value);
1706
1709
1711 void setTraceLevel(const int value);
1712
1715
1718
1720 std::string user1();
1721
1723 void setUser1(const std::string& value);
1724
1726 std::string user2();
1727
1729 void setUser2(const std::string& value);
1730
1732 std::string user3();
1733
1735 void setUser3(const std::string& value);
1736
1738 std::string user4();
1739
1741 void setUser4(const std::string& value);
1742
1744 std::string user5();
1745
1747 void setUser5(const std::string& value);
1748
1751
1753 void setWarnings(const int value);
1754
1756 double workFactor();
1757
1759 void setWorkFactor(const double value);
1760
1762 double workSpace();
1763
1765 void setWorkSpace(const double value);
1766
1768 double zeroRes();
1769
1771 void setZeroRes(const double value);
1772
1775
1778
1780 std::string LP();
1781
1783 void setLP(const std::string& value);
1784
1786 std::string MIP();
1787
1789 void setMIP(const std::string& value);
1790
1792 std::string RMIP();
1793
1795 void setRMIP(const std::string& value);
1796
1798 std::string NLP();
1799
1801 void setNLP(const std::string& value);
1802
1804 std::string MCP();
1805
1807 void setMCP(const std::string& value);
1808
1810 std::string MPEC();
1811
1813 void setMPEC(const std::string& value);
1814
1816 std::string RMPEC();
1817
1819 void setRMPEC(const std::string& value);
1820
1822 std::string CNS();
1823
1825 void setCNS(const std::string& value);
1826
1828 std::string DNLP();
1829
1831 void setDNLP(const std::string& value);
1832
1834 std::string RMINLP();
1835
1837 void setRMINLP(const std::string& value);
1838
1840 std::string MINLP();
1841
1843 void setMINLP(const std::string& value);
1844
1846 std::string QCP();
1847
1849 void setQCP(const std::string& value);
1850
1852 std::string MIQCP();
1853
1855 void setMIQCP(const std::string& value);
1856
1858 std::string RMIQCP();
1859
1861 void setRMIQCP(const std::string& value);
1862
1864 std::string EMP();
1865
1867 void setEMP(const std::string& value);
1868
1870 std::string getSolver(const std::string& modelType);
1871
1873 void setSolver(const std::string& modelType, const std::string& solver);
1874
1875private:
1876 std::shared_ptr<GAMSOptionsImpl> mImpl;
1877 GAMSOptions(GAMSWorkspace workspace, const GAMSOptions* optFrom);
1878 GAMSOptions(GAMSWorkspace workspace, const std::string& optFile = "");
1879 int appendLog();
1880 void setAppendLog(const int value);
1881 int compilerPreview();
1882 void setCompilerPreview(const int value);
1883 std::string connectIn();
1884 void setConnectIn(const std::string& value);
1885 std::string connectOut();
1886 void setConnectOut(const std::string& value);
1887 std::string curDir();
1888 void setCurDir(const std::string& value);
1889 int debugPort();
1890 void setDebugPort(const int value);
1891 std::string docFile();
1892 void setDocFile(const std::string& value);
1893 std::string epsToZero();
1894 void setEpsToZero(const std::string& value);
1895 std::string errNam();
1896 void setErrNam(const std::string& value);
1897 int fSave();
1898 void setFSave(const int value);
1899 int g205();
1900 void setG205(const int value);
1901 std::string gdxSymbols();
1902 void setgdxSymbols(const std::string& value);
1903 std::string gP_SolveLine();
1904 void setGP_SolveLine(const std::string& value);
1905 std::string iDCGenerateGDX();
1906 void setIDCGenerateGDX(const std::string& value);
1907 std::string iDCGenerateGDXInput();
1908 void setIDCGenerateGDXInput(const std::string& value);
1909 std::string iDCGenerateGDXOutput();
1910 void setIDCGenerateGDXOutput(const std::string& value);
1911 std::string iDCGenerateJSON();
1912 void setIDCGenerateJSON(const std::string& value);
1913 std::string iDCJSON();
1914 void setIDCJSON(const std::string& value);
1915 int iDCProtect();
1916 void setIDCProtect(const int value);
1917 int iDE();
1918 void setIDE(const int value);
1919 int incrementalMode();
1920 void setIncrementalMode(const int value);
1921 std::string input();
1922 void setInput(const std::string& value);
1923 std::string logFile();
1924 void setLogFile(const std::string& value);
1925 int logOption();
1926 void setLogOption(const int value);
1927 int maxGenericFiles();
1928 void setMaxGenericFiles(const int value);
1929 int mCPRHoldfx();
1930 void setMCPRHoldfx(const int value);
1931 int multiPass();
1932 void setMultiPass(const int value);
1933 std::string netLicense();
1934 void setNetLicense(const std::string& value);
1935 int noCr();
1936 void setNoCr(const int value);
1937 int opt();
1938 void setOpt(const int value);
1939 int pID2Error();
1940 void setPID2Error(const int value);
1941 std::string procDir();
1942 void setProcDir(const std::string& value);
1943 std::string procDirPath();
1944 void setProcDirPath(const std::string& value);
1945 int comPort();
1946 void setComPort(const int value);
1947 int relPath();
1948 void setRelPath(const int value);
1949 std::string restart();
1950 void setRestart(const std::string& value);
1951 std::string restartNamed();
1952 void setRestartNamed(const std::string& value);
1953 std::string save();
1954 void setSave(const std::string& value);
1955 std::string saveObfuscate();
1956 void setSaveObfuscate(const std::string& value);
1957 std::string scrDir();
1958 void setScrDir(const std::string& value);
1959 std::string scrExt();
1960 void setScrExt(const std::string& value);
1961 std::string scriptFrst();
1962 void setScriptFrst(const std::string& value);
1963 std::string scriptNext();
1964 void setScriptNext(const std::string& value);
1965 std::string scrNam();
1966 void setScrNam(const std::string& value);
1967 int serverRun();
1968 void setServerRun(const int value);
1969 std::string solver();
1970 void setSolver(const std::string& value);
1971 std::string solverCntr();
1972 void setSolverCntr(const std::string& value);
1973 std::string solverDict();
1974 void setSolverDict(const std::string& value);
1975 std::string solverInst();
1976 void setSolverInst(const std::string& value);
1977 std::string solverMatr();
1978 void setSolverMatr(const std::string& value);
1979 std::string solverSolu();
1980 void setSolverSolu(const std::string& value);
1981 std::string solverStat();
1982 void setSolverStat(const std::string& value);
1983 std::string sparseRun();
1984 void setSparseRun(const std::string& value);
1985 std::string sqaCmex();
1986 void setSqaCmex(const std::string& value);
1987 std::string subSys();
1988 void setSubSys(const std::string& value);
1989 int sys14();
1990 void setSys14(const int value);
1991 int sys15();
1992 void setSys15(const int value);
1993 int sys16();
1994 void setSys16(const int value);
1995 int sys17();
1996 void setSys17(const int value);
1997 int sys18();
1998 void setSys18(const int value);
1999 int sys19();
2000 void setSys19(const int value);
2001 std::string sysDir();
2002 void setSysDir(const std::string& value);
2003 std::string workDir();
2004 void setWorkDir(const std::string& value);
2005 int writeOutput();
2006 void setwriteOutput(const int value);
2007 std::string xSave();
2008 void setXSave(const std::string& value);
2009 std::string xSaveObfuscate();
2010 void setXSaveObfuscate(const std::string& value);
2011
2012};
2013}
2014#endif // GAMSOPTIONS_H
2015
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.
void setECLogLine(const GAMSOptions::EECLogLine::EECLogLineEnum value)
Set Show log line about embedded code initialization and execution or not.
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.
GAMSOptions::EMemoryManager::EMemoryManagerEnum memoryManager()
Get Allows to try an experimental memory manager.
void setGdx(const std::string &value)
Set GDX file name.
GAMSOptions::ERequestMarginals::ERequestMarginalsEnum requestMarginals()
Get Request marginals from the solver.
int forceOptFile()
Get Overwrites other option file section mechanism.
void setTimer(const int value)
Set Instruction timer threshold in milliseconds.
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 milliseconds.
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.
static std::string eECLogLineText(GAMSOptions::EECLogLine::EECLogLineEnum type)
Get Show log line about embedded code initialization and execution or not as text.
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.
void setRequestMarginals(const GAMSOptions::ERequestMarginals::ERequestMarginalsEnum value)
Set Request marginals from the solver.
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 setMemoryManager(const GAMSOptions::EMemoryManager::EMemoryManagerEnum value)
Set Allows to try an experimental memory manager.
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]".
static std::string eECLogLineCode(GAMSOptions::EECLogLine::EECLogLineEnum type)
Get Show log line about embedded code initialization and execution or not as code.
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".
GAMSOptions::EECLogLine::EECLogLineEnum eCLogLine()
Get Show log line about embedded code initialization and execution or not.
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.
static EECLogLine::EECLogLineEnum eECLogLineFromCode(const std::string &str)
Get Show log line about embedded code initialization and execution or not from std::string
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:99
EAsyncSolLstEnum
Print solution listing when asynchronous solve (Grid or Threads) is used.
Switch to capture all model instances within a run.
ECaptureModelInstanceEnum
Switch to capture all model instances within a run.
Output case option for LST file.
ECaseEnum
Output case option for LST file.
Character set flag.
ECharSetEnum
Character set flag.
Check errorLevel automatically after executing external program.
ECheckErrorLevelEnum
Check errorLevel automatically after executing external program.
Switch default for "$on/offDigit".
EDigitEnum
Switch default for "$on/offDigit".
Writes preprocessed input to the file input.dmp.
EDumpOptEnum
Writes preprocessed input to the file input.dmp.
GAMS parameter logging.
EDumpParmsEnum
GAMS parameter logging.
Allow implicit loading of symbols from embedded code or not.
EECImplicitLoadEnum
Allow implicit loading of symbols from embedded code or not.
Show log line about embedded code initialization and execution or not.
EECLogLineEnum
Show log line about embedded code initialization and execution or not.
Switch default for "$on/offEmpty".
EEmptyEnum
Switch default for "$on/offEmpty".
Placing of compilation error messages.
EErrMsgEnum
Placing of compilation error messages.
Limits on external programs that are allowed to be executed.
EExecModeEnum
Limits on external programs that are allowed to be executed.
Options for finite differences.
EFDOptEnum
Options for finite differences.
Casing of file names and paths (put, gdx, ref, $include, etc.)
EFileCaseEnum
Casing of file names and paths (put, gdx, ref, $include, etc.)
Switch between filtered and domain-checked read from GDX.
EFilteredEnum
Switch between filtered and domain-checked read from GDX.
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
EForceWorkEnum
Force GAMS to process a save file created with a newer GAMS version or with execution errors.
Free external resources at the end of each embedded Python code blocks.
EFreeEmbeddedPythonEnum
Free external resources at the end of each embedded Python code blocks.
Allow HoldFixed for models solved asynchronously as well.
EHoldFixedAsyncEnum
Allow HoldFixed for models solved asynchronously as well.
Treat fixed variables as constants.
EHoldFixedEnum
Treat fixed variables as constants.
Switch default for "$on/offImplicitAssign".
EImplicitAssignEnum
Switch default for "$on/offImplicitAssign".
Set mode for default upper bounds on integer variables.
EIntVarUpEnum
Set mode for default upper bounds on integer variables.
Allow solver to interact via command line input.
EInteractiveSolverEnum
Allow solver to interact via command line input.
Controls keeping or deletion of process directory and scratch files.
EKeepEnum
Controls keeping or deletion of process directory and scratch files.
Switch default for "$on/offListing".
EListingEnum
Switch default for "$on/offListing".
Amount of line tracing to the log file.
ELogLineEnum
Amount of line tracing to the log file.
Write title of LST file all left aligned.
ELstTitleLeftAlignedEnum
Write title of LST file all left aligned.
Model Instance Mode.
EMIIModeEnum
Model Instance Mode.
Allows to try an experimental memory manager.
EMemoryManagerEnum
Allows to try an experimental memory manager.
Triggers a compilation error when new equations or variable symbols are introduced.
ENoNewVarEquEnum
Triggers a compilation error when new equations or variable symbols are introduced.
Generate errors for unknown unique element in an equation.
EOn115Enum
Generate errors for unknown unique element in an equation.
Output file page control option.
EPageContrEnum
Output file page control option.
Prepend GAMS system directory to library load path.
EPrefixLoadPathEnum
Prepend GAMS system directory to library load path.
Indicator for writing workfile with previous workfile version.
EPreviousWorkEnum
Indicator for writing workfile with previous workfile version.
Monitor the memory used by the GAMS process tree.
EProcTreeMemMonitorEnum
Monitor the memory used by the GAMS process tree.
Numeric round format for put files.
EPutNREnum
Numeric round format for put files.
Controls the line numbers written to a reference file.
EReferenceLineNoEnum
Controls the line numbers written to a reference file.
Switch between merge and replace when reading from GDX into non-empty symbol.
EReplaceEnum
Switch between merge and replace when reading from GDX into non-empty symbol.
Request marginals from the solver.
ERequestMarginalsEnum
Request marginals from the solver.
Save solver point in GDX file.
ESavePointEnum
Save solver point in GDX file.
Show the memory usage reported by the Operating System instead of the internal counting.
EShowOSMemoryEnum
Show the memory usage reported by the Operating System instead of the internal counting.
Solution report print option.
ESolPrintEnum
Solution report print option.
Multiple solve management.
ESolveOptEnum
Multiple solve management.
Summary of computing resources used by job steps.
EStepSumEnum
Summary of computing resources used by job steps.
String substitution options.
EStringChkEnum
String substitution options.
Switch default for "$on/offSuffixAlgebraVars".
ESuffixAlgebraVarsEnum
Switch default for "$on/offSuffixAlgebraVars".
Switch default for "$on/offSuffixDLVars".
ESuffixDLVarsEnum
Switch default for "$on/offSuffixDLVars".
Compiler listing option.
ESuppressEnum
Compiler listing option.
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
ESys10Enum
Changes rpower to ipower when the exponent is constant and within 1e-12 of an integer.
Dynamic resorting if indices in assignment/data statements are not in natural order.
ESys11Enum
Dynamic resorting if indices in assignment/data statements are not in natural order.
Solver Status file reporting option.
ESysOutEnum
Solver Status file reporting option.
Trace file format option.
ETraceOptEnum
Trace file format option.
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
EZeroResRepEnum
Report underflow as a warning when abs(results) LE ZeroRes and result set to zero.
Compression of generated GDX file.
EgdxCompressEnum
Compression of generated GDX file.
Version of GDX files generated (for backward compatibility)
EgdxConvertEnum
Version of GDX files generated (for backward compatibility)
Unload labels or UELs to GDX either squeezed or full.
EgdxUelsEnum
Unload labels or UELs to GDX either squeezed or full.
Error if assignment to singleton set has multiple elements.
EstrictSingletonEnum
Error if assignment to singleton set has multiple elements.