OS  2.10.2
OSOption.h
Go to the documentation of this file.
1 /* $Id: OSOption.h 5284 2017-12-08 13:52:50Z stefan $ */
15 #ifndef OSOPTION_H
16 #define OSOPTION_H
17 
18 #include <string>
19 #include <vector>
20 #include "OSGeneral.h"
21 #include "OSMathUtil.h"
22 
23 
24 
25 //#define DEBUG
26 
27 
40 {
41 
42 public:
44  std::string locationType;
45 
47  std::string value;
48 
54 
60 
66 
74  bool setRandom(double density, bool conformant);
75 
82 }; //InstanceLocationOption
83 
84 
97 {
98 
99 public:
101  std::string transportType;
102 
104  std::string value;
105 
116 
121  bool IsEqual(ContactOption *that);
122 
130  bool setRandom(double density, bool conformant);
131 
138 }; //ContactOption
139 
140 
153 {
154 
155 public:
157  std::string name;
158 
160  std::string value;
161 
163  std::string description;
164 
175 
180  bool IsEqual(OtherOption *that);
181 
189  bool setRandom(double density, bool conformant);
190 
197 }; //OtherOption
198 
199 
212 {
213 
214 public:
217 
220 
231 
236  bool IsEqual(OtherOptions *that);
237 
245  bool setRandom(double density, bool conformant);
246 
253 
260  bool setOther(int numberOfOptions, OtherOption** other);
261 
269  bool addOther(std::string name, std::string value, std::string description);
270 }; //OtherOptions
271 
272 
285 {
286 
287 public:
288 
290  std::string serviceURI;
291 
293  std::string serviceName;
294 
296  std::string instanceName;
297 
300 
302  std::string jobID;
303 
305  std::string solverToInvoke;
306 
308  std::string license;
309 
311  std::string userName;
312 
314  std::string password;
315 
318 
321 
332 
337  bool IsEqual(GeneralOption *that);
338 
346  bool setRandom(double density, bool conformant);
347 
354 };//GeneralOption
355 
370 {
371 
372 public:
374  std::string unit;
375 
377  std::string description;
378 
380  double value;
381 
382 
393 
398  bool IsEqual(MinDiskSpace *that);
399 }; //MinDiskSpace
400 
415 {
416 
417 public:
419  std::string unit;
420 
422  std::string description;
423 
425  double value;
426 
427 
438 
443  bool IsEqual(MinMemorySize *that);
444 }; //MinMemorySize
445 
460 {
461 
462 public:
464  std::string unit;
465 
467  std::string description;
468 
470  double value;
471 
472 
483 
488  bool IsEqual(MinCPUSpeed *that);
489 }; //MinCPUSpeed
490 
505 {
506 
507 public:
509  std::string description;
510 
512  int value;
513 
514 
525 
530  bool IsEqual(MinCPUNumber *that);
531 }; //MinCPUNumber
532 
533 
546 {
547 
548 public:
551 
554 
557 
560 
563 
574 
579  bool IsEqual(SystemOption *that);
580 
588  bool setRandom(double density, bool conformant);
589 
596 }; //SystemOption
597 
598 
611 {
612 
613 public:
615  std::string type;
616 
619 
630 
635  bool IsEqual(ServiceOption *that);
636 
644  bool setRandom(double density, bool conformant);
645 
652 }; //ServiceOption
653 
654 
668 class MaxTime
669 {
670 
671 public:
673  std::string unit;
674 
676  double value;
677 
678 
689 
694  bool IsEqual(MaxTime *that);
695 }; //MaxTime
696 
697 
710 {
711 
712 public:
715 
717  std::string *jobID;
718 
729 
735 
743  bool setRandom(double density, bool conformant);
744 
751 
758  bool setJobID(int numberOfJobIDs, std::string *jobID);
759 
765  bool addJobID(std::string jobID);
766 }; //JobDependencies
767 
768 
781 {
782 
783 public:
786 
788  std::string *path;
789 
800 
806 
814  bool setRandom(double density, bool conformant);
815 
822 
829  bool setPath(int numberOfPaths, std::string *path);
835  bool addPath(std::string path);
836 }; //DirectoriesAndFiles
837 
838 
839 
851 class PathPair
852 {
853 
854 public:
856  std::string from;
857 
859  std::string to;
860 
862  bool makeCopy;
863 
874 
879  bool IsEqual(PathPair *that);
880 
888  bool setRandom(double density, bool conformant);
889 
895  bool deepCopyFrom(PathPair *that);
896 }; //PathPair
897 
898 
911 {
912 
913 public:
916 
919 
930 
935  bool IsEqual(PathPairs *that);
936 
944  bool setRandom(double density, bool conformant);
945 
951  bool deepCopyFrom(PathPairs *that);
952 
960 
969  bool setPathPair(std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs);
970 
978  bool addPathPair(std::string fromPath, std::string toPath, bool makeCopy);
979 }; //PathPairs
980 
981 
994 {
995 
996 public:
999 
1001  std::string *process;
1002 
1013 
1018  bool IsEqual(Processes *that);
1019 
1027  bool setRandom(double density, bool conformant);
1028 
1035 
1042  bool setProcess(int numberOfProcesses, std::string *process);
1043 
1049  bool addProcess(std::string process);
1050 }; //Processes
1051 
1052 
1065 {
1066 
1067 public:
1070 
1072  std::string requestedStartTime;
1073 
1076 
1079 
1082 
1085 
1088 
1091 
1094 
1097 
1100 
1103 
1106 
1109 
1112 
1123 
1128  bool IsEqual(JobOption *that);
1129 
1137  bool setRandom(double density, bool conformant);
1138 
1145 }; //JobOption
1146 
1147 
1160 {
1161 
1162 public:
1164  int idx;
1165 
1167  std::string name;
1168 
1170  double value;
1171 
1182 
1187  bool IsEqual(InitVarValue *that);
1188 
1196  bool setRandom(double density, bool conformant);
1197 
1204 }; //InitVarValue
1205 
1206 
1219 {
1220 
1221 public:
1224 
1227 
1238 
1244 
1252  bool setRandom(double density, bool conformant);
1253 
1260 
1268 
1277 
1278 
1287  bool setVar(int numberOfVar, int *idx, double *value, std::string *name);
1288 
1295  bool addVar(int idx, double value);
1296 
1306 }; //InitVariableValues
1307 
1308 
1321 {
1322 
1323 public:
1325  int idx;
1326 
1328  std::string name;
1329 
1331  std::string value;
1332 
1343 
1349 
1357  bool setRandom(double density, bool conformant);
1358 
1365 }; //InitVarValueString
1366 
1367 
1380 {
1381 
1382 public:
1385 
1388 
1399 
1405 
1413  bool setRandom(double density, bool conformant);
1414 
1421 
1429 
1438 
1439 
1448  bool setVar(int numberOfVar, int *idx, std::string *value, std::string* name);
1449 
1456  bool addVar(int idx, std::string value);
1457 
1467 }; //InitVariableValuesString
1468 
1482 {
1483 
1484 public:
1486  int idx;
1487 
1489  std::string value;
1490 
1502 
1507  bool IsEqual(InitBasStatus *that);
1508 
1516  bool setRandom(double density, bool conformant);
1517 
1524 }; //InitBasStatus
1525 
1526 
1541 {
1542 
1543 public:
1546 
1549 
1560 
1566 
1574  bool setRandom(double density, bool conformant);
1575 
1582 
1590 
1597  bool addVar(int idx, std::string value);
1598 }; //InitialBasisStatus
1599 
1612 {
1613 
1614 public:
1616  int idx;
1617 
1619  std::string name;
1620 
1622  double value;
1623 
1634 
1640 
1648  bool setRandom(double density, bool conformant);
1649 
1656 }; //BranchingWeight
1657 
1658 
1659 
1672 {
1673 
1674 public:
1677 
1680 
1691 
1697 
1705  bool setRandom(double density, bool conformant);
1706 
1713 
1721 
1730 
1739  bool setVar(int numberOfVar, int *idx, double *value, std::string* name);
1740 
1747  bool addVar(int idx, double value);
1748 
1758 }; //IntegerVariableBranchingWeights
1759 
1776 {
1777 
1778 public:
1780  int sosIdx;
1781 
1783  double groupWeight;
1784 
1787 
1790 
1801 
1806  bool IsEqual(SOSWeights *that);
1807 
1815  bool setRandom(double density, bool conformant);
1816 
1823 
1831 
1838  bool addVar(int idx, double value);
1839 }; //SOSWeights
1840 
1841 
1854 {
1855 
1856 public:
1859 
1862 
1873 
1879 
1887  bool setRandom(double density, bool conformant);
1888 
1895 
1913  bool addSOS(int sosIdx, int nvar, double weight, int* idx, double* value, std::string* name);
1914 }; //SOSVariableBranchingWeights
1915 
1928 {
1929 
1930 public:
1932  int idx;
1933 
1935  std::string name;
1936 
1938  std::string value;
1939 
1941  std::string lbValue;
1942 
1944  std::string ubValue;
1945 
1956 
1962 
1970  bool setRandom(double density, bool conformant);
1971 
1978 }; //OtherVarOption
1979 
1980 
1990 {
1991 
1992 public:
1995 
1998 
2000  std::string name;
2001 
2003  std::string value;
2004 
2006  std::string solver;
2007 
2009  std::string category;
2010 
2012  std::string type;
2013 
2015  std::string description;
2016 
2019 
2021  std::string varType;
2022 
2023  /* a pointer to OtherOptionOrResultEnumeration objects that will
2024  * give for each distinct value the set of indices for
2025  * this user defined variable result
2026  */
2028 
2030  std::string enumType;
2031 
2042 
2048 
2056  bool setRandom(double density, bool conformant);
2057 
2064 
2072 
2081  bool addVar(int idx, std::string value, std::string lbValue, std::string ubValue);
2082 }; //OtherVariableOption
2083 
2084 
2097 {
2098 
2099 public:
2102 
2105 
2108 
2111 
2114 
2117 
2120 
2131 
2137 
2145  bool setRandom(double density, bool conformant);
2146 
2153 
2160  bool setOther(int numberOfOptions, OtherVariableOption **other);
2161 
2168 }; //VariableOption
2169 
2170 
2183 {
2184 
2185 public:
2187  int idx;
2188 
2190  std::string name;
2191 
2193  double value;
2194 
2205 
2210  bool IsEqual(InitObjValue *that);
2211 
2219  bool setRandom(double density, bool conformant);
2220 
2227 }; //InitObjValue
2228 
2229 
2242 {
2243 
2244 public:
2247 
2250 
2261 
2267 
2275  bool setRandom(double density, bool conformant);
2276 
2283 
2291 
2300 
2301 
2310  bool setObj(int numberOfObj, int *idx, double *value, std::string *name);
2311 
2318  bool addObj(int idx, double value);
2319 
2329 }; //InitObjectiveValues
2330 
2331 
2344 {
2345 
2346 public:
2348  int idx;
2349 
2351  std::string name;
2352 
2354  double lbValue;
2355 
2357  double ubValue;
2358 
2369 
2374  bool IsEqual(InitObjBound *that);
2375 
2383  bool setRandom(double density, bool conformant);
2384 
2391 }; //InitObjBound
2392 
2393 
2406 {
2407 
2408 public:
2411 
2414 
2425 
2431 
2439  bool setRandom(double density, bool conformant);
2440 
2447 
2455 
2464 
2465 
2475  bool setObj(int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name);
2476 
2484  bool addObj(int idx, double lbValue, double ubValue);
2485 
2495 }; //InitObjectiveBounds
2496 
2497 
2510 {
2511 
2512 public:
2514  int idx;
2515 
2517  std::string name;
2518 
2520  std::string value;
2521 
2522 
2524  std::string lbValue;
2525 
2527  std::string ubValue;
2538 
2544 
2552  bool setRandom(double density, bool conformant);
2553 
2560 }; //OtherObjOption
2561 
2562 
2575 {
2576 
2577 public:
2580 
2583 
2585  std::string name;
2586 
2588  std::string value;
2589 
2591  std::string solver;
2592 
2594  std::string category;
2595 
2597  std::string type;
2598 
2600  std::string description;
2601 
2604 
2606  std::string objType;
2607 
2608  /* a pointer to OtherOptionOrResultEnumeration objects that will
2609  * give for each distinct value the set of indices for
2610  * this user defined variable result
2611  */
2613 
2615  std::string enumType;
2616 
2627 
2633 
2641  bool setRandom(double density, bool conformant);
2642 
2649 
2657 
2666  bool addObj(int idx, std::string value, std::string lbValue, std::string ubValue);
2667 }; //OtherObjectiveOption
2668 
2669 
2682 {
2683 
2684 public:
2687 
2690 
2693 
2696 
2699 
2710 
2716 
2724  bool setRandom(double density, bool conformant);
2725 
2732 
2739  bool setOther(int numberOfOptions, OtherObjectiveOption **other);
2740 
2741 
2742 
2749 }; //ObjectiveOption
2750 
2751 
2764 {
2765 
2766 public:
2768  int idx;
2769 
2771  std::string name;
2772 
2774  double value;
2775 
2786 
2791  bool IsEqual(InitConValue *that);
2792 
2800  bool setRandom(double density, bool conformant);
2801 
2808 }; //InitConValue
2809 
2810 
2823 {
2824 
2825 public:
2828 
2831 
2842 
2848 
2856  bool setRandom(double density, bool conformant);
2857 
2864 
2872 
2881 
2882 
2891  bool setCon(int numberOfCon, int *idx, double *value, std::string *name);
2892 
2899  bool addCon(int idx, double value);
2900 
2910 }; //InitConstraintValues
2911 
2912 
2925 {
2926 
2927 public:
2929  int idx;
2930 
2932  std::string name;
2933 
2935  double lbDualValue;
2936 
2938  double ubDualValue;
2939 
2945 
2951 
2957 
2965  bool setRandom(double density, bool conformant);
2966 
2973 }; //InitDualVarValue
2974 
2975 
2988 {
2989 
2990 public:
2993 
2996 
3007 
3013 
3021  bool setRandom(double density, bool conformant);
3022 
3029 
3037 
3046 
3047 
3057  bool setCon(int numberOfCon, int *idx, double *lbValue, double *ubValue, std::string *name);
3058 
3066  bool addCon(int idx, double lbDualValue, double ubDualValue);
3067 
3077 }; //InitDualVariableValues
3078 
3079 
3092 {
3093 
3094 public:
3096  int idx;
3097 
3099  std::string name;
3100 
3102  std::string value;
3103 
3105  std::string lbValue;
3106 
3108  std::string ubValue;
3109 
3120 
3126 
3134  bool setRandom(double density, bool conformant);
3135 
3142 }; //OtherConOption
3143 
3144 
3157 {
3158 
3159 public:
3162 
3165 
3167  std::string name;
3168 
3170  std::string value;
3171 
3173  std::string solver;
3174 
3176  std::string category;
3177 
3179  std::string type;
3180 
3182  std::string description;
3183 
3186 
3188  std::string conType;
3189 
3190  /* a pointer to OtherOptionOrResultEnumeration objects that will
3191  * give for each distinct value the set of indices for
3192  * this user defined variable result
3193  */
3195 
3197  std::string enumType;
3198 
3209 
3215 
3223  bool setRandom(double density, bool conformant);
3224 
3231 
3239 
3248  bool addCon(int idx, std::string value, std::string lbValue, std::string ubValue);
3249 }; //OtherConstraintOption
3250 
3251 
3264 {
3265 
3266 public:
3269 
3272 
3275 
3278 
3281 
3292 
3298 
3306  bool setRandom(double density, bool conformant);
3307 
3314 
3321  bool setOther(int numberOfOptions, OtherConstraintOption **other);
3322 
3323 
3330 }; //ConstraintOption
3331 
3332 
3345 {
3346 
3347 public:
3349  std::string name;
3350 
3352  std::string value;
3353 
3355  std::string solver;
3356 
3358  std::string category;
3359 
3361  std::string type;
3362 
3364  std::string description;
3365 
3368 
3370  std::string* item;
3371 
3382 
3387  bool IsEqual(SolverOption *that);
3388 
3396  bool setRandom(double density, bool conformant);
3397 
3404 }; //SolverOption
3405 
3406 
3419 {
3420 
3421 public:
3424 
3427 
3438 
3443  bool IsEqual(SolverOptions *that);
3444 
3452  bool setRandom(double density, bool conformant);
3453 
3460 
3467  bool setSolverOptions(int numberOfOptions, SolverOption **solverOption);
3468 
3479  bool addSolverOption(std::string name, std::string value, std::string solver,
3480  std::string category, std::string type, std::string description);
3481 }; //SolverOptions
3482 
3483 
3496 {
3497 
3498 public:
3501 
3504 
3507 
3510 
3513 
3516 
3529 
3535 
3543  bool setRandom(double density, bool conformant);
3544 
3551 }; //OptimizationOption
3552 
3553 
3565 {
3566 
3567 public:
3568 
3597 
3608 
3618  bool setHeader(std::string name, std::string source,
3619  std::string description, std::string fileCreator, std::string licence);
3620 
3621 private:
3625  double* m_mdInitVarValuesDense;
3626 
3630  std::string* m_mdInitVarValuesStringDense;
3631 
3635  int* m_mdInitBasisStatusDense;
3636 
3640  double* m_mdIntegerVariableBranchingWeightsDense;
3641 
3645  double* m_mdInitObjValuesDense;
3646 
3650  double* m_mdInitObjLowerBoundsDense;
3651 
3655  double* m_mdInitObjUpperBoundsDense;
3656 
3660  double* m_mdInitConValuesDense;
3661 
3666  double* m_mdInitDualVarLowerBoundsDense;
3667 
3672  double* m_mdInitDualVarUpperBoundsDense;
3673 
3674 public:
3678  bool IsEqual(OSOption *that);
3679 
3686  bool setRandom(double density, bool conformant);
3687 
3693  bool deepCopyFrom(OSOption *that);
3694 
3695 public:
3696 
3697  // get() methods...
3698 
3702  std::string getFileName();
3703 
3707  std::string getFileSource();
3708 
3712  std::string getFileDescription();
3713 
3717  std::string getFileCreator();
3718 
3722  std::string getFileLicence();
3723 
3727  std::string getServiceURI();
3728 
3732  std::string getServiceName();
3733 
3737  std::string getInstanceName();
3738 
3742  std::string getInstanceLocation();
3743 
3748 
3753  std::string getJobID();
3754 
3758  std::string getSolverToInvoke();
3759 
3763  std::string getLicense();
3764 
3768  std::string getUserName();
3769 
3773  std::string getPassword();
3774 
3778  std::string getContact();
3779 
3784 
3788  std::string getMinDiskSpaceUnit();
3789 
3794 
3798  std::string getMinMemoryUnit();
3799 
3804 
3808  std::string getMinCPUSpeedUnit();
3809 
3814 
3819 
3823  std::string getServiceType();
3824 
3828  std::string getMaxTimeUnit();
3829 
3833  std::string getRequestedStartTime();
3834 
3838  std::string getOptionStr(std::string optionName);
3839 
3844 
3849 
3853  double getMinCPUSpeed();
3854 
3858  double getMaxTime();
3859 
3863  double getOptionDbl(std::string optionName);
3864 
3869 
3874 
3879 
3884 
3889 
3894 
3899 
3904 
3909 
3914 
3919 
3924 
3929 
3934 
3939 
3944 
3949 
3954 
3959 
3964 
3971 
3978 
3986 
3993 
4000 
4007 
4014 
4021 
4028 
4035 
4042 
4049 
4056 
4060  int getOptionInt(std::string optionName);
4061 
4062 
4071 
4080 
4089 
4098 
4106  OtherOption** getOtherOptions(std::string elementName);
4107 
4108 
4117 
4124  std::string* getJobDependencies();
4125 
4133  std::string* getRequiredDirectories();
4134 
4142  std::string* getRequiredFiles();
4143 
4151  std::string* getDirectoriesToMake();
4152 
4160  std::string* getFilesToMake();
4161 
4170 
4179 
4188 
4197 
4205  std::string* getDirectoriesToDelete();
4206 
4214  std::string* getFilesToDelete();
4215 
4223  std::string* getProcessesToKill();
4224 
4233 
4242 
4251  double* getInitVarValuesDense(int numberOfVariables);
4252 
4261 
4270 
4279  std::string *getInitVarValuesStringDense(int numberOfVariables);
4280 
4289 
4297  std::string *getInitBasisStatusDense();
4298 
4307  int* getVariableInitialBasisStatusDense(int numberOfVariables);
4308 
4319  int getNumberOfInitialBasisElements(int type, int status);
4320 
4332  bool getInitialBasisElements(int type, int status, int* elem);
4333 
4342 
4351 
4360  double* getIntegerVariableBranchingWeightsDense(int numberOfVariables);
4361 
4370 
4379  std::vector<OtherVariableOption*> getOtherVariableOptions(std::string solver_name);
4380 
4389 
4397 
4406 
4415 
4424  double *getInitObjValuesDense(int numberOfObjectives);
4425 
4434 
4443 
4452  double *getInitObjLowerBoundsDense(int numberOfObjectives);
4453 
4462 
4471  double *getInitObjUpperBoundsDense(int numberOfObjectives);
4472 
4481  int* getObjectiveInitialBasisStatusDense(int numberOfObjectives);
4482 
4490  std::vector<OtherObjectiveOption*> getOtherObjectiveOptions(std::string solver_name);
4491 
4500 
4508 
4517 
4526 
4535  double *getInitConValuesDense(int numberOfConstraints);
4536 
4545 
4554 
4563  double *getInitDualVarLowerBoundsDense(int numberOfConstraints);
4564 
4565 
4574 
4583  double *getInitDualVarUpperBoundsDense(int numberOfConstraints);
4584 
4593  int* getSlackVariableInitialBasisStatusDense(int numberOfConstraints);
4594 
4602  std::vector<OtherConstraintOption*> getOtherConstraintOptions(std::string solver_name);
4603 
4612 
4620 
4629  std::vector<SolverOption*> getSolverOptions( std::string solver_name);
4630 
4631 
4643  std::vector<SolverOption*> getSolverOptions( std::string solver_name, bool getFreeOptions);
4644 
4652 
4653  /* --------------------------------------------------
4654  * set() methods
4655  * -------------------------------------------------- */
4656 
4660  bool setServiceURI( std::string serviceURI);
4661 
4665  bool setServiceName( std::string serviceName);
4666 
4670  bool setInstanceName( std::string instanceName);
4671 
4675  bool setInstanceLocation( std::string instanceLocation);
4676 
4681  bool setInstanceLocation( std::string instanceLocation, std::string locationType);
4682 
4686  bool setInstanceLocationType( std::string locationType);
4687 
4691  bool setJobID( std::string jobID);
4692 
4696  bool setSolverToInvoke( std::string solverToInvoke);
4697 
4701  bool setLicense( std::string license);
4702 
4706  bool setUserName( std::string userName);
4707 
4711  bool setPassword( std::string password);
4712 
4716  bool setContact( std::string contact);
4717 
4722  bool setContact( std::string contact, std::string transportType);
4723 
4727  bool setContactTransportType( std::string transportType);
4728 
4734  bool setOtherGeneralOptions(int numberOfOptions, OtherOption** other);
4735 
4742  bool setAnOtherGeneralOption(std::string name, std::string value, std::string description);
4743 
4750  bool setMinDiskSpace(std::string unit, std::string description, double value);
4751 
4755  bool setMinDiskSpace(double value);
4756 
4757  bool setMinDiskSpaceUnit(std::string unit);
4758 
4765  bool setMinMemorySize(std::string unit, std::string description, double value);
4766 
4770  bool setMinMemorySize(double value);
4771 
4772  bool setMinMemoryUnit(std::string unit);
4773 
4780  bool setMinCPUSpeed(std::string unit, std::string description, double value);
4781 
4785  bool setMinCPUSpeed(double value);
4786 
4787  bool setMinCPUSpeedUnit(std::string unit);
4788 
4794  bool setMinCPUNumber( int number, std::string description);
4795 
4799  bool setMinCPUNumber( int number);
4800 
4801  bool setOtherSystemOptions(int numberOfOptions, OtherOption** other);
4802 
4803  bool setAnOtherSystemOption(std::string name, std::string value, std::string description);
4804 
4805 
4806  bool setServiceType( std::string serviceType);
4807 
4808  bool setOtherServiceOptions(int numberOfOptions, OtherOption** other);
4809 
4810  bool setAnOtherServiceOption(std::string name, std::string value, std::string description);
4811 
4812 
4813  bool setMaxTime(double value, std::string unit);
4814 
4815  bool setMaxTime(double value);
4816 
4817  bool setMaxTimeUnit(std::string unit);
4818 
4819  bool setRequestedStartTime(std::string time);
4820 
4821  bool setJobDependencies(int numberOfDependencies, std::string* jobDependencies);
4822  bool setAnotherJobDependency(std::string jobID);
4823 
4824  bool setRequiredDirectories(int numberOfPaths, std::string* paths);
4825  bool setAnotherRequiredDirectory(std::string path);
4826 
4827  bool setRequiredFiles(int numberOfPaths, std::string* paths);
4828  bool setAnotherRequiredFile(std::string path);
4829 
4830  bool setDirectoriesToMake(int numberOfPaths, std::string* paths);
4831  bool setAnotherDirectoryToMake(std::string path);
4832 
4833  bool setFilesToMake(int numberOfPaths, std::string* paths);
4834  bool setAnotherFileToMake(std::string path);
4835 
4853  bool setPathPairs(int object, std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs);
4854 
4855  bool setInputDirectoriesToMove(int numberOfPathPairs, PathPair** pathPair);
4856  bool setAnotherInputDirectoryToMove(std::string fromPath, std::string toPath, bool makeCopy);
4857 
4858  bool setInputFilesToMove(int numberOfPathPairs, PathPair** pathPair);
4859  bool setAnotherInputFileToMove(std::string fromPath, std::string toPath, bool makeCopy);
4860 
4861  bool setOutputFilesToMove(int numberOfPathPairs, PathPair** pathPair);
4862  bool setAnotherOutputFileToMove(std::string fromPath, std::string toPath, bool makeCopy);
4863 
4864  bool setOutputDirectoriesToMove(int numberOfPathPairs, PathPair** pathPair);
4865  bool setAnotherOutputDirectoryToMove(std::string fromPath, std::string toPath, bool makeCopy);
4866 
4867  bool setFilesToDelete(int numberOfPaths, std::string* paths);
4868  bool setAnotherFileToDelete(std::string path);
4869 
4870  bool setDirectoriesToDelete(int numberOfPaths, std::string* paths);
4871  bool setAnotherDirectoryToDelete(std::string path);
4872 
4873  bool setProcessesToKill(int numberOfProcesses, std::string* processes);
4874  bool setAnotherProcessToKill(std::string process);
4875 
4876  bool setOtherJobOptions(int numberOfOptions, OtherOption** other);
4877  bool setAnOtherJobOption(std::string name, std::string value, std::string description);
4878 
4879 
4880  bool setNumberOfVariables(int numberOfVariables);
4881 
4882  bool setNumberOfObjectives(int numberOfObjectives);
4883 
4884  bool setNumberOfConstraints(int numberOfConstraints);
4885 
4886  bool setInitVarValues(int numberOfVar, int* idx, double* value, std::string* name);
4887  bool setInitVarValuesSparse(int numberOfVar, InitVarValue** var);
4888  bool setInitVarValuesSparse(int numberOfVar, InitVarValue** var, ENUM_COMBINE_ARRAYS disp);
4889  bool setInitVarValuesDense(int numberOfVar, double *value);
4890  bool setAnotherInitVarValue(int idx, double value);
4891 
4892  bool setInitVarValuesString(int numberOfVar, int* idx, std::string* value, std::string* name);
4893  bool setInitVarValuesStringSparse(int numberOfVar, InitVarValueString** var);
4895  bool setInitVarValuesStringDense(int numberOfVar, std::string *value);
4896  bool setAnotherInitVarValueString(int idx, std::string value);
4897 
4898  bool setInitBasisStatus(int object, int status, int *i, int ni);
4899  bool setInitBasisStatusSparse(int numberOfVar, InitBasStatus** var);
4900  bool setInitBasisStatusSparse(int numberOfVar, InitBasStatus** var, ENUM_COMBINE_ARRAYS disp);
4901  bool setInitBasisStatusDense(int numberOfVar, std::string *var);
4902 
4911  bool setAnotherInitBasisStatus(int type, int idx, int status);
4912 
4913  bool setIntegerVariableBranchingWeights(int numberOfVar, int* idx, double* value, std::string* name);
4916  bool setIntegerVariableBranchingWeightsDense(int numberOfVar, double *value);
4917  bool setAnotherIntegerVariableBranchingWeight(int idx, double value);
4918 
4919  bool setSOSVariableBranchingWeights(int numberOfSOS, SOSWeights** sos);
4920  bool setAnotherSOSVariableBranchingWeight(int sosIdx, int nvar, double weight, int* idx, double* value, std::string* name);
4921 
4922  bool setNumberOfOtherVariableOptions(int numberOfOther);
4923  bool setOtherVariableOptions(int numberOfVar, OtherVariableOption** var);
4925 
4941  bool setOtherVariableOptionAttributes(int iOther, int numberOfVar,
4942  int numberOfEnumerations, std::string name,
4943  std::string value, std::string solver,
4944  std::string category, std::string type,
4945  std::string varType, std::string enumType,
4946  std::string description);
4947 
4948 
4961  bool setOtherOptionOrResultEnumeration(int object, int otherOptionNumber, int enumerationNumber,
4962  int numberOfEl, std::string value, std::string description, int* idxArray);
4963 
4974  bool setOtherVariableOptionVar(int otherOptionNumber, int varNumber,
4975  int idx, std::string name, std::string value, std::string lbValue, std::string ubValue);
4976 
4977  bool setInitObjValues(int numberOfObj, int* idx, double* value, std::string* name);
4978  bool setInitObjValuesSparse(int numberOfObj, InitObjValue** obj);
4979  bool setInitObjValuesSparse(int numberOfObj, InitObjValue** obj, ENUM_COMBINE_ARRAYS disp);
4980  bool setInitObjValuesDense(int numberOfObj, double *value);
4981  bool setAnotherInitObjValue(int idx, double value);
4982 
4983  bool setInitObjBounds(int numberOfObj, int* idx, double* lbValue, double* ubValue, std::string* name);
4984  bool setInitObjBoundsSparse(int numberOfObj, InitObjBound** obj);
4985  bool setInitObjBoundsSparse(int numberOfObj, InitObjBound** obj, ENUM_COMBINE_ARRAYS disp);
4986  bool setInitObjBoundsDense(int numberOfObj, double *lb, double *ub);
4987  bool setAnotherInitObjBound(int idx, double lbValue, double ubValue);
4988 
4989  bool setNumberOfOtherObjectiveOptions(int numberOfOther);
4990  bool setOtherObjectiveOptions(int numberOfObj, OtherObjectiveOption** obj);
4991  //bool setOtherObjectiveOptions(int numberOfObj, OtherObjectiveOption** obj, ENUM_COMBINE_ARRAYS disp);
4993 
5009  bool setOtherObjectiveOptionAttributes(int iOther, int numberOfObj,
5010  int numberOfEnumerations, std::string name,
5011  std::string value, std::string solver,
5012  std::string category, std::string type,
5013  std::string objType, std::string enumType,
5014  std::string description);
5015 
5016 
5028  bool setOtherObjectiveOptionObj(int otherOptionNumber, int objNumber,
5029  int idx, std::string name, std::string value, std::string lbValue, std::string ubValue);
5030 
5031  bool setInitConValues(int numberOfCon, int* idx, double* value, std::string* name);
5032  bool setInitConValuesSparse(int numberOfCon, InitConValue** con);
5033  bool setInitConValuesSparse(int numberOfCon, InitConValue** con, ENUM_COMBINE_ARRAYS disp);
5034  bool setInitConValuesDense(int numberOfCon, double *value);
5035  bool setAnotherInitConValue(int idx, double value);
5036 
5037  bool setInitDualValues(int numberOfCon, int* idx, double* lbValue, double* ubValue, std::string* name);
5038  bool setInitDualVarValuesSparse(int numberOfCon, InitDualVarValue** con);
5040  bool setInitDualVarValuesDense(int numberOfCon, double *lb, double *ub);
5041  bool setAnotherInitDualVarValue(int idx, double lbValue, double ubValue);
5042 
5043  bool setNumberOfOtherConstraintOptions(int numberOfOther);
5044  bool setOtherConstraintOptions(int numberOfOptions, OtherConstraintOption** other);
5045  //bool setOtherConstraintOptions(int numberOfOptions, OtherConstraintOption** other, ENUM_COMBINE_ARRAYS disp);
5047 
5063  bool setOtherConstraintOptionAttributes(int iOther, int numberOfCon,
5064  int numberOfEnumerations, std::string name,
5065  std::string value, std::string solver,
5066  std::string category, std::string type,
5067  std::string conType, std::string enumType,
5068  std::string description);
5069 
5070 
5082  bool setOtherConstraintOptionCon(int otherOptionNumber, int conNumber,
5083  int idx, std::string name, std::string value, std::string lbValue, std::string ubValue);
5084 
5085  bool setNumberOfSolverOptions(int numberOfOptions);
5086 
5100  bool setSolverOptionContent(int iOption, int numberOfItems,
5101  std::string name,
5102  std::string value, std::string solver,
5103  std::string category, std::string type,
5104  std::string description, std::string *itemList);
5105 
5106  bool setSolverOptions(int numberOfSolverOptions, SolverOption** solverOption);
5107  bool setAnotherSolverOption(std::string name, std::string value, std::string solver,
5108  std::string category, std::string type, std::string description);
5109 
5110 
5111  bool setOptionInt(std::string optionName, int optionValue);
5112 
5113  bool setOptionStr(std::string optionName, std::string optionValue);
5114 
5115  bool setOptionDbl(std::string optionName, double value);
5116 
5117 };//OSOption
5118 
5119 #endif
ENUM_COMBINE_ARRAYS
An enum to streamline set() methods of vectors.
Definition: OSParameters.h:821
a data structure to represent an LP basis on both input and output
Definition: OSGeneral.h:646
the BranchingWeight class.
Definition: OSOption.h:1612
std::string name
optional variable name
Definition: OSOption.h:1619
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(BranchingWeight *that)
A function to check for the equality of two objects.
double value
branching weight
Definition: OSOption.h:1622
int idx
index of the variable
Definition: OSOption.h:1616
~BranchingWeight()
Class destructor.
BranchingWeight()
Default constructor.
bool deepCopyFrom(BranchingWeight *that)
A function to make a deep copy of an instance of this class.
the CPUNumber class.
Definition: OSGeneral.h:872
the CPUSpeed class.
Definition: OSGeneral.h:813
the ConstraintOption class.
Definition: OSOption.h:3264
InitConstraintValues * initialConstraintValues
initial values for the constraints
Definition: OSOption.h:3271
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool addOther(OtherConstraintOption *other)
A function to add an <other> element.
ConstraintOption()
Default constructor.
bool IsEqual(ConstraintOption *that)
A function to check for the equality of two objects.
bool deepCopyFrom(ConstraintOption *that)
A function to make a deep copy of an instance of this class.
InitDualVariableValues * initialDualValues
initial dual values for the constraints
Definition: OSOption.h:3274
OtherConstraintOption ** other
other information about the constraints
Definition: OSOption.h:3280
bool setOther(int numberOfOptions, OtherConstraintOption **other)
A function to set an array of <other> elements.
~ConstraintOption()
Class destructor.
int numberOfOtherConstraintOptions
number of <other> child elements
Definition: OSOption.h:3268
BasisStatus * initialBasisStatus
initial basis status for the slack variables
Definition: OSOption.h:3277
the ContactOption class.
Definition: OSOption.h:97
~ContactOption()
Class destructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
std::string value
the value of the <contact> element
Definition: OSOption.h:104
ContactOption()
Default constructor.
bool deepCopyFrom(ContactOption *that)
A function to make a deep copy of an instance of this class.
std::string transportType
the contact mechanism
Definition: OSOption.h:101
bool IsEqual(ContactOption *that)
A function to check for the equality of two objects.
the DirectoriesAndFiles class.
Definition: OSOption.h:781
int numberOfPaths
the number of <path> children
Definition: OSOption.h:785
bool deepCopyFrom(DirectoriesAndFiles *that)
A function to make a deep copy of an instance of this class.
std::string * path
the list of directory and file paths
Definition: OSOption.h:788
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool addPath(std::string path)
A function to add a <path> element.
DirectoriesAndFiles()
Default constructor.
bool setPath(int numberOfPaths, std::string *path)
A function to set an array of <path> elements.
bool IsEqual(DirectoriesAndFiles *that)
A function to check for the equality of two objects.
~DirectoriesAndFiles()
Class destructor.
a data structure that holds general information about files that conform to one of the OSxL schemas
Definition: OSGeneral.h:33
The GeneralOption Class.
Definition: OSOption.h:285
OtherOptions * otherOptions
the list of other general options
Definition: OSOption.h:320
InstanceLocationOption * instanceLocation
the location of the instance
Definition: OSOption.h:299
std::string license
the license information
Definition: OSOption.h:308
std::string serviceURI
the service URI
Definition: OSOption.h:290
std::string serviceName
the name of the service
Definition: OSOption.h:293
std::string jobID
the job ID
Definition: OSOption.h:302
std::string userName
the username
Definition: OSOption.h:311
~GeneralOption()
Class destructor.
std::string instanceName
the name of the instance
Definition: OSOption.h:296
std::string solverToInvoke
the solver to invoke
Definition: OSOption.h:305
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(GeneralOption *that)
A function to check for the equality of two objects.
GeneralOption()
Default constructor.
bool deepCopyFrom(GeneralOption *that)
A function to make a deep copy of an instance of this class.
std::string password
the password
Definition: OSOption.h:314
ContactOption * contact
the contact method
Definition: OSOption.h:317
the InitBasStatus class.
Definition: OSOption.h:1482
bool IsEqual(InitBasStatus *that)
A function to check for the equality of two objects.
bool deepCopyFrom(InitBasStatus *that)
A function to make a deep copy of an instance of this class.
~InitBasStatus()
Class destructor.
InitBasStatus()
Default constructor.
std::string value
initial value
Definition: OSOption.h:1489
int idx
variable index
Definition: OSOption.h:1486
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
the InitConValue class.
Definition: OSOption.h:2764
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
double value
initial value
Definition: OSOption.h:2774
InitConValue()
Default constructor.
std::string name
optional variable name
Definition: OSOption.h:2771
bool IsEqual(InitConValue *that)
A function to check for the equality of two objects.
~InitConValue()
Class destructor.
int idx
constraint index
Definition: OSOption.h:2768
bool deepCopyFrom(InitConValue *that)
A function to make a deep copy of an instance of this class.
the InitConstraintValues class.
Definition: OSOption.h:2823
bool setCon(int numberOfCon, int *idx, double *value, std::string *name)
Another alternative signature for this function.
bool addCon(int idx, double value)
A function to add a <con> element.
~InitConstraintValues()
Class destructor.
bool setCon(int numberOfCon, InitConValue **con, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
InitConValue ** con
initial value for each constraint
Definition: OSOption.h:2830
bool deepCopyFrom(InitConstraintValues *that)
A function to make a deep copy of an instance of this class.
bool IsEqual(InitConstraintValues *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool setCon(int numberOfCon, InitConValue **con)
A function to set an array of <con> elements.
bool addCon(int numberOfCon, InitConValue **con)
Alternative signature for this function.
int numberOfCon
number of <con> children
Definition: OSOption.h:2827
InitConstraintValues()
Default constructor.
the InitDualVarValue class.
Definition: OSOption.h:2925
std::string name
optional variable name
Definition: OSOption.h:2932
int idx
constraint index
Definition: OSOption.h:2929
InitDualVarValue()
Default constructor.
double ubDualValue
initial upper bound
Definition: OSOption.h:2938
bool deepCopyFrom(InitDualVarValue *that)
A function to make a deep copy of an instance of this class.
double lbDualValue
initial lower bound
Definition: OSOption.h:2935
~InitDualVarValue()
Class destructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(InitDualVarValue *that)
A function to check for the equality of two objects.
the InitDualVariableValues class.
Definition: OSOption.h:2988
bool deepCopyFrom(InitDualVariableValues *that)
A function to make a deep copy of an instance of this class.
bool setCon(int numberOfCon, int *idx, double *lbValue, double *ubValue, std::string *name)
Another alternative signature for this function.
~InitDualVariableValues()
Class destructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
int numberOfCon
number of <con> children
Definition: OSOption.h:2992
bool addCon(int idx, double lbDualValue, double ubDualValue)
A function to add a <con> element.
bool addCon(int numberOfCon, InitDualVarValue **con)
Alternative signature for this function.
InitDualVariableValues()
Default constructor.
bool setCon(int numberOfCon, InitDualVarValue **con, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
InitDualVarValue ** con
initial dual values for each constraint
Definition: OSOption.h:2995
bool IsEqual(InitDualVariableValues *that)
A function to check for the equality of two objects.
bool setCon(int numberOfCon, InitDualVarValue **con)
A function to set an array of <con> elements.
the InitObjBound class.
Definition: OSOption.h:2344
double lbValue
initial lower bound
Definition: OSOption.h:2354
int idx
objective index
Definition: OSOption.h:2348
double ubValue
initial upper bound
Definition: OSOption.h:2357
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(InitObjBound *that)
A function to check for the equality of two objects.
~InitObjBound()
Class destructor.
std::string name
optional variable name
Definition: OSOption.h:2351
InitObjBound()
Default constructor.
bool deepCopyFrom(InitObjBound *that)
A function to make a deep copy of an instance of this class.
the InitObjValue class.
Definition: OSOption.h:2183
InitObjValue()
Default constructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(InitObjValue *that)
A function to check for the equality of two objects.
std::string name
optional objective name
Definition: OSOption.h:2190
bool deepCopyFrom(InitObjValue *that)
A function to make a deep copy of an instance of this class.
~InitObjValue()
Class destructor.
double value
initial value
Definition: OSOption.h:2193
int idx
objective index
Definition: OSOption.h:2187
the InitObjectiveBounds class.
Definition: OSOption.h:2406
InitObjBound ** obj
initial bounds for each objective
Definition: OSOption.h:2413
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool addObj(int numberOfObj, InitObjBound **obj)
Alternative signature for this function.
~InitObjectiveBounds()
Class destructor.
bool deepCopyFrom(InitObjectiveBounds *that)
A function to make a deep copy of an instance of this class.
bool setObj(int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name)
Another alternative signature for this function.
bool setObj(int numberOfObj, InitObjBound **obj)
A function to set an array of <obj> elements.
int numberOfObj
number of <obj> children
Definition: OSOption.h:2410
bool addObj(int idx, double lbValue, double ubValue)
A function to add a <obj> element.
bool IsEqual(InitObjectiveBounds *that)
A function to check for the equality of two objects.
bool setObj(int numberOfObj, InitObjBound **obj, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
InitObjectiveBounds()
Default constructor.
the InitObjectiveValues class.
Definition: OSOption.h:2242
InitObjValue ** obj
initial value for each objective
Definition: OSOption.h:2249
~InitObjectiveValues()
Class destructor.
bool setObj(int numberOfObj, int *idx, double *value, std::string *name)
Another alternative signature for this function.
bool deepCopyFrom(InitObjectiveValues *that)
A function to make a deep copy of an instance of this class.
InitObjectiveValues()
Default constructor.
int numberOfObj
number of <obj> children
Definition: OSOption.h:2246
bool addObj(int numberOfObj, InitObjValue **obj)
Alternative signature for this function.
bool addObj(int idx, double value)
A function to add a <obj> element.
bool setObj(int numberOfObj, InitObjValue **obj)
A function to set an array of <obj> elements.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(InitObjectiveValues *that)
A function to check for the equality of two objects.
bool setObj(int numberOfObj, InitObjValue **obj, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
the InitVarValueString class.
Definition: OSOption.h:1321
bool deepCopyFrom(InitVarValueString *that)
A function to make a deep copy of an instance of this class.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
std::string value
initial value
Definition: OSOption.h:1331
~InitVarValueString()
Class destructor.
int idx
variable index
Definition: OSOption.h:1325
InitVarValueString()
Default constructor.
std::string name
optional variable name
Definition: OSOption.h:1328
bool IsEqual(InitVarValueString *that)
A function to check for the equality of two objects.
the InitVarValue class.
Definition: OSOption.h:1160
bool deepCopyFrom(InitVarValue *that)
A function to make a deep copy of an instance of this class.
InitVarValue()
Default constructor.
bool IsEqual(InitVarValue *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
double value
initial value
Definition: OSOption.h:1170
std::string name
optional variable name
Definition: OSOption.h:1167
~InitVarValue()
Class destructor.
int idx
variable index
Definition: OSOption.h:1164
the InitVariableValuesString class.
Definition: OSOption.h:1380
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool deepCopyFrom(InitVariableValuesString *that)
A function to make a deep copy of an instance of this class.
bool setVar(int numberOfVar, InitVarValueString **var)
A function to set an array of elements.
~InitVariableValuesString()
Class destructor.
bool addVar(int idx, std::string value)
A function to add a element.
bool IsEqual(InitVariableValuesString *that)
A function to check for the equality of two objects.
bool setVar(int numberOfVar, int *idx, std::string *value, std::string *name)
Another alternative signature for this function.
InitVarValueString ** var
initial value for each variable
Definition: OSOption.h:1387
bool addVar(int numberOfVar, InitVarValueString **var)
Alternative signature for this function.
int numberOfVar
number of children
Definition: OSOption.h:1384
bool setVar(int numberOfVar, InitVarValueString **var, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
InitVariableValuesString()
Default constructor.
the InitVariableValues class.
Definition: OSOption.h:1219
bool addVar(int numberOfVar, InitVarValue **var)
Alternative signature for this function.
bool IsEqual(InitVariableValues *that)
A function to check for the equality of two objects.
bool setVar(int numberOfVar, InitVarValue **var, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
InitVarValue ** var
initial value for each variable
Definition: OSOption.h:1226
bool setVar(int numberOfVar, InitVarValue **var)
A function to set an array of elements.
bool addVar(int idx, double value)
A function to add a element.
bool setVar(int numberOfVar, int *idx, double *value, std::string *name)
Another alternative signature for this function.
int numberOfVar
number of children
Definition: OSOption.h:1223
~InitVariableValues()
Class destructor.
InitVariableValues()
Default constructor.
bool deepCopyFrom(InitVariableValues *that)
A function to make a deep copy of an instance of this class.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
the InitialBasisStatus class.
Definition: OSOption.h:1541
bool setVar(int numberOfVar, InitBasStatus **var)
A function to set an array of elements.
~InitialBasisStatus()
Class destructor.
InitBasStatus ** var
initial value for each variable
Definition: OSOption.h:1548
InitialBasisStatus()
Default constructor.
bool IsEqual(InitialBasisStatus *that)
A function to check for the equality of two objects.
bool addVar(int idx, std::string value)
A function to add a element.
int numberOfVar
number of children
Definition: OSOption.h:1545
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool deepCopyFrom(InitialBasisStatus *that)
A function to make a deep copy of an instance of this class.
the InstanceLocationOption class.
Definition: OSOption.h:40
bool deepCopyFrom(InstanceLocationOption *that)
A function to make a deep copy of an instance of this class.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
InstanceLocationOption()
Default constructor.
~InstanceLocationOption()
Class destructor.
std::string value
the value of the <instanceLocation> element
Definition: OSOption.h:47
std::string locationType
the type of the location
Definition: OSOption.h:44
bool IsEqual(InstanceLocationOption *that)
A function to check for the equality of two objects.
the IntegerVariableBranchingWeights class.
Definition: OSOption.h:1672
BranchingWeight ** var
branching weight for each variable
Definition: OSOption.h:1679
bool setVar(int numberOfVar, BranchingWeight **var)
A function to set an array of elements.
int numberOfVar
number of children
Definition: OSOption.h:1676
bool addVar(int idx, double value)
A function to add a element.
bool addVar(int numberOfVar, BranchingWeight **var)
Alternative signature for this function.
bool setVar(int numberOfVar, int *idx, double *value, std::string *name)
Another alternative signature for this function.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool IsEqual(IntegerVariableBranchingWeights *that)
A function to check for the equality of two objects.
bool deepCopyFrom(IntegerVariableBranchingWeights *that)
A function to make a deep copy of an instance of this class.
bool setVar(int numberOfVar, BranchingWeight **var, ENUM_COMBINE_ARRAYS disp)
Alternative signature for this function.
IntegerVariableBranchingWeights()
Default constructor.
~IntegerVariableBranchingWeights()
Class destructor.
the JobDependencies class.
Definition: OSOption.h:710
bool IsEqual(JobDependencies *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
std::string * jobID
the list of job IDs
Definition: OSOption.h:717
bool setJobID(int numberOfJobIDs, std::string *jobID)
A function to set an array of <jobID> elements.
bool deepCopyFrom(JobDependencies *that)
A function to make a deep copy of an instance of this class.
bool addJobID(std::string jobID)
A function to add an <jobID> element.
int numberOfJobIDs
the number of entries in the list of job dependencies
Definition: OSOption.h:714
JobDependencies()
Default constructor.
~JobDependencies()
Class destructor.
the JobOption class.
Definition: OSOption.h:1065
Processes * processesToKill
processes to kill upon completion
Definition: OSOption.h:1108
DirectoriesAndFiles * requiredDirectories
directories required to run the job
Definition: OSOption.h:1078
DirectoriesAndFiles * filesToMake
files to make during the job
Definition: OSOption.h:1087
bool deepCopyFrom(JobOption *that)
A function to make a deep copy of an instance of this class.
DirectoriesAndFiles * directoriesToDelete
directories to delete upon completion
Definition: OSOption.h:1105
std::string requestedStartTime
the requested time to start the job
Definition: OSOption.h:1072
DirectoriesAndFiles * requiredFiles
files required to run the job
Definition: OSOption.h:1081
DirectoriesAndFiles * filesToDelete
files to delete upon completion
Definition: OSOption.h:1102
JobDependencies * dependencies
the dependency set
Definition: OSOption.h:1075
PathPairs * inputFilesToMove
input files to move or copy
Definition: OSOption.h:1093
TimeSpan * maxTime
the maximum time allowed
Definition: OSOption.h:1069
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
JobOption()
Default constructor.
~JobOption()
Class destructor.
PathPairs * outputDirectoriesToMove
output directories to move or copy
Definition: OSOption.h:1099
bool IsEqual(JobOption *that)
A function to check for the equality of two objects.
PathPairs * inputDirectoriesToMove
input directories to move or copy
Definition: OSOption.h:1090
PathPairs * outputFilesToMove
output files to move or copy
Definition: OSOption.h:1096
DirectoriesAndFiles * directoriesToMake
directories to make during the job
Definition: OSOption.h:1084
OtherOptions * otherOptions
list of other job options
Definition: OSOption.h:1111
the MaxTime class.
Definition: OSOption.h:669
MaxTime()
Default constructor.
~MaxTime()
Class destructor.
std::string unit
the unit in which time is measured
Definition: OSOption.h:673
bool IsEqual(MaxTime *that)
A function to check for the equality of two objects.
double value
the maximum time allowed
Definition: OSOption.h:676
the MinCPUNumber class.
Definition: OSOption.h:505
bool IsEqual(MinCPUNumber *that)
A function to check for the equality of two objects.
int value
the minimum number of CPUs required
Definition: OSOption.h:512
MinCPUNumber()
Default constructor.
~MinCPUNumber()
Class destructor.
std::string description
additional description about the CPU
Definition: OSOption.h:509
the MinCPUSpeed class.
Definition: OSOption.h:460
double value
the minimum CPU speed required
Definition: OSOption.h:470
MinCPUSpeed()
Default constructor.
bool IsEqual(MinCPUSpeed *that)
A function to check for the equality of two objects.
~MinCPUSpeed()
Class destructor.
std::string description
additional description about the CPU speed
Definition: OSOption.h:467
std::string unit
the unit in which CPU speed is measured
Definition: OSOption.h:464
the MinDiskSpace class.
Definition: OSOption.h:370
~MinDiskSpace()
Class destructor.
bool IsEqual(MinDiskSpace *that)
A function to check for the equality of two objects.
MinDiskSpace()
Default constructor.
std::string description
additional description about the disk space
Definition: OSOption.h:377
std::string unit
the unit in which disk space is measured
Definition: OSOption.h:374
double value
the minimum disk space required
Definition: OSOption.h:380
the MinMemorySize class.
Definition: OSOption.h:415
bool IsEqual(MinMemorySize *that)
A function to check for the equality of two objects.
MinMemorySize()
Default constructor.
double value
the minimum memory size required
Definition: OSOption.h:425
std::string unit
the unit in which memory size is measured
Definition: OSOption.h:419
std::string description
additional description about the memory
Definition: OSOption.h:422
~MinMemorySize()
Class destructor.
The Option Class.
Definition: OSOption.h:3565
BranchingWeight ** getIntegerVariableBranchingWeightsSparse()
Get the integer branching weights in sparse form.
bool setInitConValues(int numberOfCon, int *idx, double *value, std::string *name)
double getMinDiskSpace()
Get the minimum required disk space.
std::string getFileCreator()
Get the name of the person who created the file.
bool setAnotherSOSVariableBranchingWeight(int sosIdx, int nvar, double weight, int *idx, double *value, std::string *name)
bool setDirectoriesToDelete(int numberOfPaths, std::string *paths)
double * getInitConValuesDense()
Get the initial values associated with the constraints in dense form.
PathPair ** getOutputFilesToMove()
Get the array of output files to move.
InitDualVarValue ** getInitDualVarValuesSparse()
Get the initial bounds associated with the dual variables in sparse form.
bool setInstanceLocationType(std::string locationType)
Set the instance location type.
bool setMinMemorySize(std::string unit, std::string description, double value)
Set the minimum memory size required for the current job.
std::vector< OtherVariableOption * > getOtherVariableOptions(std::string solver_name)
Get the <other> variable options associated with a particular solver.
~OSOption()
Class destructor.
std::string getInstanceLocationType()
Get the location type.
bool setAnOtherConstraintOption(OtherConstraintOption *optionValue)
bool setHeader(std::string name, std::string source, std::string description, std::string fileCreator, std::string licence)
A function to populate an instance of the option header element.
int getMinCPUNumber()
Get the minimum required number of CPUs.
bool setOptionInt(std::string optionName, int optionValue)
int getNumberOfRequiredDirectories()
Get the number of required directories.
bool setMinDiskSpace(std::string unit, std::string description, double value)
Set the minimum disk space required for the current job.
double * getIntegerVariableBranchingWeightsDense(int numberOfVariables)
Get the integer branching weights in dense form.
std::string * getDirectoriesToMake()
Get the array of directories to make.
bool setAnotherDirectoryToMake(std::string path)
int getNumberOfDirectoriesToMake()
Get the number of directories to make.
bool setIntegerVariableBranchingWeightsDense(int numberOfVar, double *value)
bool setAnOtherSystemOption(std::string name, std::string value, std::string description)
bool setAnotherInitDualVarValue(int idx, double lbValue, double ubValue)
bool setInitVarValues(int numberOfVar, int *idx, double *value, std::string *name)
std::string getFileName()
Get the name of the file.
bool setInitDualValues(int numberOfCon, int *idx, double *lbValue, double *ubValue, std::string *name)
std::string getFileDescription()
Get a description for the file or problem.
bool setAnOtherJobOption(std::string name, std::string value, std::string description)
bool setInstanceName(std::string instanceName)
Set the instance name.
bool setInitVarValuesStringDense(int numberOfVar, std::string *value)
bool IsEqual(OSOption *that)
A function to check for the equality of two objects.
OptimizationOption * optimization
optimizationOption holds the fifth child of the OSOption specified by the OSoL Schema.
Definition: OSOption.h:3596
bool setInitObjBoundsSparse(int numberOfObj, InitObjBound **obj)
bool setOtherObjectiveOptions(int numberOfObj, OtherObjectiveOption **obj)
std::string getContactTransportType()
Get the transport type.
int getNumberOfSOS()
Get the number of special ordered sets for which branching weights are provided.
std::vector< SolverOption * > getSolverOptions(std::string solver_name)
Get the options associated with a given solver.
bool setServiceURI(std::string serviceURI)
Set the serviceURI.
bool setAnotherInitBasisStatus(int type, int idx, int status)
Set the basis status for another variable, objective or constraint/slack.
bool setSolverToInvoke(std::string solverToInvoke)
Set the solver to be invoked.
bool setFilesToDelete(int numberOfPaths, std::string *paths)
bool setMinCPUSpeed(double value)
Alternate signature to set only the number of units.
GeneralOption * general
generalOption holds the first child of the OSOption specified by the OSoL Schema.
Definition: OSOption.h:3580
bool setInputFilesToMove(int numberOfPathPairs, PathPair **pathPair)
int * getObjectiveInitialBasisStatusDense(int numberOfObjectives)
Get the initial basis status for all objectives in dense form.
int getNumberOfOtherSystemOptions()
Get the number of <other> options in the <system> element.
bool setOtherObjectiveOptionAttributes(int iOther, int numberOfObj, int numberOfEnumerations, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string objType, std::string enumType, std::string description)
Set the attributes for one particular <other> <objective> option.
int getNumberOfOutputDirectoriesToMove()
Get the number of output directories to move.
int getNumberOfInputDirectoriesToMove()
Get the number of input directories to move.
bool setSolverOptionContent(int iOption, int numberOfItems, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description, std::string *itemList)
Set the attributes for one particular solver option.
bool setInputDirectoriesToMove(int numberOfPathPairs, PathPair **pathPair)
bool setAnotherInitObjBound(int idx, double lbValue, double ubValue)
bool setOtherConstraintOptionCon(int otherOptionNumber, int conNumber, int idx, std::string name, std::string value, std::string lbValue, std::string ubValue)
Set one <con> element associated with an <other> option in the <constraints> element.
bool setInstanceLocation(std::string instanceLocation)
Set the instance location.
SOSWeights ** getSOSVariableBranchingWeightsSparse()
Get the SOS branching weights in sparse form.
double * getIntegerVariableBranchingWeightsDense()
Get the integer branching weights in dense form.
bool setNumberOfOtherConstraintOptions(int numberOfOther)
bool setMaxTime(double value, std::string unit)
PathPair ** getInputFilesToMove()
Get the array of input files to move.
bool setMaxTimeUnit(std::string unit)
double * getInitObjValuesDense(int numberOfObjectives)
Get the initial values associated with the objectives in dense form.
std::string getMinCPUSpeedUnit()
Get the CPU speed unit.
OtherOption ** getOtherOptions(std::string elementName)
Get the array of other options associated with any element.
bool setInitObjValuesDense(int numberOfObj, double *value)
double * getInitObjUpperBoundsDense(int numberOfObjectives)
Get the initial upper bounds associated with the objectives in dense form.
std::string getOptionStr(std::string optionName)
Get any of the string-valued options.
bool setAnotherInitObjValue(int idx, double value)
std::string getSolverToInvoke()
Get the solver name.
std::string getMinCPUSpeedDescription()
Get the CPU speed description.
bool setInitConValuesSparse(int numberOfCon, InitConValue **con)
bool setInitObjValuesSparse(int numberOfObj, InitObjValue **obj)
bool setMinCPUSpeedUnit(std::string unit)
bool setNumberOfOtherObjectiveOptions(int numberOfOther)
OSOption()
Default constructor.
bool setJobID(std::string jobID)
Set the job ID.
bool setInitBasisStatusSparse(int numberOfVar, InitBasStatus **var)
int * getVariableInitialBasisStatusDense(int numberOfVariables)
Get the initial basis status for all variables in dense form.
int getNumberOfRequiredFiles()
Get the number of required files.
bool setMinMemorySize(double value)
Alternate signature to set only the number of units.
double * getInitDualVarLowerBoundsDense(int numberOfConstraints)
Get the initial dual variables associated with the lower bounds in dense form.
bool setOtherJobOptions(int numberOfOptions, OtherOption **other)
int getNumberOfConstraints()
Get the number of constraints in the instance.
std::string getMaxTimeUnit()
Get the time unit.
bool setContact(std::string contact)
Set the contact information.
double getMinCPUSpeed()
Get the minimum required CPU speed.
bool setInitConValuesSparse(int numberOfCon, InitConValue **con, ENUM_COMBINE_ARRAYS disp)
std::string getJobID()
Get the job ID.
std::string getMinMemoryDescription()
get the memory description
OtherConstraintOption ** getAllOtherConstraintOptions()
Get all <other> constraint options.
bool setInitVarValuesStringSparse(int numberOfVar, InitVarValueString **var)
bool setAnotherInputFileToMove(std::string fromPath, std::string toPath, bool makeCopy)
OtherObjectiveOption * getOtherObjectiveOption(int optionNumber)
Get one particular <other> objective option from the array of options.
double getMinMemorySize()
Get the minimum required memory.
std::string getServiceType()
Get the service type.
bool setInitDualVarValuesSparse(int numberOfCon, InitDualVarValue **con, ENUM_COMBINE_ARRAYS disp)
bool setInitVarValuesStringSparse(int numberOfVar, InitVarValueString **var, ENUM_COMBINE_ARRAYS disp)
OtherOption ** getOtherServiceOptions()
Get the array of other options associated with the <service> element.
bool setAnOtherGeneralOption(std::string name, std::string value, std::string description)
Add another general option to the <other> option array.
bool setMinMemoryUnit(std::string unit)
bool setOtherServiceOptions(int numberOfOptions, OtherOption **other)
std::string getPassword()
Get the password.
bool setRequiredFiles(int numberOfPaths, std::string *paths)
bool setSolverOptions(int numberOfSolverOptions, SolverOption **solverOption)
bool setNumberOfSolverOptions(int numberOfOptions)
bool setOptionStr(std::string optionName, std::string optionValue)
std::string getMinCPUNumberDescription()
Get the CPU description.
bool deepCopyFrom(OSOption *that)
A function to make a deep copy of an OSOption object.
bool setInitObjBounds(int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name)
bool setInitBasisStatusDense(int numberOfVar, std::string *var)
std::string * getDirectoriesToDelete()
Get the array of directories to delete.
bool setOtherVariableOptionVar(int otherOptionNumber, int varNumber, int idx, std::string name, std::string value, std::string lbValue, std::string ubValue)
Set one element associated with an <other> option in the <variables> element.
double * getInitObjLowerBoundsDense(int numberOfObjectives)
Get the initial lower bounds associated with the objectives in dense form.
std::string getContact()
Get the contact information.
int getNumberOfInitObjBounds()
Get the number of initial objective bounds.
bool setInitObjValues(int numberOfObj, int *idx, double *value, std::string *name)
OtherOption ** getOtherJobOptions()
Get the array of other options associated with the <job> element.
bool setOtherVariableOptions(int numberOfVar, OtherVariableOption **var)
int getNumberOfProcessesToKill()
Get the number of processes to kill.
bool setAnotherInitVarValueString(int idx, std::string value)
std::string getLicense()
Get the license string.
int getNumberOfOtherServiceOptions()
Get the number of <other> options in the <service> element.
bool setAnOtherServiceOption(std::string name, std::string value, std::string description)
bool setInitDualVarValuesSparse(int numberOfCon, InitDualVarValue **con)
bool setMinCPUNumber(int number)
Alternate signature to set only the number of cores.
bool setOutputDirectoriesToMove(int numberOfPathPairs, PathPair **pathPair)
bool setAnotherProcessToKill(std::string process)
OtherOption ** getOtherGeneralOptions()
Get the array of other options associated with the <general> element.
std::string getMinMemoryUnit()
Get the memory unit.
bool setIntegerVariableBranchingWeightsSparse(int numberOfVar, BranchingWeight **var, ENUM_COMBINE_ARRAYS disp)
bool setInitVarValuesDense(int numberOfVar, double *value)
bool setAnOtherObjectiveOption(OtherObjectiveOption *objOption)
int getNumberOfInitObjValues()
Get the number of initial objective values.
OtherObjectiveOption ** getAllOtherObjectiveOptions()
Get all <other> objective options.
std::vector< OtherConstraintOption * > getOtherConstraintOptions(std::string solver_name)
Get the array of other constraint options.
bool setOptionDbl(std::string optionName, double value)
bool setNumberOfObjectives(int numberOfObjectives)
std::string getInstanceName()
Get the instance name.
bool setAnotherInitVarValue(int idx, double value)
bool setInitBasisStatus(int object, int status, int *i, int ni)
bool setDirectoriesToMake(int numberOfPaths, std::string *paths)
GeneralFileHeader * optionHeader
OSOption has a header and five other children: general, system, service, job, and optimization.
Definition: OSOption.h:3576
bool setMaxTime(double value)
bool setIntegerVariableBranchingWeightsSparse(int numberOfVar, BranchingWeight **var)
int getNumberOfIntegerVariableBranchingWeights()
Get the number of variables for which integer branching weights are provided.
double * getInitDualVarUpperBoundsDense()
Get the initial dual variables associated with the upper bounds in dense form.
std::vector< SolverOption * > getSolverOptions(std::string solver_name, bool getFreeOptions)
Get the options associated with a given solver AND options not associated with any solver (if desired...
bool setAnotherOutputDirectoryToMove(std::string fromPath, std::string toPath, bool makeCopy)
bool setInitBasisStatusSparse(int numberOfVar, InitBasStatus **var, ENUM_COMBINE_ARRAYS disp)
int getNumberOfFilesToDelete()
Get the number of files to delete.
int getNumberOfSOSVarBranchingWeights(int iSOS)
Get the number of variables for which branching weights are provided in a particular SOS.
PathPair ** getInputDirectoriesToMove()
Get the array of input directories to move.
double * getInitObjUpperBoundsDense()
Get the initial upper bounds associated with the objectives in dense form.
bool setAnotherFileToMake(std::string path)
bool setMinDiskSpace(double value)
Alternate signature to set only the number of units.
PathPair ** getOutputDirectoriesToMove()
Get the array of output directories to move.
int getNumberOfDirectoriesToDelete()
Get the number of directories to delete.
SolverOption ** getAllSolverOptions()
Get all solver options.
double * getInitDualVarUpperBoundsDense(int numberOfConstraints)
Get the initial dual variables associated with the upper bounds in dense form.
std::string getMinDiskSpaceDescription()
get the disk space description
std::string getFileSource()
Get the source of the file or problem.
int getNumberOfInitVarValues()
Get the number of initial variable values.
bool setUserName(std::string userName)
Set the username.
std::string * getInitBasisStatusDense()
Get the initial basis information in dense form.
bool setOutputFilesToMove(int numberOfPathPairs, PathPair **pathPair)
std::string * getInitVarValuesStringDense()
Get the initial value strings associated with the variables in dense form.
int getNumberOfInitialBasisElements(int type, int status)
Get the number of initial basis elements for a particular variable type and basis status.
std::string * getRequiredDirectories()
Get the array of required directories.
bool setInitDualVarValuesDense(int numberOfCon, double *lb, double *ub)
OtherConstraintOption * getOtherConstraintOption(int optionNumber)
Get one particular <other> constraint option from the array of options.
bool setFilesToMake(int numberOfPaths, std::string *paths)
std::string * getFilesToMake()
Get the array of files to make.
bool setAnotherOutputFileToMove(std::string fromPath, std::string toPath, bool makeCopy)
bool setAnotherInputDirectoryToMove(std::string fromPath, std::string toPath, bool makeCopy)
bool setNumberOfVariables(int numberOfVariables)
InitConValue ** getInitConValuesSparse()
Get the initial values associated with the constraints in sparse form.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
double getOptionDbl(std::string optionName)
Get any of the double-valued options.
std::string getServiceURI()
Get the service URI.
double * getInitVarValuesDense(int numberOfVariables)
Get the initial values associated with the variables in dense form.
OtherOption ** getOtherSystemOptions()
Get the array of other options associated with the <system> element.
bool setAnotherRequiredDirectory(std::string path)
bool setAnotherRequiredFile(std::string path)
bool setInstanceLocation(std::string instanceLocation, std::string locationType)
Alternative signature to set the instance location and location type simultaneously.
bool setOtherSystemOptions(int numberOfOptions, OtherOption **other)
int getNumberOfOtherVariableOptions()
Get the number of other variable options.
ServiceOption * service
serviceOption holds the third child of the OSOption specified by the OSoL Schema.
Definition: OSOption.h:3588
bool setOtherOptionOrResultEnumeration(int object, int otherOptionNumber, int enumerationNumber, int numberOfEl, std::string value, std::string description, int *idxArray)
Set one enumeration associated with an <other> option in the <variables>, <objectives> or <constraint...
std::string getUserName()
Get the user name.
bool setInitConValuesDense(int numberOfCon, double *value)
double getMaxTime()
Get the maximum allowed time.
bool setAnOtherVariableOption(OtherVariableOption *varOption)
bool setContactTransportType(std::string transportType)
Set the transport type for contact.
SystemOption * system
systemOption holds the second child of the OSOption specified by the OSoL Schema.
Definition: OSOption.h:3584
InitObjBound ** getInitObjBoundsSparse()
Get the initial bounds associated with the objectives in sparse form.
int getNumberOfOtherJobOptions()
Get the number of <other> options in the <job> element.
bool setAnotherJobDependency(std::string jobID)
bool setOtherObjectiveOptionObj(int otherOptionNumber, int objNumber, int idx, std::string name, std::string value, std::string lbValue, std::string ubValue)
Set one <obj> element associated with an <other> option in the <objectives> element.
double * getInitVarValuesDense()
Get the initial values associated with the variables in dense form.
bool setMinCPUSpeed(std::string unit, std::string description, double value)
Set the minimum CPU speed required for the current job.
std::string * getProcessesToKill()
Get the array of processes to kill.
std::string * getInitVarValuesStringDense(int numberOfVariables)
Get the initial value strings associated with the variables in dense form.
bool setAnotherDirectoryToDelete(std::string path)
bool setMinCPUNumber(int number, std::string description)
Set the minimum number of CPU cores required for the current job.
bool setRequiredDirectories(int numberOfPaths, std::string *paths)
OtherOption ** getAllOtherOptions()
Get the array of all other options associated with the <general>, <system>, <service> and <job> eleme...
bool setProcessesToKill(int numberOfProcesses, std::string *processes)
bool setServiceName(std::string serviceName)
Set the service name.
std::string * getRequiredFiles()
Get the array of required files.
int getOptionInt(std::string optionName)
Get any of the integer-valued options.
bool setAnotherFileToDelete(std::string path)
std::string getRequestedStartTime()
Get the requested starting time.
bool setPassword(std::string password)
Set the password.
int getNumberOfInputFilesToMove()
Get the number of input files to move.
int getNumberOfInitDualVarValues()
Get the number of initial dual variable values.
bool setAnotherIntegerVariableBranchingWeight(int idx, double value)
double * getInitObjLowerBoundsDense()
Get the initial lower bounds associated with the objectives in dense form.
double * getInitConValuesDense(int numberOfConstraints)
Get the initial values associated with the constraints in dense form.
std::string getInstanceLocation()
Get the instance location.
bool setOtherGeneralOptions(int numberOfOptions, OtherOption **other)
Set the other general options as an entire array.
bool setInitObjValuesSparse(int numberOfObj, InitObjValue **obj, ENUM_COMBINE_ARRAYS disp)
OtherVariableOption * getOtherVariableOption(int optionNumber)
Get one particular <other> variable option from the array of options.
bool setSOSVariableBranchingWeights(int numberOfSOS, SOSWeights **sos)
bool setInitObjBoundsSparse(int numberOfObj, InitObjBound **obj, ENUM_COMBINE_ARRAYS disp)
int getNumberOfInitVarValuesString()
Get the number of initial variable strings.
int getNumberOfJobDependencies()
Get the number of job dependencies.
bool setInitVarValuesString(int numberOfVar, int *idx, std::string *value, std::string *name)
bool setContact(std::string contact, std::string transportType)
Alternative signature to set the contact information and transport type simultaneously.
bool setOtherVariableOptionAttributes(int iOther, int numberOfVar, int numberOfEnumerations, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string varType, std::string enumType, std::string description)
Set the attributes for one particular <other> <variable> option.
bool setNumberOfOtherVariableOptions(int numberOfOther)
int getNumberOfOtherConstraintOptions()
Get the number of other constraint options.
int * getSlackVariableInitialBasisStatusDense(int numberOfConstraints)
Get the initial basis status for all slack variables in dense form.
bool setIntegerVariableBranchingWeights(int numberOfVar, int *idx, double *value, std::string *name)
InitVarValueString ** getInitVarValuesStringSparse()
Get the initial value strings associated with the variables in sparse form.
bool setRequestedStartTime(std::string time)
bool setAnotherSolverOption(std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
bool setInitObjBoundsDense(int numberOfObj, double *lb, double *ub)
int getNumberOfInitConValues()
Get the number of initial constraint values.
int getNumberOfVariables()
Get the number of variables in the instance.
InitVarValue ** getInitVarValuesSparse()
Get the initial values associated with the variables in sparse form.
bool setPathPairs(int object, std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs)
setPathPairs set a number of path pairs into the OSOption object
int getNumberOfOtherGeneralOptions()
Get the number of <other> options in the <general> element.
int getNumberOfFilesToMake()
Get the number of files to make.
int getNumberOfObjectives()
Get the number of objectives in the instance.
std::vector< OtherObjectiveOption * > getOtherObjectiveOptions(std::string solver_name)
Get the array of other objective options.
std::string getMinDiskSpaceUnit()
Get the disk space unit.
OtherVariableOption ** getAllOtherVariableOptions()
Get all <other> variable options.
bool setInitVarValuesSparse(int numberOfVar, InitVarValue **var, ENUM_COMBINE_ARRAYS disp)
bool setServiceType(std::string serviceType)
bool setLicense(std::string license)
Set the license information.
bool setInitVarValuesSparse(int numberOfVar, InitVarValue **var)
JobOption * job
jobOption holds the fourth child of the OSOption specified by the OSoL Schema.
Definition: OSOption.h:3592
double * getInitObjValuesDense()
Get the initial values associated with the objectives in dense form.
int getNumberOfSolverOptions()
Get the number of solver options.
double * getInitDualVarLowerBoundsDense()
Get the initial dual variables associated with the lower bounds in dense form.
bool setMinDiskSpaceUnit(std::string unit)
bool setOtherConstraintOptionAttributes(int iOther, int numberOfCon, int numberOfEnumerations, std::string name, std::string value, std::string solver, std::string category, std::string type, std::string conType, std::string enumType, std::string description)
Set the attributes for one particular <other> <constraint> option.
bool setAnotherInitConValue(int idx, double value)
std::string getFileLicence()
Get licence information associated with the file.
InitBasStatus ** getInitBasisStatusSparse()
Get the initial basis status in sparse form.
int getNumberOfOutputFilesToMove()
Get the number of output files to move.
InitObjValue ** getInitObjValuesSparse()
Get the initial values associated with the objectives in sparse form.
bool getInitialBasisElements(int type, int status, int *elem)
Get the initial basis elements for a particular variable type and basis status.
std::string * getFilesToDelete()
Get the array of files to delete.
bool setNumberOfConstraints(int numberOfConstraints)
std::string getServiceName()
Get the service name.
int getNumberOfOtherObjectiveOptions()
Get the number of other objective options.
std::string * getJobDependencies()
Get the array of job dependencies.
bool setOtherConstraintOptions(int numberOfOptions, OtherConstraintOption **other)
bool setJobDependencies(int numberOfDependencies, std::string *jobDependencies)
the ObjectiveOption class.
Definition: OSOption.h:2682
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
int numberOfOtherObjectiveOptions
number of <other> child elements
Definition: OSOption.h:2686
OtherObjectiveOption ** other
other information about the objectives
Definition: OSOption.h:2698
InitObjectiveValues * initialObjectiveValues
initial values for the objectives
Definition: OSOption.h:2689
BasisStatus * initialBasisStatus
initial basis status for the objectives
Definition: OSOption.h:2695
bool addOther(OtherObjectiveOption *other)
A function to add an <other> element.
bool setOther(int numberOfOptions, OtherObjectiveOption **other)
A function to set an array of <other> elements.
ObjectiveOption()
Default constructor.
bool IsEqual(ObjectiveOption *that)
A function to check for the equality of two objects.
InitObjectiveBounds * initialObjectiveBounds
initial bounds for the objectives
Definition: OSOption.h:2692
bool deepCopyFrom(ObjectiveOption *that)
A function to make a deep copy of an instance of this class.
~ObjectiveOption()
Class destructor.
the OptimizationOption class.
Definition: OSOption.h:3496
OptimizationOption()
Default constructor.
VariableOption * variables
the options for the variables
Definition: OSOption.h:3509
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
int numberOfConstraints
the number of constraints
Definition: OSOption.h:3506
ObjectiveOption * objectives
the options for the objectives
Definition: OSOption.h:3512
SolverOptions * solverOptions
other solver options
Definition: OSOption.h:3518
~OptimizationOption()
Class destructor.
bool IsEqual(OptimizationOption *that)
A function to check for the equality of two objects.
ConstraintOption * constraints
the options for the constraints
Definition: OSOption.h:3515
int numberOfObjectives
the number of objectives
Definition: OSOption.h:3503
int numberOfVariables
the number of variables
Definition: OSOption.h:3500
bool deepCopyFrom(OptimizationOption *that)
A function to make a deep copy of an instance of this class.
the OtherConOption class.
Definition: OSOption.h:3092
std::string lbValue
lower bound of the option
Definition: OSOption.h:3105
~OtherConOption()
Class destructor.
std::string ubValue
upper bound of the option
Definition: OSOption.h:3108
bool deepCopyFrom(OtherConOption *that)
A function to make a deep copy of an instance of this class.
std::string name
optional variable name
Definition: OSOption.h:3099
bool IsEqual(OtherConOption *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
int idx
variable index
Definition: OSOption.h:3096
std::string value
value of the option
Definition: OSOption.h:3102
OtherConOption()
Default constructor.
the OtherConstraintOption class.
Definition: OSOption.h:3157
std::string conType
type of the values in the con array
Definition: OSOption.h:3188
std::string category
name of the category into which this option falls
Definition: OSOption.h:3176
std::string name
name of the option
Definition: OSOption.h:3167
int numberOfCon
number of <con> children
Definition: OSOption.h:3161
OtherConstraintOption()
Default constructor.
OtherConOption ** con
array of option values
Definition: OSOption.h:3185
std::string type
type of the option value (integer, double, boolean, string)
Definition: OSOption.h:3179
OtherOptionOrResultEnumeration ** enumeration
Definition: OSOption.h:3194
std::string description
description of the option
Definition: OSOption.h:3182
std::string solver
name of the solver to which this option applies
Definition: OSOption.h:3173
std::string enumType
type of the values in the enumeration array
Definition: OSOption.h:3197
~OtherConstraintOption()
Class destructor.
bool setCon(int numberOfCon, OtherConOption **con)
A function to set an array of <con> elements.
bool IsEqual(OtherConstraintOption *that)
A function to check for the equality of two objects.
int numberOfEnumerations
number of <enumeration> child elements
Definition: OSOption.h:3164
bool deepCopyFrom(OtherConstraintOption *that)
A function to make a deep copy of an instance of this class.
bool addCon(int idx, std::string value, std::string lbValue, std::string ubValue)
A function to add a <con> element.
std::string value
value of the option
Definition: OSOption.h:3170
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
the OtherObjOption class.
Definition: OSOption.h:2510
std::string ubValue
lower bound on the value
Definition: OSOption.h:2527
std::string lbValue
lower bound on the value
Definition: OSOption.h:2524
OtherObjOption()
Default constructor.
std::string name
optional variable name
Definition: OSOption.h:2517
~OtherObjOption()
Class destructor.
bool deepCopyFrom(OtherObjOption *that)
A function to make a deep copy of an instance of this class.
int idx
variable index
Definition: OSOption.h:2514
std::string value
value of the option
Definition: OSOption.h:2520
bool IsEqual(OtherObjOption *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
the OtherObjectiveOption class.
Definition: OSOption.h:2575
OtherObjOption ** obj
array of option values
Definition: OSOption.h:2603
int numberOfObj
number of <obj> children
Definition: OSOption.h:2579
bool addObj(int idx, std::string value, std::string lbValue, std::string ubValue)
A function to add a <obj> element.
std::string name
name of the option
Definition: OSOption.h:2585
bool IsEqual(OtherObjectiveOption *that)
A function to check for the equality of two objects.
bool deepCopyFrom(OtherObjectiveOption *that)
A function to make a deep copy of an instance of this class.
std::string value
value of the option
Definition: OSOption.h:2588
std::string solver
name of the solver to which this option applies
Definition: OSOption.h:2591
int numberOfEnumerations
number of <enumeration> child elements
Definition: OSOption.h:2582
bool setObj(int numberOfObj, OtherObjOption **obj)
A function to set an array of <obj> elements.
std::string objType
type of the values in the obj array
Definition: OSOption.h:2606
std::string category
name of the category into which this option falls
Definition: OSOption.h:2594
~OtherObjectiveOption()
Class destructor.
std::string type
type of the option value (integer, double, boolean, string)
Definition: OSOption.h:2597
std::string description
description of the option
Definition: OSOption.h:2600
std::string enumType
type of the values in the enumeration array
Definition: OSOption.h:2615
OtherObjectiveOption()
Default constructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
OtherOptionOrResultEnumeration ** enumeration
Definition: OSOption.h:2612
brief an integer vector data structure used in OSOption and OSResult
Definition: OSGeneral.h:550
the OtherOption class.
Definition: OSOption.h:153
std::string value
the value of the option
Definition: OSOption.h:160
bool IsEqual(OtherOption *that)
A function to check for the equality of two objects.
~OtherOption()
Class destructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
OtherOption()
Default constructor.
bool deepCopyFrom(OtherOption *that)
A function to make a deep copy of an instance of this class.
std::string description
the description of the option
Definition: OSOption.h:163
std::string name
the name of the option
Definition: OSOption.h:157
the OtherOptions class.
Definition: OSOption.h:212
bool addOther(std::string name, std::string value, std::string description)
A function to add an <other> element.
~OtherOptions()
Class destructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
OtherOption ** other
the list of other options
Definition: OSOption.h:219
int numberOfOtherOptions
the number of other options
Definition: OSOption.h:216
bool IsEqual(OtherOptions *that)
A function to check for the equality of two objects.
bool deepCopyFrom(OtherOptions *that)
A function to make a deep copy of an instance of this class.
bool setOther(int numberOfOptions, OtherOption **other)
A function to set an array of <other> elements.
OtherOptions()
Default constructor.
the OtherVarOption class.
Definition: OSOption.h:1928
std::string value
value of the option
Definition: OSOption.h:1938
std::string ubValue
lower bound on the value
Definition: OSOption.h:1944
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
std::string name
optional variable name
Definition: OSOption.h:1935
~OtherVarOption()
Class destructor.
int idx
variable index
Definition: OSOption.h:1932
OtherVarOption()
Default constructor.
bool deepCopyFrom(OtherVarOption *that)
A function to make a deep copy of an instance of this class.
std::string lbValue
lower bound on the value
Definition: OSOption.h:1941
bool IsEqual(OtherVarOption *that)
A function to check for the equality of two objects.
the OtherVariableOption class.
Definition: OSOption.h:1990
int numberOfVar
number of child elements
Definition: OSOption.h:1994
int numberOfEnumerations
number of <enumeration> child elements
Definition: OSOption.h:1997
std::string type
type of the option value (integer, double, boolean, string)
Definition: OSOption.h:2012
std::string name
name of the option
Definition: OSOption.h:2000
std::string solver
name of the solver to which this option applies
Definition: OSOption.h:2006
OtherVariableOption()
Default constructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
std::string enumType
type of the values in the enumeration array
Definition: OSOption.h:2030
~OtherVariableOption()
Class destructor.
bool IsEqual(OtherVariableOption *that)
A function to check for the equality of two objects.
bool deepCopyFrom(OtherVariableOption *that)
A function to make a deep copy of an instance of this class.
OtherOptionOrResultEnumeration ** enumeration
Definition: OSOption.h:2027
bool setVar(int numberOfVar, OtherVarOption **var)
A function to set an array of elements.
std::string category
name of the category into which this option falls
Definition: OSOption.h:2009
OtherVarOption ** var
array of option values
Definition: OSOption.h:2018
bool addVar(int idx, std::string value, std::string lbValue, std::string ubValue)
A function to add a element.
std::string description
description of the option
Definition: OSOption.h:2015
std::string varType
type of the values in the var array
Definition: OSOption.h:2021
std::string value
value of the option
Definition: OSOption.h:2003
the PathPair class.
Definition: OSOption.h:852
bool IsEqual(PathPair *that)
A function to check for the equality of two objects.
std::string from
the file or directory to move/copy from
Definition: OSOption.h:856
PathPair()
Default constructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
~PathPair()
Class destructor.
bool deepCopyFrom(PathPair *that)
A function to make a deep copy of an instance of this class.
bool makeCopy
record whether a copy is to be made
Definition: OSOption.h:862
std::string to
the file or directory to move/copy to
Definition: OSOption.h:859
the PathPairs class.
Definition: OSOption.h:911
PathPair ** pathPair
the list of directory and file paths
Definition: OSOption.h:918
bool setPathPair(int numberOfPathPairs, PathPair **pathPair)
A function to set an array of <pathPair> elements.
PathPairs()
Default constructor.
bool addPathPair(std::string fromPath, std::string toPath, bool makeCopy)
A function to add a <pathPair> element.
bool deepCopyFrom(PathPairs *that)
A function to make a deep copy of an instance of this class.
~PathPairs()
Class destructor.
int numberOfPathPairs
the number of <path> children
Definition: OSOption.h:915
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool setPathPair(std::string *from, std::string *to, bool *makeCopy, int numberOfPathPairs)
Alternate signature for this function.
bool IsEqual(PathPairs *that)
A function to check for the equality of two objects.
the Processes class.
Definition: OSOption.h:994
std::string * process
the list of processes
Definition: OSOption.h:1001
bool setProcess(int numberOfProcesses, std::string *process)
A function to set an array of <process> elements.
Processes()
Default constructor.
bool IsEqual(Processes *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool deepCopyFrom(Processes *that)
A function to make a deep copy of an instance of this class.
int numberOfProcesses
the number of <process> children
Definition: OSOption.h:998
~Processes()
Class destructor.
bool addProcess(std::string process)
A function to add a <process> element.
the SOSVariableBranchingWeights class.
Definition: OSOption.h:1854
bool deepCopyFrom(SOSVariableBranchingWeights *that)
A function to make a deep copy of an instance of this class.
bool addSOS(int sosIdx, int nvar, double weight, int *idx, double *value, std::string *name)
A function to add an <sos> element.
SOSWeights ** sos
branching weights for the SOS
Definition: OSOption.h:1861
bool IsEqual(SOSVariableBranchingWeights *that)
A function to check for the equality of two objects.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool setSOS(int numberOfSOS, SOSWeights **sos)
A function to set an array of <sos> elements.
int numberOfSOS
number of <sos> children
Definition: OSOption.h:1858
SOSVariableBranchingWeights()
Default constructor.
~SOSVariableBranchingWeights()
Class destructor.
the SOSWeights class.
Definition: OSOption.h:1776
bool deepCopyFrom(SOSWeights *that)
A function to make a deep copy of an instance of this class.
SOSWeights()
Default constructor.
bool addVar(int idx, double value)
A function to add a element.
bool setVar(int numberOfVar, BranchingWeight **var)
A function to set an array of elements.
BranchingWeight ** var
branching weights for individual variables
Definition: OSOption.h:1789
int sosIdx
index of the SOS (to match the OSiL file)
Definition: OSOption.h:1780
~SOSWeights()
Class destructor.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
int numberOfVar
number of children
Definition: OSOption.h:1786
double groupWeight
branching weight for the entire SOS
Definition: OSOption.h:1783
bool IsEqual(SOSWeights *that)
A function to check for the equality of two objects.
the ServiceOption class.
Definition: OSOption.h:611
ServiceOption()
Default constructor.
std::string type
the service type
Definition: OSOption.h:615
bool deepCopyFrom(ServiceOption *that)
A function to make a deep copy of an instance of this class.
bool IsEqual(ServiceOption *that)
A function to check for the equality of two objects.
OtherOptions * otherOptions
the list of other service options
Definition: OSOption.h:618
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
~ServiceOption()
Class destructor.
the SolverOption class.
Definition: OSOption.h:3345
std::string * item
the list of items of the option
Definition: OSOption.h:3370
std::string value
the value of the option
Definition: OSOption.h:3352
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool deepCopyFrom(SolverOption *that)
A function to make a deep copy of an instance of this class.
~SolverOption()
Class destructor.
std::string solver
the solver to which the option applies
Definition: OSOption.h:3355
std::string description
the description of the option
Definition: OSOption.h:3364
std::string type
the type of the option value (integer, double, boolean, string)
Definition: OSOption.h:3361
SolverOption()
Default constructor.
std::string category
the category to which the option belongs
Definition: OSOption.h:3358
int numberOfItems
the number of items (additional pieces of data) of the option
Definition: OSOption.h:3367
std::string name
the name of the option
Definition: OSOption.h:3349
bool IsEqual(SolverOption *that)
A function to check for the equality of two objects.
the SolverOptions class.
Definition: OSOption.h:3419
bool IsEqual(SolverOptions *that)
A function to check for the equality of two objects.
bool addSolverOption(std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description)
A function to add a solver option.
bool setSolverOptions(int numberOfOptions, SolverOption **solverOption)
A function to set an array of solver options.
SolverOptions()
Default constructor.
bool deepCopyFrom(SolverOptions *that)
A function to make a deep copy of an instance of this class.
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
~SolverOptions()
Class destructor.
SolverOption ** solverOption
the list of solver options
Definition: OSOption.h:3426
int numberOfSolverOptions
the number of solver options
Definition: OSOption.h:3423
the StorageCapacity class.
Definition: OSGeneral.h:755
the SystemOption class.
Definition: OSOption.h:546
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool deepCopyFrom(SystemOption *that)
A function to make a deep copy of an instance of this class.
StorageCapacity * minDiskSpace
the minimum disk space required
Definition: OSOption.h:550
StorageCapacity * minMemorySize
the minimum memory required
Definition: OSOption.h:553
CPUSpeed * minCPUSpeed
the minimum CPU speed required
Definition: OSOption.h:556
CPUNumber * minCPUNumber
the minimum number of processors required
Definition: OSOption.h:559
SystemOption()
Default constructor.
OtherOptions * otherOptions
the list of other system options
Definition: OSOption.h:562
~SystemOption()
Class destructor.
bool IsEqual(SystemOption *that)
A function to check for the equality of two objects.
the TimeSpan class.
Definition: OSGeneral.h:925
the VariableOption class.
Definition: OSOption.h:2097
BasisStatus * initialBasisStatus
initial basis information
Definition: OSOption.h:2110
int numberOfOtherVariableOptions
number of <other> child elements
Definition: OSOption.h:2101
VariableOption()
Default constructor.
~VariableOption()
Class destructor.
bool setOther(int numberOfOptions, OtherVariableOption **other)
A function to set an array of <other> elements.
InitVariableValuesString * initialVariableValuesString
initial values for string-valued variables
Definition: OSOption.h:2107
bool setRandom(double density, bool conformant)
A function to make a random instance of this class.
bool addOther(OtherVariableOption *other)
A function to add an <other> element.
bool deepCopyFrom(VariableOption *that)
A function to make a deep copy of an instance of this class.
bool IsEqual(VariableOption *that)
A function to check for the equality of two objects.
OtherVariableOption ** other
other variable options
Definition: OSOption.h:2119
SOSVariableBranchingWeights * sosVariableBranchingWeights
branching weights for SOS variables and groups
Definition: OSOption.h:2116
InitVariableValues * initialVariableValues
initial values for the variables
Definition: OSOption.h:2104
IntegerVariableBranchingWeights * integerVariableBranchingWeights
branching weights for integer variables
Definition: OSOption.h:2113