OS
2.9.3
|
The Option Class. More...
#include <OSOption.h>
Public Member Functions | |
OSOption () | |
Default constructor. More... | |
~OSOption () | |
Class destructor. More... | |
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. More... | |
bool | IsEqual (OSOption *that) |
A function to check for the equality of two objects. More... | |
bool | setRandom (double density, bool conformant) |
A function to make a random instance of this class. More... | |
bool | deepCopyFrom (OSOption *that) |
A function to make a deep copy of an OSOption object. More... | |
std::string | getFileName () |
Get the name of the file. More... | |
std::string | getFileSource () |
Get the source of the file or problem. More... | |
std::string | getFileDescription () |
Get a description for the file or problem. More... | |
std::string | getFileCreator () |
Get the name of the person who created the file. More... | |
std::string | getFileLicence () |
Get licence information associated with the file. More... | |
std::string | getServiceURI () |
Get the service URI. More... | |
std::string | getServiceName () |
Get the service name. More... | |
std::string | getInstanceName () |
Get the instance name. More... | |
std::string | getInstanceLocation () |
Get the instance location. More... | |
std::string | getInstanceLocationType () |
Get the location type. More... | |
std::string | getJobID () |
Get the job ID. More... | |
std::string | getSolverToInvoke () |
Get the solver name. More... | |
std::string | getLicense () |
Get the license string. More... | |
std::string | getUserName () |
Get the user name. More... | |
std::string | getPassword () |
Get the password. More... | |
std::string | getContact () |
Get the contact information. More... | |
std::string | getContactTransportType () |
Get the transport type. More... | |
std::string | getMinDiskSpaceUnit () |
Get the disk space unit. More... | |
std::string | getMinDiskSpaceDescription () |
get the disk space description More... | |
std::string | getMinMemoryUnit () |
Get the memory unit. More... | |
std::string | getMinMemoryDescription () |
get the memory description More... | |
std::string | getMinCPUSpeedUnit () |
Get the CPU speed unit. More... | |
std::string | getMinCPUSpeedDescription () |
Get the CPU speed description. More... | |
std::string | getMinCPUNumberDescription () |
Get the CPU description. More... | |
std::string | getServiceType () |
Get the service type. More... | |
std::string | getMaxTimeUnit () |
Get the time unit. More... | |
std::string | getRequestedStartTime () |
Get the requested starting time. More... | |
std::string | getOptionStr (std::string optionName) |
Get any of the string-valued options. More... | |
double | getMinDiskSpace () |
Get the minimum required disk space. More... | |
double | getMinMemorySize () |
Get the minimum required memory. More... | |
double | getMinCPUSpeed () |
Get the minimum required CPU speed. More... | |
double | getMaxTime () |
Get the maximum allowed time. More... | |
double | getOptionDbl (std::string optionName) |
Get any of the double-valued options. More... | |
int | getMinCPUNumber () |
Get the minimum required number of CPUs. More... | |
int | getNumberOfOtherGeneralOptions () |
Get the number of <other> options in the <general> element. More... | |
int | getNumberOfOtherSystemOptions () |
Get the number of <other> options in the <system> element. More... | |
int | getNumberOfOtherServiceOptions () |
Get the number of <other> options in the <service> element. More... | |
int | getNumberOfOtherJobOptions () |
Get the number of <other> options in the <job> element. More... | |
int | getNumberOfJobDependencies () |
Get the number of job dependencies. More... | |
int | getNumberOfRequiredDirectories () |
Get the number of required directories. More... | |
int | getNumberOfRequiredFiles () |
Get the number of required files. More... | |
int | getNumberOfDirectoriesToMake () |
Get the number of directories to make. More... | |
int | getNumberOfFilesToMake () |
Get the number of files to make. More... | |
int | getNumberOfInputDirectoriesToMove () |
Get the number of input directories to move. More... | |
int | getNumberOfInputFilesToMove () |
Get the number of input files to move. More... | |
int | getNumberOfOutputDirectoriesToMove () |
Get the number of output directories to move. More... | |
int | getNumberOfOutputFilesToMove () |
Get the number of output files to move. More... | |
int | getNumberOfFilesToDelete () |
Get the number of files to delete. More... | |
int | getNumberOfDirectoriesToDelete () |
Get the number of directories to delete. More... | |
int | getNumberOfProcessesToKill () |
Get the number of processes to kill. More... | |
int | getNumberOfVariables () |
Get the number of variables in the instance. More... | |
int | getNumberOfObjectives () |
Get the number of objectives in the instance. More... | |
int | getNumberOfConstraints () |
Get the number of constraints in the instance. More... | |
int | getNumberOfInitVarValues () |
Get the number of initial variable values. More... | |
int | getNumberOfInitVarValuesString () |
Get the number of initial variable strings. More... | |
int | getNumberOfIntegerVariableBranchingWeights () |
Get the number of variables for which integer branching weights are provided. More... | |
int | getNumberOfSOS () |
Get the number of special ordered sets for which branching weights are provided. More... | |
int | getNumberOfSOSVarBranchingWeights (int iSOS) |
Get the number of variables for which branching weights are provided in a particular SOS. More... | |
int | getNumberOfOtherVariableOptions () |
Get the number of other variable options. More... | |
int | getNumberOfInitObjValues () |
Get the number of initial objective values. More... | |
int | getNumberOfInitObjBounds () |
Get the number of initial objective bounds. More... | |
int | getNumberOfOtherObjectiveOptions () |
Get the number of other objective options. More... | |
int | getNumberOfInitConValues () |
Get the number of initial constraint values. More... | |
int | getNumberOfInitDualVarValues () |
Get the number of initial dual variable values. More... | |
int | getNumberOfOtherConstraintOptions () |
Get the number of other constraint options. More... | |
int | getNumberOfSolverOptions () |
Get the number of solver options. More... | |
int | getOptionInt (std::string optionName) |
Get any of the integer-valued options. More... | |
OtherOption ** | getOtherGeneralOptions () |
Get the array of other options associated with the <general> element. More... | |
OtherOption ** | getOtherSystemOptions () |
Get the array of other options associated with the <system> element. More... | |
OtherOption ** | getOtherServiceOptions () |
Get the array of other options associated with the <service> element. More... | |
OtherOption ** | getOtherJobOptions () |
Get the array of other options associated with the <job> element. More... | |
OtherOption ** | getOtherOptions (std::string elementName) |
Get the array of other options associated with any element. More... | |
OtherOption ** | getAllOtherOptions () |
Get the array of all other options associated with the <general>, <system>, <service> and <job> elements. More... | |
std::string * | getJobDependencies () |
Get the array of job dependencies. More... | |
std::string * | getRequiredDirectories () |
Get the array of required directories. More... | |
std::string * | getRequiredFiles () |
Get the array of required files. More... | |
std::string * | getDirectoriesToMake () |
Get the array of directories to make. More... | |
std::string * | getFilesToMake () |
Get the array of files to make. More... | |
PathPair ** | getInputDirectoriesToMove () |
Get the array of input directories to move. More... | |
PathPair ** | getInputFilesToMove () |
Get the array of input files to move. More... | |
PathPair ** | getOutputDirectoriesToMove () |
Get the array of output directories to move. More... | |
PathPair ** | getOutputFilesToMove () |
Get the array of output files to move. More... | |
std::string * | getDirectoriesToDelete () |
Get the array of directories to delete. More... | |
std::string * | getFilesToDelete () |
Get the array of files to delete. More... | |
std::string * | getProcessesToKill () |
Get the array of processes to kill. More... | |
InitVarValue ** | getInitVarValuesSparse () |
Get the initial values associated with the variables in sparse form. More... | |
double * | getInitVarValuesDense () |
Get the initial values associated with the variables in dense form. More... | |
double * | getInitVarValuesDense (int numberOfVariables) |
Get the initial values associated with the variables in dense form. More... | |
InitVarValueString ** | getInitVarValuesStringSparse () |
Get the initial value strings associated with the variables in sparse form. More... | |
std::string * | getInitVarValuesStringDense () |
Get the initial value strings associated with the variables in dense form. More... | |
std::string * | getInitVarValuesStringDense (int numberOfVariables) |
Get the initial value strings associated with the variables in dense form. More... | |
InitBasStatus ** | getInitBasisStatusSparse () |
Get the initial basis status in sparse form. More... | |
std::string * | getInitBasisStatusDense () |
Get the initial basis information in dense form. More... | |
int * | getVariableInitialBasisStatusDense (int numberOfVariables) |
Get the initial basis status for all variables in dense form. More... | |
int | getNumberOfInitialBasisElements (int type, int status) |
Get the number of initial basis elements for a particular variable type and basis status. More... | |
bool | getInitialBasisElements (int type, int status, int *elem) |
Get the initial basis elements for a particular variable type and basis status. More... | |
BranchingWeight ** | getIntegerVariableBranchingWeightsSparse () |
Get the integer branching weights in sparse form. More... | |
double * | getIntegerVariableBranchingWeightsDense () |
Get the integer branching weights in dense form. More... | |
double * | getIntegerVariableBranchingWeightsDense (int numberOfVariables) |
Get the integer branching weights in dense form. More... | |
SOSWeights ** | getSOSVariableBranchingWeightsSparse () |
Get the SOS branching weights in sparse form. More... | |
std::vector< OtherVariableOption * > | getOtherVariableOptions (std::string solver_name) |
Get the <other> variable options associated with a particular solver. More... | |
OtherVariableOption * | getOtherVariableOption (int optionNumber) |
Get one particular <other> variable option from the array of options. More... | |
OtherVariableOption ** | getAllOtherVariableOptions () |
Get all <other> variable options. More... | |
InitObjValue ** | getInitObjValuesSparse () |
Get the initial values associated with the objectives in sparse form. More... | |
double * | getInitObjValuesDense () |
Get the initial values associated with the objectives in dense form. More... | |
double * | getInitObjValuesDense (int numberOfObjectives) |
Get the initial values associated with the objectives in dense form. More... | |
InitObjBound ** | getInitObjBoundsSparse () |
Get the initial bounds associated with the objectives in sparse form. More... | |
double * | getInitObjLowerBoundsDense () |
Get the initial lower bounds associated with the objectives in dense form. More... | |
double * | getInitObjLowerBoundsDense (int numberOfObjectives) |
Get the initial lower bounds associated with the objectives in dense form. More... | |
double * | getInitObjUpperBoundsDense () |
Get the initial upper bounds associated with the objectives in dense form. More... | |
double * | getInitObjUpperBoundsDense (int numberOfObjectives) |
Get the initial upper bounds associated with the objectives in dense form. More... | |
int * | getObjectiveInitialBasisStatusDense (int numberOfObjectives) |
Get the initial basis status for all objectives in dense form. More... | |
std::vector< OtherObjectiveOption * > | getOtherObjectiveOptions (std::string solver_name) |
Get the array of other objective options. More... | |
OtherObjectiveOption * | getOtherObjectiveOption (int optionNumber) |
Get one particular <other> objective option from the array of options. More... | |
OtherObjectiveOption ** | getAllOtherObjectiveOptions () |
Get all <other> objective options. More... | |
InitConValue ** | getInitConValuesSparse () |
Get the initial values associated with the constraints in sparse form. More... | |
double * | getInitConValuesDense () |
Get the initial values associated with the constraints in dense form. More... | |
double * | getInitConValuesDense (int numberOfConstraints) |
Get the initial values associated with the constraints in dense form. More... | |
InitDualVarValue ** | getInitDualVarValuesSparse () |
Get the initial bounds associated with the dual variables in sparse form. More... | |
double * | getInitDualVarLowerBoundsDense () |
Get the initial dual variables associated with the lower bounds in dense form. More... | |
double * | getInitDualVarLowerBoundsDense (int numberOfConstraints) |
Get the initial dual variables associated with the lower bounds in dense form. More... | |
double * | getInitDualVarUpperBoundsDense () |
Get the initial dual variables associated with the upper bounds in dense form. More... | |
double * | getInitDualVarUpperBoundsDense (int numberOfConstraints) |
Get the initial dual variables associated with the upper bounds in dense form. More... | |
int * | getSlackVariableInitialBasisStatusDense (int numberOfConstraints) |
Get the initial basis status for all slack variables in dense form. More... | |
std::vector< OtherConstraintOption * > | getOtherConstraintOptions (std::string solver_name) |
Get the array of other constraint options. More... | |
OtherConstraintOption * | getOtherConstraintOption (int optionNumber) |
Get one particular <other> constraint option from the array of options. More... | |
OtherConstraintOption ** | getAllOtherConstraintOptions () |
Get all <other> constraint options. More... | |
std::vector< SolverOption * > | getSolverOptions (std::string solver_name) |
Get the options associated with a given solver. More... | |
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) More... | |
SolverOption ** | getAllSolverOptions () |
Get all solver options. More... | |
bool | setServiceURI (std::string serviceURI) |
Set the serviceURI. More... | |
bool | setServiceName (std::string serviceName) |
Set the service name. More... | |
bool | setInstanceName (std::string instanceName) |
Set the instance name. More... | |
bool | setInstanceLocation (std::string instanceLocation) |
Set the instance location. More... | |
bool | setInstanceLocation (std::string instanceLocation, std::string locationType) |
Alternative signature to set the instance location and location type simultaneously. More... | |
bool | setInstanceLocationType (std::string locationType) |
Set the instance location type. More... | |
bool | setJobID (std::string jobID) |
Set the job ID. More... | |
bool | setSolverToInvoke (std::string solverToInvoke) |
Set the solver to be invoked. More... | |
bool | setLicense (std::string license) |
Set the license information. More... | |
bool | setUserName (std::string userName) |
Set the username. More... | |
bool | setPassword (std::string password) |
Set the password. More... | |
bool | setContact (std::string contact) |
Set the contact information. More... | |
bool | setContact (std::string contact, std::string transportType) |
Alternative signature to set the contact information and transport type simultaneously. More... | |
bool | setContactTransportType (std::string transportType) |
Set the transport type for contact. More... | |
bool | setOtherGeneralOptions (int numberOfOptions, OtherOption **other) |
Set the other general options as an entire array. More... | |
bool | setAnOtherGeneralOption (std::string name, std::string value, std::string description) |
Add another general option to the <other> option array. More... | |
bool | setMinDiskSpace (std::string unit, std::string description, double value) |
Set the minimum disk space required for the current job. More... | |
bool | setMinDiskSpace (double value) |
Alternate signature to set only the number of units. More... | |
bool | setMinDiskSpaceUnit (std::string unit) |
bool | setMinMemorySize (std::string unit, std::string description, double value) |
Set the minimum memory size required for the current job. More... | |
bool | setMinMemorySize (double value) |
Alternate signature to set only the number of units. More... | |
bool | setMinMemoryUnit (std::string unit) |
bool | setMinCPUSpeed (std::string unit, std::string description, double value) |
Set the minimum CPU speed required for the current job. More... | |
bool | setMinCPUSpeed (double value) |
Alternate signature to set only the number of units. More... | |
bool | setMinCPUSpeedUnit (std::string unit) |
bool | setMinCPUNumber (int number, std::string description) |
Set the minimum number of CPU cores required for the current job. More... | |
bool | setMinCPUNumber (int number) |
Alternate signature to set only the number of cores. More... | |
bool | setOtherSystemOptions (int numberOfOptions, OtherOption **other) |
bool | setAnOtherSystemOption (std::string name, std::string value, std::string description) |
bool | setServiceType (std::string serviceType) |
bool | setOtherServiceOptions (int numberOfOptions, OtherOption **other) |
bool | setAnOtherServiceOption (std::string name, std::string value, std::string description) |
bool | setMaxTime (double value, std::string unit) |
bool | setMaxTime (double value) |
bool | setMaxTimeUnit (std::string unit) |
bool | setRequestedStartTime (std::string time) |
bool | setJobDependencies (int numberOfDependencies, std::string *jobDependencies) |
bool | setAnotherJobDependency (std::string jobID) |
bool | setRequiredDirectories (int numberOfPaths, std::string *paths) |
bool | setAnotherRequiredDirectory (std::string path) |
bool | setRequiredFiles (int numberOfPaths, std::string *paths) |
bool | setAnotherRequiredFile (std::string path) |
bool | setDirectoriesToMake (int numberOfPaths, std::string *paths) |
bool | setAnotherDirectoryToMake (std::string path) |
bool | setFilesToMake (int numberOfPaths, std::string *paths) |
bool | setAnotherFileToMake (std::string path) |
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 More... | |
bool | setInputDirectoriesToMove (int numberOfPathPairs, PathPair **pathPair) |
bool | setAnotherInputDirectoryToMove (std::string fromPath, std::string toPath, bool makeCopy) |
bool | setInputFilesToMove (int numberOfPathPairs, PathPair **pathPair) |
bool | setAnotherInputFileToMove (std::string fromPath, std::string toPath, bool makeCopy) |
bool | setOutputFilesToMove (int numberOfPathPairs, PathPair **pathPair) |
bool | setAnotherOutputFileToMove (std::string fromPath, std::string toPath, bool makeCopy) |
bool | setOutputDirectoriesToMove (int numberOfPathPairs, PathPair **pathPair) |
bool | setAnotherOutputDirectoryToMove (std::string fromPath, std::string toPath, bool makeCopy) |
bool | setFilesToDelete (int numberOfPaths, std::string *paths) |
bool | setAnotherFileToDelete (std::string path) |
bool | setDirectoriesToDelete (int numberOfPaths, std::string *paths) |
bool | setAnotherDirectoryToDelete (std::string path) |
bool | setProcessesToKill (int numberOfProcesses, std::string *processes) |
bool | setAnotherProcessToKill (std::string process) |
bool | setOtherJobOptions (int numberOfOptions, OtherOption **other) |
bool | setAnOtherJobOption (std::string name, std::string value, std::string description) |
bool | setNumberOfVariables (int numberOfVariables) |
bool | setNumberOfObjectives (int numberOfObjectives) |
bool | setNumberOfConstraints (int numberOfConstraints) |
bool | setInitVarValues (int numberOfVar, int *idx, double *value, std::string *name) |
bool | setInitVarValuesSparse (int numberOfVar, InitVarValue **var) |
bool | setInitVarValuesSparse (int numberOfVar, InitVarValue **var, ENUM_COMBINE_ARRAYS disp) |
bool | setInitVarValuesDense (int numberOfVar, double *value) |
bool | setAnotherInitVarValue (int idx, double value) |
bool | setInitVarValuesString (int numberOfVar, int *idx, std::string *value, std::string *name) |
bool | setInitVarValuesStringSparse (int numberOfVar, InitVarValueString **var) |
bool | setInitVarValuesStringSparse (int numberOfVar, InitVarValueString **var, ENUM_COMBINE_ARRAYS disp) |
bool | setInitVarValuesStringDense (int numberOfVar, std::string *value) |
bool | setAnotherInitVarValueString (int idx, std::string value) |
bool | setInitBasisStatus (int object, int status, int *i, int ni) |
bool | setInitBasisStatusSparse (int numberOfVar, InitBasStatus **var) |
bool | setInitBasisStatusSparse (int numberOfVar, InitBasStatus **var, ENUM_COMBINE_ARRAYS disp) |
bool | setInitBasisStatusDense (int numberOfVar, std::string *var) |
bool | setAnotherInitBasisStatus (int type, int idx, int status) |
Set the basis status for another variable, objective or constraint/slack. More... | |
bool | setIntegerVariableBranchingWeights (int numberOfVar, int *idx, double *value, std::string *name) |
bool | setIntegerVariableBranchingWeightsSparse (int numberOfVar, BranchingWeight **var) |
bool | setIntegerVariableBranchingWeightsSparse (int numberOfVar, BranchingWeight **var, ENUM_COMBINE_ARRAYS disp) |
bool | setIntegerVariableBranchingWeightsDense (int numberOfVar, double *value) |
bool | setAnotherIntegerVariableBranchingWeight (int idx, double value) |
bool | setSOSVariableBranchingWeights (int numberOfSOS, SOSWeights **sos) |
bool | setAnotherSOSVariableBranchingWeight (int sosIdx, int nvar, double weight, int *idx, double *value, std::string *name) |
bool | setNumberOfOtherVariableOptions (int numberOfOther) |
bool | setOtherVariableOptions (int numberOfVar, OtherVariableOption **var) |
bool | setAnOtherVariableOption (OtherVariableOption *varOption) |
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. More... | |
bool | setOtherOptionEnumeration (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 <constraints> element. More... | |
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. More... | |
bool | setInitObjValues (int numberOfObj, int *idx, double *value, std::string *name) |
bool | setInitObjValuesSparse (int numberOfObj, InitObjValue **obj) |
bool | setInitObjValuesSparse (int numberOfObj, InitObjValue **obj, ENUM_COMBINE_ARRAYS disp) |
bool | setInitObjValuesDense (int numberOfObj, double *value) |
bool | setAnotherInitObjValue (int idx, double value) |
bool | setInitObjBounds (int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name) |
bool | setInitObjBoundsSparse (int numberOfObj, InitObjBound **obj) |
bool | setInitObjBoundsSparse (int numberOfObj, InitObjBound **obj, ENUM_COMBINE_ARRAYS disp) |
bool | setInitObjBoundsDense (int numberOfObj, double *lb, double *ub) |
bool | setAnotherInitObjBound (int idx, double lbValue, double ubValue) |
bool | setNumberOfOtherObjectiveOptions (int numberOfOther) |
bool | setOtherObjectiveOptions (int numberOfObj, OtherObjectiveOption **obj) |
bool | setAnOtherObjectiveOption (OtherObjectiveOption *objOption) |
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. More... | |
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. More... | |
bool | setInitConValues (int numberOfCon, int *idx, double *value, std::string *name) |
bool | setInitConValuesSparse (int numberOfCon, InitConValue **con) |
bool | setInitConValuesSparse (int numberOfCon, InitConValue **con, ENUM_COMBINE_ARRAYS disp) |
bool | setInitConValuesDense (int numberOfCon, double *value) |
bool | setAnotherInitConValue (int idx, double value) |
bool | setInitDualValues (int numberOfCon, int *idx, double *lbValue, double *ubValue, std::string *name) |
bool | setInitDualVarValuesSparse (int numberOfCon, InitDualVarValue **con) |
bool | setInitDualVarValuesSparse (int numberOfCon, InitDualVarValue **con, ENUM_COMBINE_ARRAYS disp) |
bool | setInitDualVarValuesDense (int numberOfCon, double *lb, double *ub) |
bool | setAnotherInitDualVarValue (int idx, double lbValue, double ubValue) |
bool | setNumberOfOtherConstraintOptions (int numberOfOther) |
bool | setOtherConstraintOptions (int numberOfOptions, OtherConstraintOption **other) |
bool | setAnOtherConstraintOption (OtherConstraintOption *optionValue) |
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. More... | |
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. More... | |
bool | setNumberOfSolverOptions (int numberOfOptions) |
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. More... | |
bool | setSolverOptions (int numberOfSolverOptions, SolverOption **solverOption) |
bool | setAnotherSolverOption (std::string name, std::string value, std::string solver, std::string category, std::string type, std::string description) |
bool | setOptionInt (std::string optionName, int optionValue) |
bool | setOptionStr (std::string optionName, std::string optionValue) |
bool | setOptionDbl (std::string optionName, double value) |
Public Attributes | |
GeneralFileHeader * | optionHeader |
OSOption has a header and five other children: general, system, service, job, and optimization. More... | |
GeneralOption * | general |
generalOption holds the first child of the OSOption specified by the OSoL Schema. More... | |
SystemOption * | system |
systemOption holds the second child of the OSOption specified by the OSoL Schema. More... | |
ServiceOption * | service |
serviceOption holds the third child of the OSOption specified by the OSoL Schema. More... | |
JobOption * | job |
jobOption holds the fourth child of the OSOption specified by the OSoL Schema. More... | |
OptimizationOption * | optimization |
optimizationOption holds the fifth child of the OSOption specified by the OSoL Schema. More... | |
The Option Class.
Definition at line 3564 of file OSOption.h.
OSOption::OSOption | ( | ) |
Default constructor.
OSOption::~OSOption | ( | ) |
Class destructor.
bool OSOption::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.
name | the name of this file or instance |
source | the source (e.g., in BiBTeX format) |
fileCreator | the creator of this file |
description | further description about this file and/or its contents |
licence | licence information if applicable |
bool OSOption::IsEqual | ( | OSOption * | that | ) |
A function to check for the equality of two objects.
bool OSOption::setRandom | ( | double | density, |
bool | conformant | ||
) |
A function to make a random instance of this class.
density | corresponds to the probability that a particular child element is created |
conformant | if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children) |
bool OSOption::deepCopyFrom | ( | OSOption * | that | ) |
std::string OSOption::getFileName | ( | ) |
Get the name of the file.
std::string OSOption::getFileSource | ( | ) |
Get the source of the file or problem.
std::string OSOption::getFileDescription | ( | ) |
Get a description for the file or problem.
std::string OSOption::getFileCreator | ( | ) |
Get the name of the person who created the file.
std::string OSOption::getFileLicence | ( | ) |
Get licence information associated with the file.
std::string OSOption::getServiceURI | ( | ) |
Get the service URI.
std::string OSOption::getServiceName | ( | ) |
Get the service name.
std::string OSOption::getInstanceName | ( | ) |
Get the instance name.
std::string OSOption::getInstanceLocation | ( | ) |
Get the instance location.
std::string OSOption::getInstanceLocationType | ( | ) |
Get the location type.
std::string OSOption::getJobID | ( | ) |
Get the job ID.
std::string OSOption::getSolverToInvoke | ( | ) |
Get the solver name.
std::string OSOption::getLicense | ( | ) |
Get the license string.
std::string OSOption::getUserName | ( | ) |
Get the user name.
std::string OSOption::getPassword | ( | ) |
Get the password.
std::string OSOption::getContact | ( | ) |
Get the contact information.
std::string OSOption::getContactTransportType | ( | ) |
Get the transport type.
std::string OSOption::getMinDiskSpaceUnit | ( | ) |
Get the disk space unit.
std::string OSOption::getMinDiskSpaceDescription | ( | ) |
get the disk space description
std::string OSOption::getMinMemoryUnit | ( | ) |
Get the memory unit.
std::string OSOption::getMinMemoryDescription | ( | ) |
get the memory description
std::string OSOption::getMinCPUSpeedUnit | ( | ) |
Get the CPU speed unit.
std::string OSOption::getMinCPUSpeedDescription | ( | ) |
Get the CPU speed description.
std::string OSOption::getMinCPUNumberDescription | ( | ) |
Get the CPU description.
std::string OSOption::getServiceType | ( | ) |
Get the service type.
std::string OSOption::getMaxTimeUnit | ( | ) |
Get the time unit.
std::string OSOption::getRequestedStartTime | ( | ) |
Get the requested starting time.
std::string OSOption::getOptionStr | ( | std::string | optionName | ) |
Get any of the string-valued options.
double OSOption::getMinDiskSpace | ( | ) |
Get the minimum required disk space.
double OSOption::getMinMemorySize | ( | ) |
Get the minimum required memory.
double OSOption::getMinCPUSpeed | ( | ) |
Get the minimum required CPU speed.
double OSOption::getMaxTime | ( | ) |
Get the maximum allowed time.
double OSOption::getOptionDbl | ( | std::string | optionName | ) |
Get any of the double-valued options.
int OSOption::getMinCPUNumber | ( | ) |
Get the minimum required number of CPUs.
int OSOption::getNumberOfOtherGeneralOptions | ( | ) |
Get the number of <other> options in the <general> element.
int OSOption::getNumberOfOtherSystemOptions | ( | ) |
Get the number of <other> options in the <system> element.
int OSOption::getNumberOfOtherServiceOptions | ( | ) |
Get the number of <other> options in the <service> element.
int OSOption::getNumberOfOtherJobOptions | ( | ) |
Get the number of <other> options in the <job> element.
int OSOption::getNumberOfJobDependencies | ( | ) |
Get the number of job dependencies.
int OSOption::getNumberOfRequiredDirectories | ( | ) |
Get the number of required directories.
int OSOption::getNumberOfRequiredFiles | ( | ) |
Get the number of required files.
int OSOption::getNumberOfDirectoriesToMake | ( | ) |
Get the number of directories to make.
int OSOption::getNumberOfFilesToMake | ( | ) |
Get the number of files to make.
int OSOption::getNumberOfInputDirectoriesToMove | ( | ) |
Get the number of input directories to move.
int OSOption::getNumberOfInputFilesToMove | ( | ) |
Get the number of input files to move.
int OSOption::getNumberOfOutputDirectoriesToMove | ( | ) |
Get the number of output directories to move.
int OSOption::getNumberOfOutputFilesToMove | ( | ) |
Get the number of output files to move.
int OSOption::getNumberOfFilesToDelete | ( | ) |
Get the number of files to delete.
int OSOption::getNumberOfDirectoriesToDelete | ( | ) |
Get the number of directories to delete.
int OSOption::getNumberOfProcessesToKill | ( | ) |
Get the number of processes to kill.
int OSOption::getNumberOfVariables | ( | ) |
Get the number of variables in the instance.
int OSOption::getNumberOfObjectives | ( | ) |
Get the number of objectives in the instance.
int OSOption::getNumberOfConstraints | ( | ) |
Get the number of constraints in the instance.
int OSOption::getNumberOfInitVarValues | ( | ) |
Get the number of initial variable values.
int OSOption::getNumberOfInitVarValuesString | ( | ) |
Get the number of initial variable strings.
int OSOption::getNumberOfIntegerVariableBranchingWeights | ( | ) |
Get the number of variables for which integer branching weights are provided.
int OSOption::getNumberOfSOS | ( | ) |
Get the number of special ordered sets for which branching weights are provided.
int OSOption::getNumberOfSOSVarBranchingWeights | ( | int | iSOS | ) |
Get the number of variables for which branching weights are provided in a particular SOS.
iSOS | the number of the SOS |
int OSOption::getNumberOfOtherVariableOptions | ( | ) |
Get the number of other variable options.
int OSOption::getNumberOfInitObjValues | ( | ) |
Get the number of initial objective values.
int OSOption::getNumberOfInitObjBounds | ( | ) |
Get the number of initial objective bounds.
int OSOption::getNumberOfOtherObjectiveOptions | ( | ) |
Get the number of other objective options.
int OSOption::getNumberOfInitConValues | ( | ) |
Get the number of initial constraint values.
int OSOption::getNumberOfInitDualVarValues | ( | ) |
Get the number of initial dual variable values.
int OSOption::getNumberOfOtherConstraintOptions | ( | ) |
Get the number of other constraint options.
int OSOption::getNumberOfSolverOptions | ( | ) |
Get the number of solver options.
int OSOption::getOptionInt | ( | std::string | optionName | ) |
Get any of the integer-valued options.
OtherOption** OSOption::getOtherGeneralOptions | ( | ) |
Get the array of other options associated with the <general> element.
OtherOption** OSOption::getOtherSystemOptions | ( | ) |
Get the array of other options associated with the <system> element.
OtherOption** OSOption::getOtherServiceOptions | ( | ) |
Get the array of other options associated with the <service> element.
OtherOption** OSOption::getOtherJobOptions | ( | ) |
Get the array of other options associated with the <job> element.
OtherOption** OSOption::getOtherOptions | ( | std::string | elementName | ) |
Get the array of other options associated with any element.
OtherOption** OSOption::getAllOtherOptions | ( | ) |
Get the array of all other options associated with the <general>, <system>, <service> and <job> elements.
std::string* OSOption::getJobDependencies | ( | ) |
Get the array of job dependencies.
std::string* OSOption::getRequiredDirectories | ( | ) |
Get the array of required directories.
std::string* OSOption::getRequiredFiles | ( | ) |
Get the array of required files.
std::string* OSOption::getDirectoriesToMake | ( | ) |
Get the array of directories to make.
std::string* OSOption::getFilesToMake | ( | ) |
Get the array of files to make.
PathPair** OSOption::getInputDirectoriesToMove | ( | ) |
Get the array of input directories to move.
PathPair** OSOption::getInputFilesToMove | ( | ) |
Get the array of input files to move.
PathPair** OSOption::getOutputDirectoriesToMove | ( | ) |
Get the array of output directories to move.
PathPair** OSOption::getOutputFilesToMove | ( | ) |
Get the array of output files to move.
std::string* OSOption::getDirectoriesToDelete | ( | ) |
Get the array of directories to delete.
std::string* OSOption::getFilesToDelete | ( | ) |
Get the array of files to delete.
std::string* OSOption::getProcessesToKill | ( | ) |
Get the array of processes to kill.
InitVarValue** OSOption::getInitVarValuesSparse | ( | ) |
Get the initial values associated with the variables in sparse form.
double* OSOption::getInitVarValuesDense | ( | ) |
Get the initial values associated with the variables in dense form.
double* OSOption::getInitVarValuesDense | ( | int | numberOfVariables | ) |
Get the initial values associated with the variables in dense form.
numberOfVariables | holds the dimension of the vector |
InitVarValueString** OSOption::getInitVarValuesStringSparse | ( | ) |
Get the initial value strings associated with the variables in sparse form.
std::string* OSOption::getInitVarValuesStringDense | ( | ) |
Get the initial value strings associated with the variables in dense form.
std::string* OSOption::getInitVarValuesStringDense | ( | int | numberOfVariables | ) |
Get the initial value strings associated with the variables in dense form.
numberOfVariables | holds the dimension of the vector |
InitBasStatus** OSOption::getInitBasisStatusSparse | ( | ) |
Get the initial basis status in sparse form.
std::string* OSOption::getInitBasisStatusDense | ( | ) |
Get the initial basis information in dense form.
int* OSOption::getVariableInitialBasisStatusDense | ( | int | numberOfVariables | ) |
Get the initial basis status for all variables in dense form.
numberOfVariables | is the dimension of the array |
int OSOption::getNumberOfInitialBasisElements | ( | int | type, |
int | status | ||
) |
Get the number of initial basis elements for a particular variable type and basis status.
type | the type of variable or problem component (contained in ENUM_PROBLEM_COMPONENT — see OSGeneral.h) |
status | the basis status (contained in ENUM_BASIS_STATUS — see OSGeneral.h) |
bool OSOption::getInitialBasisElements | ( | int | type, |
int | status, | ||
int * | elem | ||
) |
Get the initial basis elements for a particular variable type and basis status.
type | the type of variable or problem component (contained in ENUM_PROBLEM_COMPONENT — see OSGeneral.h) |
status | the basis status (contained in ENUM_BASIS_STATUS — see OSGeneral.h) |
elem | pointer to the memory location where the user wants to store the returned values |
BranchingWeight** OSOption::getIntegerVariableBranchingWeightsSparse | ( | ) |
Get the integer branching weights in sparse form.
double* OSOption::getIntegerVariableBranchingWeightsDense | ( | ) |
Get the integer branching weights in dense form.
double* OSOption::getIntegerVariableBranchingWeightsDense | ( | int | numberOfVariables | ) |
Get the integer branching weights in dense form.
numberOfVariables | holds the dimension of the vector |
SOSWeights** OSOption::getSOSVariableBranchingWeightsSparse | ( | ) |
Get the SOS branching weights in sparse form.
std::vector<OtherVariableOption*> OSOption::getOtherVariableOptions | ( | std::string | solver_name | ) |
Get the <other> variable options associated with a particular solver.
solver_name | is the name of the solver whose options we want |
OtherVariableOption* OSOption::getOtherVariableOption | ( | int | optionNumber | ) |
Get one particular <other> variable option from the array of options.
optionNumber | is the index of the option in the array |
OtherVariableOption** OSOption::getAllOtherVariableOptions | ( | ) |
Get all <other> variable options.
InitObjValue** OSOption::getInitObjValuesSparse | ( | ) |
Get the initial values associated with the objectives in sparse form.
double* OSOption::getInitObjValuesDense | ( | ) |
Get the initial values associated with the objectives in dense form.
double* OSOption::getInitObjValuesDense | ( | int | numberOfObjectives | ) |
Get the initial values associated with the objectives in dense form.
numberOfObjectives | holds the dimension of the vector |
InitObjBound** OSOption::getInitObjBoundsSparse | ( | ) |
Get the initial bounds associated with the objectives in sparse form.
double* OSOption::getInitObjLowerBoundsDense | ( | ) |
Get the initial lower bounds associated with the objectives in dense form.
double* OSOption::getInitObjLowerBoundsDense | ( | int | numberOfObjectives | ) |
Get the initial lower bounds associated with the objectives in dense form.
numberOfObjectives | holds the dimension of the vector |
double* OSOption::getInitObjUpperBoundsDense | ( | ) |
Get the initial upper bounds associated with the objectives in dense form.
double* OSOption::getInitObjUpperBoundsDense | ( | int | numberOfObjectives | ) |
Get the initial upper bounds associated with the objectives in dense form.
numberOfObjectives | holds the dimension of the vector |
int* OSOption::getObjectiveInitialBasisStatusDense | ( | int | numberOfObjectives | ) |
Get the initial basis status for all objectives in dense form.
numberOfObjectives | is the dimension of the array |
std::vector<OtherObjectiveOption*> OSOption::getOtherObjectiveOptions | ( | std::string | solver_name | ) |
Get the array of other objective options.
solver_name | is the name of the solver whose options we want |
OtherObjectiveOption* OSOption::getOtherObjectiveOption | ( | int | optionNumber | ) |
Get one particular <other> objective option from the array of options.
optionNumber | is the index of the option in the array |
OtherObjectiveOption** OSOption::getAllOtherObjectiveOptions | ( | ) |
Get all <other> objective options.
InitConValue** OSOption::getInitConValuesSparse | ( | ) |
Get the initial values associated with the constraints in sparse form.
double* OSOption::getInitConValuesDense | ( | ) |
Get the initial values associated with the constraints in dense form.
double* OSOption::getInitConValuesDense | ( | int | numberOfConstraints | ) |
Get the initial values associated with the constraints in dense form.
numberOfConstraints | holds the dimension of the vector |
InitDualVarValue** OSOption::getInitDualVarValuesSparse | ( | ) |
Get the initial bounds associated with the dual variables in sparse form.
double* OSOption::getInitDualVarLowerBoundsDense | ( | ) |
Get the initial dual variables associated with the lower bounds in dense form.
double* OSOption::getInitDualVarLowerBoundsDense | ( | int | numberOfConstraints | ) |
Get the initial dual variables associated with the lower bounds in dense form.
numberOfConstraints | holds the dimension of the vector |
double* OSOption::getInitDualVarUpperBoundsDense | ( | ) |
Get the initial dual variables associated with the upper bounds in dense form.
double* OSOption::getInitDualVarUpperBoundsDense | ( | int | numberOfConstraints | ) |
Get the initial dual variables associated with the upper bounds in dense form.
numberOfConstraints | holds the dimension of the vector |
int* OSOption::getSlackVariableInitialBasisStatusDense | ( | int | numberOfConstraints | ) |
Get the initial basis status for all slack variables in dense form.
numberOfConstraints | is the dimension of the array |
std::vector<OtherConstraintOption*> OSOption::getOtherConstraintOptions | ( | std::string | solver_name | ) |
Get the array of other constraint options.
solver_name | is the name of the solver whose options we want |
OtherConstraintOption* OSOption::getOtherConstraintOption | ( | int | optionNumber | ) |
Get one particular <other> constraint option from the array of options.
optionNumber | is the index of the option in the array |
OtherConstraintOption** OSOption::getAllOtherConstraintOptions | ( | ) |
Get all <other> constraint options.
std::vector<SolverOption*> OSOption::getSolverOptions | ( | std::string | solver_name | ) |
Get the options associated with a given solver.
solver_name | is the name of the solver whose options we want |
std::vector<SolverOption*> OSOption::getSolverOptions | ( | std::string | solver_name, |
bool | getFreeOptions | ||
) |
Get the options associated with a given solver AND options not associated with any solver (if desired)
solver_name | is the name of the solver whose options we want |
getFreeOptions | is a boolean set to true if the free options (not associated with a solver name) should be returned |
SolverOption** OSOption::getAllSolverOptions | ( | ) |
Get all solver options.
bool OSOption::setServiceURI | ( | std::string | serviceURI | ) |
Set the serviceURI.
bool OSOption::setServiceName | ( | std::string | serviceName | ) |
Set the service name.
bool OSOption::setInstanceName | ( | std::string | instanceName | ) |
Set the instance name.
bool OSOption::setInstanceLocation | ( | std::string | instanceLocation | ) |
Set the instance location.
bool OSOption::setInstanceLocation | ( | std::string | instanceLocation, |
std::string | locationType | ||
) |
Alternative signature to set the instance location and location type simultaneously.
bool OSOption::setInstanceLocationType | ( | std::string | locationType | ) |
Set the instance location type.
bool OSOption::setJobID | ( | std::string | jobID | ) |
Set the job ID.
bool OSOption::setSolverToInvoke | ( | std::string | solverToInvoke | ) |
Set the solver to be invoked.
bool OSOption::setLicense | ( | std::string | license | ) |
Set the license information.
bool OSOption::setUserName | ( | std::string | userName | ) |
Set the username.
bool OSOption::setPassword | ( | std::string | password | ) |
Set the password.
bool OSOption::setContact | ( | std::string | contact | ) |
Set the contact information.
bool OSOption::setContact | ( | std::string | contact, |
std::string | transportType | ||
) |
Alternative signature to set the contact information and transport type simultaneously.
bool OSOption::setContactTransportType | ( | std::string | transportType | ) |
Set the transport type for contact.
bool OSOption::setOtherGeneralOptions | ( | int | numberOfOptions, |
OtherOption ** | other | ||
) |
Set the other general options as an entire array.
numberOfOptions | contains the number of other options to be set |
other | is a pointer to an array of OtherOption objects |
bool OSOption::setAnOtherGeneralOption | ( | std::string | name, |
std::string | value, | ||
std::string | description | ||
) |
Add another general option to the <other> option array.
name | - the identifying anme of the option. This string cannot be empty |
value | - optional value associated with this option |
description | - further information (can be used for documentation) |
bool OSOption::setMinDiskSpace | ( | std::string | unit, |
std::string | description, | ||
double | value | ||
) |
Set the minimum disk space required for the current job.
unit | - select the unit (Kb, Mb, etc.) |
description | - further description (can be used for documentation) |
value | - number of units of disk space required |
bool OSOption::setMinDiskSpace | ( | double | value | ) |
Alternate signature to set only the number of units.
bool OSOption::setMinDiskSpaceUnit | ( | std::string | unit | ) |
bool OSOption::setMinMemorySize | ( | std::string | unit, |
std::string | description, | ||
double | value | ||
) |
Set the minimum memory size required for the current job.
unit | - select the unit (Kb, Mb, etc.) |
description | - further description (can be used for documentation) |
value | - number of units of memory size required |
bool OSOption::setMinMemorySize | ( | double | value | ) |
Alternate signature to set only the number of units.
bool OSOption::setMinMemoryUnit | ( | std::string | unit | ) |
bool OSOption::setMinCPUSpeed | ( | std::string | unit, |
std::string | description, | ||
double | value | ||
) |
Set the minimum CPU speed required for the current job.
unit | - select the unit (MHz, GHz, TFlops etc.) |
description | - further description (can be used for documentation) |
value | - number of units of CPU speed required |
bool OSOption::setMinCPUSpeed | ( | double | value | ) |
Alternate signature to set only the number of units.
bool OSOption::setMinCPUSpeedUnit | ( | std::string | unit | ) |
bool OSOption::setMinCPUNumber | ( | int | number, |
std::string | description | ||
) |
Set the minimum number of CPU cores required for the current job.
number | - number of CPU cores required |
description | - further description (can be used for documentation) |
bool OSOption::setMinCPUNumber | ( | int | number | ) |
Alternate signature to set only the number of cores.
bool OSOption::setOtherSystemOptions | ( | int | numberOfOptions, |
OtherOption ** | other | ||
) |
bool OSOption::setAnOtherSystemOption | ( | std::string | name, |
std::string | value, | ||
std::string | description | ||
) |
bool OSOption::setServiceType | ( | std::string | serviceType | ) |
bool OSOption::setOtherServiceOptions | ( | int | numberOfOptions, |
OtherOption ** | other | ||
) |
bool OSOption::setAnOtherServiceOption | ( | std::string | name, |
std::string | value, | ||
std::string | description | ||
) |
bool OSOption::setMaxTime | ( | double | value, |
std::string | unit | ||
) |
bool OSOption::setMaxTime | ( | double | value | ) |
bool OSOption::setMaxTimeUnit | ( | std::string | unit | ) |
bool OSOption::setRequestedStartTime | ( | std::string | time | ) |
bool OSOption::setJobDependencies | ( | int | numberOfDependencies, |
std::string * | jobDependencies | ||
) |
bool OSOption::setAnotherJobDependency | ( | std::string | jobID | ) |
bool OSOption::setRequiredDirectories | ( | int | numberOfPaths, |
std::string * | paths | ||
) |
bool OSOption::setAnotherRequiredDirectory | ( | std::string | path | ) |
bool OSOption::setRequiredFiles | ( | int | numberOfPaths, |
std::string * | paths | ||
) |
bool OSOption::setAnotherRequiredFile | ( | std::string | path | ) |
bool OSOption::setDirectoriesToMake | ( | int | numberOfPaths, |
std::string * | paths | ||
) |
bool OSOption::setAnotherDirectoryToMake | ( | std::string | path | ) |
bool OSOption::setFilesToMake | ( | int | numberOfPaths, |
std::string * | paths | ||
) |
bool OSOption::setAnotherFileToMake | ( | std::string | path | ) |
bool OSOption::setPathPairs | ( | int | object, |
std::string * | from, | ||
std::string * | to, | ||
bool * | makeCopy, | ||
int | numberOfPathPairs | ||
) |
setPathPairs set a number of path pairs into the OSOption object
object | describes the type of pathpairs legal values are ENUM_PATHPAIR_input_dir, ENUM_PATHPAIR_input_file, ENUM_PATHPAIR_output_file, ENUM_PATHPAIR_output_dir |
from | is a pointer to an array of strings containing the location of the original object |
to | is a pointer to an array of strings containing the location of the destination object |
makeCopy | is a pointer to an array of boolean, describing for each object whether it is to be copied or moved |
numberOfPathPairs | is an integer giving the number of PathPairs this must equal the number of entries in the from, to and makeCopy arrays |
bool OSOption::setInputDirectoriesToMove | ( | int | numberOfPathPairs, |
PathPair ** | pathPair | ||
) |
bool OSOption::setAnotherInputDirectoryToMove | ( | std::string | fromPath, |
std::string | toPath, | ||
bool | makeCopy | ||
) |
bool OSOption::setInputFilesToMove | ( | int | numberOfPathPairs, |
PathPair ** | pathPair | ||
) |
bool OSOption::setAnotherInputFileToMove | ( | std::string | fromPath, |
std::string | toPath, | ||
bool | makeCopy | ||
) |
bool OSOption::setOutputFilesToMove | ( | int | numberOfPathPairs, |
PathPair ** | pathPair | ||
) |
bool OSOption::setAnotherOutputFileToMove | ( | std::string | fromPath, |
std::string | toPath, | ||
bool | makeCopy | ||
) |
bool OSOption::setOutputDirectoriesToMove | ( | int | numberOfPathPairs, |
PathPair ** | pathPair | ||
) |
bool OSOption::setAnotherOutputDirectoryToMove | ( | std::string | fromPath, |
std::string | toPath, | ||
bool | makeCopy | ||
) |
bool OSOption::setFilesToDelete | ( | int | numberOfPaths, |
std::string * | paths | ||
) |
bool OSOption::setAnotherFileToDelete | ( | std::string | path | ) |
bool OSOption::setDirectoriesToDelete | ( | int | numberOfPaths, |
std::string * | paths | ||
) |
bool OSOption::setAnotherDirectoryToDelete | ( | std::string | path | ) |
bool OSOption::setProcessesToKill | ( | int | numberOfProcesses, |
std::string * | processes | ||
) |
bool OSOption::setAnotherProcessToKill | ( | std::string | process | ) |
bool OSOption::setOtherJobOptions | ( | int | numberOfOptions, |
OtherOption ** | other | ||
) |
bool OSOption::setAnOtherJobOption | ( | std::string | name, |
std::string | value, | ||
std::string | description | ||
) |
bool OSOption::setNumberOfVariables | ( | int | numberOfVariables | ) |
bool OSOption::setNumberOfObjectives | ( | int | numberOfObjectives | ) |
bool OSOption::setNumberOfConstraints | ( | int | numberOfConstraints | ) |
bool OSOption::setInitVarValues | ( | int | numberOfVar, |
int * | idx, | ||
double * | value, | ||
std::string * | name | ||
) |
bool OSOption::setInitVarValuesSparse | ( | int | numberOfVar, |
InitVarValue ** | var | ||
) |
bool OSOption::setInitVarValuesSparse | ( | int | numberOfVar, |
InitVarValue ** | var, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitVarValuesDense | ( | int | numberOfVar, |
double * | value | ||
) |
bool OSOption::setAnotherInitVarValue | ( | int | idx, |
double | value | ||
) |
bool OSOption::setInitVarValuesString | ( | int | numberOfVar, |
int * | idx, | ||
std::string * | value, | ||
std::string * | name | ||
) |
bool OSOption::setInitVarValuesStringSparse | ( | int | numberOfVar, |
InitVarValueString ** | var | ||
) |
bool OSOption::setInitVarValuesStringSparse | ( | int | numberOfVar, |
InitVarValueString ** | var, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitVarValuesStringDense | ( | int | numberOfVar, |
std::string * | value | ||
) |
bool OSOption::setAnotherInitVarValueString | ( | int | idx, |
std::string | value | ||
) |
bool OSOption::setInitBasisStatus | ( | int | object, |
int | status, | ||
int * | i, | ||
int | ni | ||
) |
bool OSOption::setInitBasisStatusSparse | ( | int | numberOfVar, |
InitBasStatus ** | var | ||
) |
bool OSOption::setInitBasisStatusSparse | ( | int | numberOfVar, |
InitBasStatus ** | var, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitBasisStatusDense | ( | int | numberOfVar, |
std::string * | var | ||
) |
bool OSOption::setAnotherInitBasisStatus | ( | int | type, |
int | idx, | ||
int | status | ||
) |
Set the basis status for another variable, objective or constraint/slack.
type | type of this element (see ENUM_PROBLEM_COMPONENT - OSGeneral.h) |
idx | index of this element (nonnegative for variable or constraint, negative for objective) |
status | basis status (see ENUM_BASIS_STATUS - OSGeneral.h) |
bool OSOption::setIntegerVariableBranchingWeights | ( | int | numberOfVar, |
int * | idx, | ||
double * | value, | ||
std::string * | name | ||
) |
bool OSOption::setIntegerVariableBranchingWeightsSparse | ( | int | numberOfVar, |
BranchingWeight ** | var | ||
) |
bool OSOption::setIntegerVariableBranchingWeightsSparse | ( | int | numberOfVar, |
BranchingWeight ** | var, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setIntegerVariableBranchingWeightsDense | ( | int | numberOfVar, |
double * | value | ||
) |
bool OSOption::setAnotherIntegerVariableBranchingWeight | ( | int | idx, |
double | value | ||
) |
bool OSOption::setSOSVariableBranchingWeights | ( | int | numberOfSOS, |
SOSWeights ** | sos | ||
) |
bool OSOption::setAnotherSOSVariableBranchingWeight | ( | int | sosIdx, |
int | nvar, | ||
double | weight, | ||
int * | idx, | ||
double * | value, | ||
std::string * | name | ||
) |
bool OSOption::setNumberOfOtherVariableOptions | ( | int | numberOfOther | ) |
bool OSOption::setOtherVariableOptions | ( | int | numberOfVar, |
OtherVariableOption ** | var | ||
) |
bool OSOption::setAnOtherVariableOption | ( | OtherVariableOption * | varOption | ) |
bool OSOption::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.
iOther | position of this element in the array of <other> |
numberOfVar | number of children contained in this <other> element |
numberOfEnumerations | number of <enumeration> children |
name | name of this <other> element |
value | a value associated with this <other> element |
solver | the solver associated with this <other> element |
category | the category of this <other> element |
type | type of this <other> element |
varType | type of the data in the array |
enumType | type of the data in the <enumeration> array |
description | further description of this <other> element |
bool OSOption::setOtherOptionEnumeration | ( | 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 <constraints> element.
object | the object into which the enumeration is to be stored (legal values see ENUM_PROBLEM_COMPONENT in OSGeneral.h) |
otherOptionNumber | number of the <other> option in the list of <other> options (zero-based) |
enumerationNumber | number of the <enumeration> in the list of enumerations (zero-based) |
numberOfEl | number of objects sharing the value of this enumeration |
value | value of the enumeration (as a string) |
description | further information about the enumeration and its value |
idxArray | the array of indices for the objects sharing this enumeration |
bool OSOption::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.
otherOptionNumber | number of the <other> option in the list of <other> options (zero-based) |
varNumber | number of the in the array (zero-based) |
idx | index of the variable to which this value belongs |
value | value of the option (as a string) |
lbValue | value associated with the lower bound of the variable (as a string) |
ubValue | value associated with the upper bound of the variable (as a string) |
bool OSOption::setInitObjValues | ( | int | numberOfObj, |
int * | idx, | ||
double * | value, | ||
std::string * | name | ||
) |
bool OSOption::setInitObjValuesSparse | ( | int | numberOfObj, |
InitObjValue ** | obj | ||
) |
bool OSOption::setInitObjValuesSparse | ( | int | numberOfObj, |
InitObjValue ** | obj, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitObjValuesDense | ( | int | numberOfObj, |
double * | value | ||
) |
bool OSOption::setAnotherInitObjValue | ( | int | idx, |
double | value | ||
) |
bool OSOption::setInitObjBounds | ( | int | numberOfObj, |
int * | idx, | ||
double * | lbValue, | ||
double * | ubValue, | ||
std::string * | name | ||
) |
bool OSOption::setInitObjBoundsSparse | ( | int | numberOfObj, |
InitObjBound ** | obj | ||
) |
bool OSOption::setInitObjBoundsSparse | ( | int | numberOfObj, |
InitObjBound ** | obj, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitObjBoundsDense | ( | int | numberOfObj, |
double * | lb, | ||
double * | ub | ||
) |
bool OSOption::setAnotherInitObjBound | ( | int | idx, |
double | lbValue, | ||
double | ubValue | ||
) |
bool OSOption::setNumberOfOtherObjectiveOptions | ( | int | numberOfOther | ) |
bool OSOption::setOtherObjectiveOptions | ( | int | numberOfObj, |
OtherObjectiveOption ** | obj | ||
) |
bool OSOption::setAnOtherObjectiveOption | ( | OtherObjectiveOption * | objOption | ) |
bool OSOption::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.
iOther | position of this element in the array of <other> |
numberOfObj | number of <obj> children contained in this <other> element |
numberOfEnumerations | number of <enumeration> children |
name | name of this <other> element |
value | a value associated with this <other> element |
solver | the solver associated with this <other> element |
category | the category of this <other> element |
type | type of this <other> element |
objType | type of the data in the array |
enumType | type of the data in the <enumeration> array |
description | further description of this <other> element |
bool OSOption::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.
otherOptionNumber | number of the <other> option in the list of <other> options (zero-based) |
objNumber | number of the <obj> in the array (zero-based) |
idx | index of the objective to which this value belongs |
name | name of the objective |
value | value of the option (as a string) |
lbValue | value associated with the lower bound of the objective (as a string) |
ubValue | value associated with the upper bound of the objective (as a string) |
bool OSOption::setInitConValues | ( | int | numberOfCon, |
int * | idx, | ||
double * | value, | ||
std::string * | name | ||
) |
bool OSOption::setInitConValuesSparse | ( | int | numberOfCon, |
InitConValue ** | con | ||
) |
bool OSOption::setInitConValuesSparse | ( | int | numberOfCon, |
InitConValue ** | con, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitConValuesDense | ( | int | numberOfCon, |
double * | value | ||
) |
bool OSOption::setAnotherInitConValue | ( | int | idx, |
double | value | ||
) |
bool OSOption::setInitDualValues | ( | int | numberOfCon, |
int * | idx, | ||
double * | lbValue, | ||
double * | ubValue, | ||
std::string * | name | ||
) |
bool OSOption::setInitDualVarValuesSparse | ( | int | numberOfCon, |
InitDualVarValue ** | con | ||
) |
bool OSOption::setInitDualVarValuesSparse | ( | int | numberOfCon, |
InitDualVarValue ** | con, | ||
ENUM_COMBINE_ARRAYS | disp | ||
) |
bool OSOption::setInitDualVarValuesDense | ( | int | numberOfCon, |
double * | lb, | ||
double * | ub | ||
) |
bool OSOption::setAnotherInitDualVarValue | ( | int | idx, |
double | lbValue, | ||
double | ubValue | ||
) |
bool OSOption::setNumberOfOtherConstraintOptions | ( | int | numberOfOther | ) |
bool OSOption::setOtherConstraintOptions | ( | int | numberOfOptions, |
OtherConstraintOption ** | other | ||
) |
bool OSOption::setAnOtherConstraintOption | ( | OtherConstraintOption * | optionValue | ) |
bool OSOption::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.
iOther | position of this element in the array of <other> |
numberOfCon | number of <con> children contained in this <other> element |
numberOfEnumerations | number of <enumeration> children |
name | name of this <other> element |
value | a value associated with this <other> element |
solver | the solver associated with this <other> element |
category | the category of this <other> element |
type | type of this <other> element |
conType | type of the data in the array |
enumType | type of the data in the <enumeration> array |
description | further description of this <other> element |
bool OSOption::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.
otherOptionNumber | number of the <other> option in the list of <other> options (zero-based) |
conNumber | number of the <obj> in the array (zero-based) |
idx | index of the constraint to which this value belongs |
name | name of the constraint |
value | value of the option (as a string) |
lbValue | value associated with the lower bound of the constraint (as a string) |
ubValue | value associated with the upper bound of the constraint (as a string) |
bool OSOption::setNumberOfSolverOptions | ( | int | numberOfOptions | ) |
bool OSOption::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.
iOption | position of this element in the array of options |
numberOfVar | number of children contained in this <other> element |
name | name of this solver option |
value | a value associated with this option |
solver | the solver to which this option applies |
category | the category of this option (solver specific) |
type | type of this option (e.g., numeric or string) |
description | further description of this option "param itemList: the list of items associated with this option (could be NULL) |
bool OSOption::setSolverOptions | ( | int | numberOfSolverOptions, |
SolverOption ** | solverOption | ||
) |
bool OSOption::setAnotherSolverOption | ( | std::string | name, |
std::string | value, | ||
std::string | solver, | ||
std::string | category, | ||
std::string | type, | ||
std::string | description | ||
) |
bool OSOption::setOptionInt | ( | std::string | optionName, |
int | optionValue | ||
) |
bool OSOption::setOptionStr | ( | std::string | optionName, |
std::string | optionValue | ||
) |
bool OSOption::setOptionDbl | ( | std::string | optionName, |
double | value | ||
) |
GeneralFileHeader* OSOption::optionHeader |
OSOption has a header and five other children: general, system, service, job, and optimization.
header information
Definition at line 3576 of file OSOption.h.
GeneralOption* OSOption::general |
generalOption holds the first child of the OSOption specified by the OSoL Schema.
Definition at line 3580 of file OSOption.h.
SystemOption* OSOption::system |
systemOption holds the second child of the OSOption specified by the OSoL Schema.
Definition at line 3584 of file OSOption.h.
ServiceOption* OSOption::service |
serviceOption holds the third child of the OSOption specified by the OSoL Schema.
Definition at line 3588 of file OSOption.h.
JobOption* OSOption::job |
jobOption holds the fourth child of the OSOption specified by the OSoL Schema.
Definition at line 3592 of file OSOption.h.
OptimizationOption* OSOption::optimization |
optimizationOption holds the fifth child of the OSOption specified by the OSoL Schema.
Definition at line 3596 of file OSOption.h.