The Option Class. More...

#include <OSOption.h>

Collaboration diagram for OSOption:

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)
	set() options in the <service> element More...

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)
	set() options in the <job> element More...

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	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 <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...

Private Attributes
double *	m_mdInitVarValuesDense
	m_mdInitVarValuesDense holds the initial variable values in dense form More...

std::string *	m_mdInitVarValuesStringDense
	m_mdInitVarValuesStringDense holds the initial values for string-valued variables More...

int *	m_mdInitBasisStatusDense
	m_mdInitBasisStatusDense holds the initial basis status in dense form More...

double *	m_mdIntegerVariableBranchingWeightsDense
	m_mdIntegerVariableBranchingWeightsDense holds the branching weights for integer variables More...

double *	m_mdInitObjValuesDense
	m_mdInitObjValuesDense holds initial objective values in dense form More...

double *	m_mdInitObjLowerBoundsDense
	m_mdInitObjLowerBoundsDense holds initial lower bounds for the objectives in dense form More...

double *	m_mdInitObjUpperBoundsDense
	m_mdInitObjUpperBoundsDense holds initial upper bounds for the objectives in dense form More...

double *	m_mdInitConValuesDense
	m_mdInitConValuesDense holds initial constraint values in dense form More...

double *	m_mdInitDualVarLowerBoundsDense
	m_mdInitDualVarLowerBoundsDense holds initial dual values for the lower bound of the constraints in dense form More...

double *	m_mdInitDualVarUpperBoundsDense
	m_mdInitDualVarUpperBoundsDense holds initial dual values for the upper bound of the constraints in dense form More...

Detailed Description

The Option Class.

Author: Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin

Version: 1.0, 21/07/2008

Since: OS 1.1

Remarks: A class for holding all the solver options information.

Definition at line 3564 of file OSOption.h.

Constructor & Destructor Documentation

OSOption::OSOption ( )

Default constructor.

Definition at line 1262 of file OSOption.cpp.

OSOption::~OSOption ( )

Class destructor.

Definition at line 1287 of file OSOption.cpp.

Member Function Documentation

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.

set option header

Parameters

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

Definition at line 7528 of file OSOption.cpp.

bool OSOption::IsEqual ( OSOption * that )

A function to check for the equality of two objects.

Definition at line 9614 of file OSOption.cpp.

bool OSOption::setRandom	(	double	density,
		bool	conformant
	)

A function to make a random instance of this class.

Parameters

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)

Definition at line 12199 of file OSOption.cpp.

bool OSOption::deepCopyFrom ( OSOption * that )

A function to make a deep copy of an OSOption object.

Parameters

that,: the OSOption object from which information is to be copied

Returns: whether the copy was created successfully

Definition at line 13308 of file OSOption.cpp.

std::string OSOption::getFileName ( )

Get the name of the file.

get the file name (in <optionHeader> element)

Definition at line 1360 of file OSOption.cpp.

std::string OSOption::getFileSource ( )

Get the source of the file or problem.

get the file source (in <optionHeader> element)

Definition at line 1371 of file OSOption.cpp.

std::string OSOption::getFileDescription ( )

Get a description for the file or problem.

get the file description (in <optionHeader> element)

Definition at line 1382 of file OSOption.cpp.

std::string OSOption::getFileCreator ( )

Get the name of the person who created the file.

get the file creator (in <optionHeader> element)

Definition at line 1393 of file OSOption.cpp.

std::string OSOption::getFileLicence ( )

Get licence information associated with the file.

get the file licence information (in <optionHeader> element)

Definition at line 1404 of file OSOption.cpp.

std::string OSOption::getServiceURI ( )

Get the service URI.

get the service URI (in <general> element)

Definition at line 1416 of file OSOption.cpp.

std::string OSOption::getServiceName ( )

Get the service name.

get the service name (in <general> element)

Definition at line 1427 of file OSOption.cpp.

std::string OSOption::getInstanceName ( )

Get the instance name.

get the instance name (in <general> element)

Definition at line 1438 of file OSOption.cpp.

std::string OSOption::getInstanceLocation ( )

Get the instance location.

get the instance location (in <general> element)

Definition at line 1449 of file OSOption.cpp.

std::string OSOption::getInstanceLocationType ( )

Get the location type.

get the instance location type (in <general> element)

Definition at line 1461 of file OSOption.cpp.

std::string OSOption::getJobID ( )

Get the job ID.

get the job ID (in <general> element)

Definition at line 1473 of file OSOption.cpp.

std::string OSOption::getSolverToInvoke ( )

Get the solver name.

get the name of the solver to be invoked (in <general> element)

Definition at line 1484 of file OSOption.cpp.

std::string OSOption::getLicense ( )

Get the license string.

get the license information (in <general> element)

Definition at line 1495 of file OSOption.cpp.

std::string OSOption::getUserName ( )

Get the user name.

get the user name (in <general> element)

Definition at line 1506 of file OSOption.cpp.

std::string OSOption::getPassword ( )

Get the password.

get the password (in <general> element)

Definition at line 1517 of file OSOption.cpp.

std::string OSOption::getContact ( )

Get the contact information.

get the contact information (in <general> element)

Definition at line 1528 of file OSOption.cpp.

std::string OSOption::getContactTransportType ( )

Get the transport type.

get the transport type (in <general> element)

Definition at line 1540 of file OSOption.cpp.

std::string OSOption::getMinDiskSpaceUnit ( )

Get the disk space unit.

get the disk space units (in <system> element)

Definition at line 1552 of file OSOption.cpp.

std::string OSOption::getMinDiskSpaceDescription ( )

get the disk space description

get the disk space description (in <system> element)

Definition at line 1564 of file OSOption.cpp.

std::string OSOption::getMinMemoryUnit ( )

Get the memory unit.

get the memory units (in <system> element)

Definition at line 1576 of file OSOption.cpp.

std::string OSOption::getMinMemoryDescription ( )

get the memory description

get the memory description (in <system> element)

Definition at line 1588 of file OSOption.cpp.

std::string OSOption::getMinCPUSpeedUnit ( )

Get the CPU speed unit.

get the CPU speed units (in <system> element)

Definition at line 1600 of file OSOption.cpp.

std::string OSOption::getMinCPUSpeedDescription ( )

Get the CPU speed description.

get the CPU speed description (in <system> element)

Definition at line 1612 of file OSOption.cpp.

std::string OSOption::getMinCPUNumberDescription ( )

Get the CPU description.

get the CPU description (in <system> element)

Definition at line 1624 of file OSOption.cpp.

std::string OSOption::getServiceType ( )

Get the service type.

get the service type (in <service> element)

Definition at line 1636 of file OSOption.cpp.

std::string OSOption::getMaxTimeUnit ( )

Get the time unit.

get the time unit (in <job> element)

Definition at line 1647 of file OSOption.cpp.

std::string OSOption::getRequestedStartTime ( )

Get the requested starting time.

get the requested start time (in <job> element)

Definition at line 1659 of file OSOption.cpp.

std::string OSOption::getOptionStr ( std::string optionName )

Get any of the string-valued options.

get the value of a string-valued option

Parameters

optionName The name of the option

Returns: the value of the option optionName

Note: This function returns the empty string "" if optionName is not found

Definition at line 1673 of file OSOption.cpp.

double OSOption::getMinDiskSpace ( )

Get the minimum required disk space.

get the minimum disk space required (in <system> element)

Definition at line 1739 of file OSOption.cpp.

double OSOption::getMinMemorySize ( )

Get the minimum required memory.

get the minimum memory required (in <system> element)

Definition at line 1751 of file OSOption.cpp.

double OSOption::getMinCPUSpeed ( )

Get the minimum required CPU speed.

get the minimum CPU speed required (in <system> element)

Definition at line 1763 of file OSOption.cpp.

double OSOption::getMaxTime ( )

Get the maximum allowed time.

get the maximum time allowed (in <job> element)

Definition at line 1775 of file OSOption.cpp.

double OSOption::getOptionDbl ( std::string optionName )

Get any of the double-valued options.

get the value of a double-valued option

Parameters

optionName The name of the option

Returns: the value of the option optionName

Note: returns 0 if optionName is not found

Definition at line 1790 of file OSOption.cpp.

int OSOption::getMinCPUNumber ( )

Get the minimum required number of CPUs.

get() methods that return integers

get the minimum number of CPUs required (in <system> element)

Definition at line 1814 of file OSOption.cpp.

int OSOption::getNumberOfOtherGeneralOptions ( )

Get the number of <other> options in the <general> element.

get the number of other <general> options

Definition at line 1825 of file OSOption.cpp.

int OSOption::getNumberOfOtherSystemOptions ( )

Get the number of <other> options in the <system> element.

get the number of other <system> options

Definition at line 1837 of file OSOption.cpp.

int OSOption::getNumberOfOtherServiceOptions ( )

Get the number of <other> options in the <service> element.

get the number of other <service> options

Definition at line 1849 of file OSOption.cpp.

int OSOption::getNumberOfOtherJobOptions ( )

Get the number of <other> options in the <job> element.

get the number of other <job> options

Definition at line 1861 of file OSOption.cpp.

int OSOption::getNumberOfJobDependencies ( )

Get the number of job dependencies.

get the number of job dependencies (in <job> element)

Definition at line 1873 of file OSOption.cpp.

int OSOption::getNumberOfRequiredDirectories ( )

Get the number of required directories.

get the number of required directories (in <job> element)

Definition at line 1885 of file OSOption.cpp.

int OSOption::getNumberOfRequiredFiles ( )

Get the number of required files.

get the number of required files (in <job> element)

Definition at line 1897 of file OSOption.cpp.

int OSOption::getNumberOfDirectoriesToMake ( )

Get the number of directories to make.

get the number of directories to make (in <job> element)

Definition at line 1909 of file OSOption.cpp.

int OSOption::getNumberOfFilesToMake ( )

Get the number of files to make.

get the number of files to create (in <job> element)

Definition at line 1921 of file OSOption.cpp.

int OSOption::getNumberOfInputDirectoriesToMove ( )

Get the number of input directories to move.

get the number of input directories to move or copy (in <job> element)

Definition at line 1933 of file OSOption.cpp.

int OSOption::getNumberOfInputFilesToMove ( )

Get the number of input files to move.

get the number of input files to move or copy (in <job> element)

Definition at line 1945 of file OSOption.cpp.

int OSOption::getNumberOfOutputDirectoriesToMove ( )

Get the number of output directories to move.

get the number of output directories to move or copy (in <job> element)

Definition at line 1957 of file OSOption.cpp.

int OSOption::getNumberOfOutputFilesToMove ( )

Get the number of output files to move.

get the number of output files to move or copy (in <job> element)

Definition at line 1969 of file OSOption.cpp.

int OSOption::getNumberOfFilesToDelete ( )

Get the number of files to delete.

get the number of files to delete (in <job> element)

Definition at line 1981 of file OSOption.cpp.

int OSOption::getNumberOfDirectoriesToDelete ( )

Get the number of directories to delete.

get the number of directories to delete (in <job> element)

Definition at line 1993 of file OSOption.cpp.

int OSOption::getNumberOfProcessesToKill ( )

Get the number of processes to kill.

get the number of processes to kill (in <job> element)

Definition at line 2005 of file OSOption.cpp.

int OSOption::getNumberOfVariables ( )

Get the number of variables in the instance.

get the number of variables (in <optimization> element)

Definition at line 2017 of file OSOption.cpp.

int OSOption::getNumberOfObjectives ( )

Get the number of objectives in the instance.

get the number of objectives (in <optimization> element)

Definition at line 2028 of file OSOption.cpp.

int OSOption::getNumberOfConstraints ( )

Get the number of constraints in the instance.

get the number of constraints (in <optimization> element)

Definition at line 2039 of file OSOption.cpp.

int OSOption::getNumberOfInitVarValues ( )

Get the number of initial variable values.

get the number of variables that have initial values (in <optimization> element)

Returns: the number of initial variable values.

Definition at line 2051 of file OSOption.cpp.

int OSOption::getNumberOfInitVarValuesString ( )

Get the number of initial variable strings.

get the number of string-valued variables that have initial values (in <optimization> element)

Returns: the number of initial variable strings.

Definition at line 2069 of file OSOption.cpp.

int OSOption::getNumberOfIntegerVariableBranchingWeights ( )

Get the number of variables for which integer branching weights are provided.

get the number of variables that are given integer branching weights (in <optimization> element)

Returns: the number of variables.

Definition at line 2082 of file OSOption.cpp.

int OSOption::getNumberOfSOS ( )

Get the number of special ordered sets for which branching weights are provided.

get the number of SOS that are given branching weights (in <optimization> element)

Returns: the number of variables.

Definition at line 2094 of file OSOption.cpp.

int OSOption::getNumberOfSOSVarBranchingWeights ( int iSOS )

Get the number of variables for which branching weights are provided in a particular SOS.

get the number of variables that are given integer branching weights (in <optimization> element)

Parameters

iSOS	the number of the SOS

Returns: the number of variables.

Definition at line 2106 of file OSOption.cpp.

int OSOption::getNumberOfOtherVariableOptions ( )

Get the number of other variable options.

get the number of other variable options (in <optimization> element)

Returns: the number of other variable options.

Definition at line 2122 of file OSOption.cpp.

int OSOption::getNumberOfInitObjValues ( )

Get the number of initial objective values.

get the number of objectives for which initial values are given (in <optimization> element)

Returns: the number of initial objective values.

Definition at line 2134 of file OSOption.cpp.

int OSOption::getNumberOfInitObjBounds ( )

Get the number of initial objective bounds.

get the number of objectives for which initial bounds are given (in <optimization> element)

Returns: the number of initial objective bound values.

Definition at line 2147 of file OSOption.cpp.

int OSOption::getNumberOfOtherObjectiveOptions ( )

Get the number of other objective options.

get the number of other objective options (in <optimization> element)

Returns: the number of other objective options.

Definition at line 2159 of file OSOption.cpp.

int OSOption::getNumberOfInitConValues ( )

Get the number of initial constraint values.

get the number of constraints for which initial values are given (in <optimization> element)

Returns: the number of initial constraint values.

Definition at line 2170 of file OSOption.cpp.

int OSOption::getNumberOfInitDualVarValues ( )

Get the number of initial dual variable values.

get the number of constraints for which initial dual values are given (in <optimization> element)

Returns: the number of initial dual variable values.

Definition at line 2182 of file OSOption.cpp.

int OSOption::getNumberOfOtherConstraintOptions ( )

Get the number of other constraint options.

get the number of other constraint options (in <optimization> element)

Returns: the number of other constraint options.

Definition at line 2195 of file OSOption.cpp.

int OSOption::getNumberOfSolverOptions ( )

Get the number of solver options.

get the number of other solver options (in <optimization> element)

Returns: the number of solver options.

Definition at line 2207 of file OSOption.cpp.

int OSOption::getOptionInt ( std::string optionName )

Get any of the integer-valued options.

get the value of an integer-valued option

Parameters

optionName The name of the option

Returns: the value of the option optionName

Note: This function returns -1 if optionName is not found

Definition at line 2222 of file OSOption.cpp.

OtherOption ** OSOption::getOtherGeneralOptions ( )

Get the array of other options associated with the <general> element.

get the array of other <general> options

Returns: a vector of pointers to otherOptions objects associated with the <general> element

Definition at line 2331 of file OSOption.cpp.

OtherOption ** OSOption::getOtherSystemOptions ( )

Get the array of other options associated with the <system> element.

get the array of other <system> options

Returns: a vector of pointers to otherOptions objects associated with the <system> element

Definition at line 2344 of file OSOption.cpp.

OtherOption ** OSOption::getOtherServiceOptions ( )

Get the array of other options associated with the <service> element.

get the array of other <service> options

Returns: a vector of pointers to otherOptions objects associated with the <service> element

Definition at line 2357 of file OSOption.cpp.

OtherOption ** OSOption::getOtherJobOptions ( )

Get the array of other options associated with the <job> element.

get the array of other <job> options

Returns: a vector of pointers to otherOptions objects associated with the <job> element

Definition at line 2370 of file OSOption.cpp.

OtherOption ** OSOption::getOtherOptions ( std::string category )

Get the array of other options associated with any element.

get the array of other options associated with a category

Returns: a vector of pointers to otherOptions objects associated with the element whose name matches elementName

Parameters

category - The name of the option category

Returns: other options associated with the element <"category">

Note: This function returns NULL if category is not found

Definition at line 2386 of file OSOption.cpp.

OtherOption ** OSOption::getAllOtherOptions ( )

Get the array of all other options associated with the <general>, <system>, <service> and <job> elements.

get the array of other options associated with all children of <osol>

Returns: a vector of pointers to all otherOptions objects

Definition at line 2406 of file OSOption.cpp.

std::string * OSOption::getJobDependencies ( )

Get the array of job dependencies.

get the array of job dependencies

Returns: a vector of pointers to JobDependencies objects

Definition at line 2499 of file OSOption.cpp.

std::string * OSOption::getRequiredDirectories ( )

Get the array of required directories.

get the list of required directories

Returns: a vector of pointers to DirectoriesAndFiles objects giving the directories that are required by the current job

Definition at line 2518 of file OSOption.cpp.

std::string * OSOption::getRequiredFiles ( )

Get the array of required files.

get the list of required files

Returns: a vector of pointers to DirectoriesAndFiles objects giving the files that are required by the current job

Definition at line 2536 of file OSOption.cpp.

std::string * OSOption::getDirectoriesToMake ( )

Get the array of directories to make.

get the list of directories that need to be created

Returns: a vector of pointers to DirectoriesAndFiles objects giving the directories that must be created

Definition at line 2554 of file OSOption.cpp.

std::string * OSOption::getFilesToMake ( )

Get the array of files to make.

get the list of files that need to be created

Returns: a vector of pointers to DirectoriesAndFiles objects giving the files that must be created

Definition at line 2572 of file OSOption.cpp.

PathPair ** OSOption::getInputDirectoriesToMove ( )

Get the array of input directories to move.

get the list of input directories that need to be moved or copied

Returns: a vector of pointers to PathPair objects giving the input directories that must be moved

Definition at line 2590 of file OSOption.cpp.

PathPair ** OSOption::getInputFilesToMove ( )

Get the array of input files to move.

get the list of input files that need to be moved or copied

Returns: a vector of pointers to PathPair objects giving the input files that must be moved

Definition at line 2608 of file OSOption.cpp.

PathPair ** OSOption::getOutputDirectoriesToMove ( )

Get the array of output directories to move.

get the list of output directories that need to be moved or copied

Returns: a vector of pointers to PathPair objects giving the output directories that must be moved

Definition at line 2644 of file OSOption.cpp.

PathPair ** OSOption::getOutputFilesToMove ( )

Get the array of output files to move.

get the list of output files that need to be moved or copied

Returns: a vector of pointers to PathPair objects giving the output files that must be moved

Definition at line 2626 of file OSOption.cpp.

std::string * OSOption::getDirectoriesToDelete ( )

Get the array of directories to delete.

get the list of directories that need to be deleted

Returns: a vector of pointers to DirectoriesAndFiles objects giving the directories that must be deleted

Definition at line 2680 of file OSOption.cpp.

std::string * OSOption::getFilesToDelete ( )

Get the array of files to delete.

get the list of files that need to be deleted

Returns: a vector of pointers to DirectoriesAndFiles objects giving the files that must be deleted

Definition at line 2662 of file OSOption.cpp.

std::string * OSOption::getProcessesToKill ( )

Get the array of processes to kill.

get the list of processes that need to be killed

Returns: a vector of pointers to Processes objects giving the processes that must be killed

Definition at line 2698 of file OSOption.cpp.

InitVarValue ** OSOption::getInitVarValuesSparse ( )

Get the initial values associated with the variables in sparse form.

get the list of initial variable values in sparse form

Returns: a vector of pointers to InitVarValue objects that hold initial values for (some of) the variables; a list of index/value pairs

Definition at line 2719 of file OSOption.cpp.

double * OSOption::getInitVarValuesDense ( )

Get the initial values associated with the variables in dense form.

get the list of initial variable values in dense form

Returns: a vector of double that holds initial values (or OSNaN()) for all of the variables; an array of values

Note: return OSNaN() for variables that are not initialed

Definition at line 2744 of file OSOption.cpp.

double * OSOption::getInitVarValuesDense ( int numberOfVariables )

Get the initial values associated with the variables in dense form.

get the list of initial variable values in dense form

Parameters

numberOfVariables holds the dimension of the vector

Returns: a vector of double that holds initial values (or OSNaN()) for all of the variables

Parameters

numberOfVariables is the dimension of the array

Returns: an array of values

Note: return OSNaN() for variables that are not initialed

Definition at line 2795 of file OSOption.cpp.

InitVarValueString ** OSOption::getInitVarValuesStringSparse ( )

Get the initial value strings associated with the variables in sparse form.

get the list of initial values for string-valued variables in sparse form

Returns: a vector of pointers to InitVarValueString objects that hold initial value strings for (some of) the variables; a list of index/value pairs

Definition at line 2849 of file OSOption.cpp.

std::string * OSOption::getInitVarValuesStringDense ( )

Get the initial value strings associated with the variables in dense form.

get the list of initial values for string-valued variables in dense form

Returns: a vector of strings that holds initial value strings (or "") for all of the variables; an array of value strings

Note: return the empty string "" for variables that are not initialed

Definition at line 2874 of file OSOption.cpp.

std::string * OSOption::getInitVarValuesStringDense ( int numberOfVariables )

Get the initial value strings associated with the variables in dense form.

get the list of initial values for string-valued variables in dense form

Parameters

numberOfVariables holds the dimension of the vector

Returns: a vector of strings that holds initial value strings (or "") for all of the variables

Parameters

numberOfVariables is the dimension of the array

Returns: an array of value strings

Note: return the empty string "" for variables that are not initialed

Definition at line 3745 of file OSOption.cpp.

InitBasStatus** OSOption::getInitBasisStatusSparse ( )

Get the initial basis status in sparse form.

Returns: a vector of pointers to InitBasStatus objects that hold initial basis status for (some of) the variables

std::string* OSOption::getInitBasisStatusDense ( )

Get the initial basis information in dense form.

Returns: a vector of strings that holds initial basis status (or "unknown") for all of the variables

int * OSOption::getVariableInitialBasisStatusDense ( int numberOfVariables )

Get the initial basis status for all variables in dense form.

get the list of initial values for string-valued variables in dense form

Returns: an array of int, with values corresponding to ENUM_BASIS_STATUS – see OSGeneral.h)

Note: returns ENUM_BASIS_STATUS_unknown for variables that are not initialed

Parameters

numberOfVariables	is the dimension of the array
numberOfVariables	is the dimension of the array

Returns: an array of value strings

Note: return the empty string "" for variables that are not initialed std::string *OSOption::getInitVarValuesStringDense(int numberOfVariables) { try { if (numberOfVariables < 0) throw ErrorClass("\"numberOfVariables" must be present to use dense methods");

if (this->optimization != NULL) { if (this->optimization->variables != NULL) { if (this->optimization->variables->initialVariableValuesString != NULL) { int i,j,k; int num_var; num_var = this->getNumberOfInitVarValuesString();

if (m_mdInitVarValuesStringDense != NULL) delete [] m_mdInitVarValuesStringDense; m_mdInitVarValuesStringDense = new std::string[numberOfVariables]; for (k = 0; k < numberOfVariables; k++) m_mdInitVarValuesStringDense[k] = "";

for (i = 0; i < num_var; i++) { j = this->optimization->variables->initialVariableValuesString->var[i]->idx; if (j >= 0 && j < numberOfVariables) m_mdInitVarValuesStringDense[j] = this->optimization->variables->initialVariableValuesString->var[i]->value; else throw ErrorClass("Variable index out of range"); } return m_mdInitVarValuesStringDense; } } } } catch(const ErrorClass& eclass) { throw ErrorClass(eclass.errormsg); } return NULL; }//getInitVarValuesStringDense get the basis status for all variables in dense form

Returns: an array of int, with values corresponding to ENUM_BASIS_STATUS – see OSGeneral.g

Note: returns ENUM_BASIS_STATUS_unknown for variables that are not initialed

Parameters

numberOfVariables is the dimension of the array

Definition at line 2968 of file OSOption.cpp.

int OSOption::getNumberOfInitialBasisElements	(	int	type,
		int	status
	)

Get the number of initial basis elements for a particular variable type and basis status.

Returns: the number of elements

Parameters

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)

Definition at line 3073 of file OSOption.cpp.

bool OSOption::getInitialBasisElements	(	int	type,
		int	status,
		int *	elem
	)

Get the initial basis elements for a particular variable type and basis status.

Returns: whether the operation was successful or not

Parameters

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

Definition at line 3115 of file OSOption.cpp.

BranchingWeight ** OSOption::getIntegerVariableBranchingWeightsSparse ( )

Get the integer branching weights in sparse form.

get a list of branching weights for integer variables in sparse form

Returns: a vector of pointers to BranchingWeight objects that hold branching weights for (some of) the variables; a list of index/value pairs

Definition at line 3164 of file OSOption.cpp.

double * OSOption::getIntegerVariableBranchingWeightsDense ( )

Get the integer branching weights in dense form.

get a list of branching weights for integer variables in dense form

Returns: a vector of double that holds branching weights (or OSNaN()) for all the variables; an array of values

Note: return OSNaN() for variables that are not initialed

Definition at line 3190 of file OSOption.cpp.

double * OSOption::getIntegerVariableBranchingWeightsDense ( int numberOfVariables )

Get the integer branching weights in dense form.

get a list of branching weights for integer variables in dense form

Parameters

numberOfVariables holds the dimension of the vector

Returns: a vector of double that holds branching weights (or OSNaN()) for all the variables

Parameters

numberOfVariables is the dimension of the array

Returns: an array of values

Note: return OSNaN() for variables that are not initialed

Definition at line 3242 of file OSOption.cpp.

SOSWeights ** OSOption::getSOSVariableBranchingWeightsSparse ( )

Get the SOS branching weights in sparse form.

get a list of branching weights for SOS variables in sparse form

Returns: a vector of pointers to SOSWeights objects that hold branching weights for (some of) the variables contained in special ordered sets; a list of SOSWeights objects

Definition at line 3289 of file OSOption.cpp.

std::vector< OtherVariableOption * > OSOption::getOtherVariableOptions ( std::string solver_name )

Get the <other> variable options associated with a particular solver.

get the array of other variable options associated with a particular solver

Parameters

solver_name is the name of the solver whose options we want

Returns: a vector of pointers to OtherVariableOption objects that correspond to the solver named.

Parameters

solver_name is the name of the solver

Returns: an array of other variable options associated with this solver

Definition at line 3315 of file OSOption.cpp.

OtherVariableOption * OSOption::getOtherVariableOption ( int optionNumber )

Get one particular <other> variable option from the array of options.

Parameters

optionNumber is the index of the option in the array

Returns: a pointer to one OtherVariableOption object

Definition at line 3363 of file OSOption.cpp.

OtherVariableOption ** OSOption::getAllOtherVariableOptions ( )

Get all <other> variable options.

get the array of all other variable options

Returns: a pointer to an array of OtherVariableOption objects; an array of other variable options associated with this solver

Definition at line 3341 of file OSOption.cpp.

InitObjValue ** OSOption::getInitObjValuesSparse ( )

Get the initial values associated with the objectives in sparse form.

get the list of initial objective values in sparse form

Returns: a vector of pointers to InitObjValue objects that hold initial values for (some of) the objectives; a list of index/value pairs

Definition at line 3386 of file OSOption.cpp.

double * OSOption::getInitObjValuesDense ( )

Get the initial values associated with the objectives in dense form.

get the list of initial objective values in dense form

Returns: a vector of double that hold initial values (or OSNaN()) for all of the objectives; an array of values

Note: return OSNaN() for objectives that are not initialed

Definition at line 3411 of file OSOption.cpp.

double * OSOption::getInitObjValuesDense ( int numberOfObjectives )

Get the initial values associated with the objectives in dense form.

get the list of initial objective values in dense form

Parameters

numberOfObjectives holds the dimension of the vector

Returns: a vector of double that hold initial values (or OSNaN()) for all of the objectives

Parameters

numberOfObjectives is the dimension of the array

Returns: an array of values

Note: return OSNaN() for objectives that are not initialed

Definition at line 3464 of file OSOption.cpp.

InitObjBound ** OSOption::getInitObjBoundsSparse ( )

Get the initial bounds associated with the objectives in sparse form.

get the list of initial objective bounds in sparse form

Returns: a vector of pointers to InitObjBound objects that hold initial bounds for (some of) the objectives; a list of index/value/value triples

Definition at line 3513 of file OSOption.cpp.

double * OSOption::getInitObjLowerBoundsDense ( )

Get the initial lower bounds associated with the objectives in dense form.

get the list of initial objective lower bounds in dense form

Returns: a vector of double that hold initial lower bounds (or OSNaN()) for all of the objectives; an array of values

Note: return OSNaN() for objectives that are not initialed

Definition at line 3538 of file OSOption.cpp.

double * OSOption::getInitObjLowerBoundsDense ( int numberOfObjectives )

Get the initial lower bounds associated with the objectives in dense form.

get the list of initial objective lower bounds in dense form

Parameters

numberOfObjectives holds the dimension of the vector

Returns: a vector of double that hold initial lower bounds (or OSNaN()) for all of the objectives

Parameters

numberOfObjectives is the dimension of the array

Returns: an array of values

Note: return OSNaN() for objectives that are not initialed

Definition at line 3591 of file OSOption.cpp.

double * OSOption::getInitObjUpperBoundsDense ( )

Get the initial upper bounds associated with the objectives in dense form.

get the list of initial objective upper bounds in dense form

Returns: a vector of double that hold initial upper bounds (or OSNaN()) for all of the objectives; an array of values

Note: return OSNaN() for objectives that are not initialed

Definition at line 3641 of file OSOption.cpp.

double * OSOption::getInitObjUpperBoundsDense ( int numberOfObjectives )

Get the initial upper bounds associated with the objectives in dense form.

get the list of initial objective upper bounds in dense form

Parameters

numberOfObjectives holds the dimension of the vector

Returns: a vector of double that hold initial upper bounds (or OSNaN()) for all of the objectives

Parameters

numberOfObjectives is the dimension of the array

Returns: an array of values

Note: return OSNaN() for objectives that are not initialed

Definition at line 3694 of file OSOption.cpp.

int * OSOption::getObjectiveInitialBasisStatusDense ( int numberOfObjectives )

Get the initial basis status for all objectives in dense form.

get the basis status for all objectives in dense form

Returns: an array of int, with values corresponding to ENUM_BASIS_STATUS – see OSGeneral.h)

Note: returns ENUM_BASIS_STATUS_unknown for objectives that are not initialed

Parameters

numberOfObjectives is the dimension of the array

Returns: an array of int, with values corresponding to ENUM_BASIS_STATUS – see OSGeneral.g

Note: returns ENUM_BASIS_STATUS_unknown for objectives that are not initialed

Parameters

numberOfObjectives is the dimension of the array

Definition at line 3796 of file OSOption.cpp.

std::vector< OtherObjectiveOption * > OSOption::getOtherObjectiveOptions ( std::string solver_name )

Get the array of other objective options.

get the array of other objective options associated with a particular solver

Parameters

solver_name is the name of the solver whose options we want

Returns: a vector of pointers to OtherConstraintOption objects

Parameters

solver_name is the name of the solver

Returns: an array of other objective options associated with this solver

Definition at line 3905 of file OSOption.cpp.

OtherObjectiveOption * OSOption::getOtherObjectiveOption ( int optionNumber )

Get one particular <other> objective option from the array of options.

Parameters

optionNumber is the index of the option in the array

Returns: a pointer to one OtherObjectiveOption object

Definition at line 3934 of file OSOption.cpp.

OtherObjectiveOption ** OSOption::getAllOtherObjectiveOptions ( )

Get all <other> objective options.

get the array of all other objective options

Returns: a pointer to an array of OtherObjectiveOption objects; an array of other objective options associated with this solver

Definition at line 3957 of file OSOption.cpp.

InitConValue ** OSOption::getInitConValuesSparse ( )

Get the initial values associated with the constraints in sparse form.

get the list of initial constraint values in sparse form

Returns: a vector of pointers to InitConValue objects that hold initial values for (some of) the constraints; a list of index/value pairs

Definition at line 3977 of file OSOption.cpp.

double * OSOption::getInitConValuesDense ( )

Get the initial values associated with the constraints in dense form.

get the list of initial constraint values in dense form

Returns: a vector of double that hold initial values for all of the constraints; an array of values

Note: return OSNaN() for constraints that are not initialed

Definition at line 4002 of file OSOption.cpp.

double * OSOption::getInitConValuesDense ( int numberOfConstraints )

Get the initial values associated with the constraints in dense form.

get the list of initial constraint values in dense form

Parameters

numberOfConstraints holds the dimension of the vector

Returns: a vector of double that hold initial values for all of the constraints

Parameters

numberOfConstraints is the dimension of the array

Returns: an array of values

Note: return OSNaN() for constraints that are not initialed

Definition at line 4053 of file OSOption.cpp.

InitDualVarValue ** OSOption::getInitDualVarValuesSparse ( )

Get the initial bounds associated with the dual variables in sparse form.

get the list of initial dual variables in sparse form

Returns: a vector of pointers to InitDualVarValue objects that hold initial bounds for (some of) the dual variables; a list of index/value/value triples

Definition at line 4100 of file OSOption.cpp.

double * OSOption::getInitDualVarLowerBoundsDense ( )

Get the initial dual variables associated with the lower bounds in dense form.

get the list of initial dual variables associated with the lower bounds in dense form

Returns: a vector of double that hold initial lower bounds for all of the dual variables; an array of values

Note: return OSNaN() for dual variables that are not initialed

Definition at line 4125 of file OSOption.cpp.

double * OSOption::getInitDualVarLowerBoundsDense ( int numberOfConstraints )

Get the initial dual variables associated with the lower bounds in dense form.

get the list of initial dual variables associated with the lower bounds in dense form

Parameters

numberOfConstraints holds the dimension of the vector

Returns: a vector of double that hold initial lower bounds for all of the dual variables

Parameters

numberOfConstraints is the dimension of the array

Returns: an array of values

Note: return OSNaN() for dual variables that are not initialed

Definition at line 4178 of file OSOption.cpp.

double * OSOption::getInitDualVarUpperBoundsDense ( )

Get the initial dual variables associated with the upper bounds in dense form.

get the list of initial dual variables associated with the upper bounds in dense form

Returns: a vector of double that hold initial upper bounds for all of the dual variables; an array of values

Note: return OSNaN() for dual variables that are not initialed

Definition at line 4226 of file OSOption.cpp.

double * OSOption::getInitDualVarUpperBoundsDense ( int numberOfConstraints )

Get the initial dual variables associated with the upper bounds in dense form.

get the list of initial dual variables associated with the upper bounds in dense form

Parameters

numberOfConstraints holds the dimension of the vector

Returns: a vector of double that hold initial upper bounds for all of the dual variables

Parameters

numberOfConstraints is the dimension of the array

Returns: an array of values

Note: return OSNaN() for dual variables that are not initialed

Definition at line 4278 of file OSOption.cpp.

int * OSOption::getSlackVariableInitialBasisStatusDense ( int numberOfConstraints )

Get the initial basis status for all slack variables in dense form.

get the basis status for all slack variables in dense form

Returns: an array of int, with values corresponding to ENUM_BASIS_STATUS – see OSGeneral.h)

Note: returns ENUM_BASIS_STATUS_unknown for slack variables that are not initialed

Parameters

numberOfConstraints is the dimension of the array

Returns: an array of int, with values corresponding to ENUM_BASIS_STATUS – see OSGeneral.g

Note: returns ENUM_BASIS_STATUS_unknown for slackss that are not initialed

Parameters

numberOfConstraints is the dimension of the array

Definition at line 4329 of file OSOption.cpp.

std::vector< OtherConstraintOption * > OSOption::getOtherConstraintOptions ( std::string solver_name )

Get the array of other constraint options.

get the array of other constraint options associated with a particular solver

Parameters

solver_name is the name of the solver whose options we want

Returns: a vector of pointers to OtherConstraintOption objects

Parameters

solver_name is the name of the solver

Returns: an array of other constraint options associated with this solver

Definition at line 4435 of file OSOption.cpp.

OtherConstraintOption * OSOption::getOtherConstraintOption ( int optionNumber )

Get one particular <other> constraint option from the array of options.

Parameters

optionNumber is the index of the option in the array

Returns: a pointer to one OtherConstraintOption object

Definition at line 4483 of file OSOption.cpp.

OtherConstraintOption ** OSOption::getAllOtherConstraintOptions ( )

Get all <other> constraint options.

get the array of all other constraint options

Returns: a pointer to an array of OtherConstraintOption objects; an array of other constraint options associated with this solver

Definition at line 4461 of file OSOption.cpp.

std::vector< SolverOption * > OSOption::getSolverOptions ( std::string solver_name )

Get the options associated with a given solver.

get the array of solver options associated with a particular solver

Parameters

solver_name is the name of the solver whose options we want

Returns: a vector of pointers to SolverOption objects that correspond to the solver named.

Parameters

solver_name is the name of the solver

Returns: an array of solver options associated with this solver

Definition at line 4508 of file OSOption.cpp.

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)

get the array of solver options associated with a particular solver and the solver options not associated with any solver (if desired)

Parameters

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

Returns: a vector of pointers to SolverOption objects that correspond to the solver named.

Parameters

solver_name	is the name of the solver
getFreeOptions	is a boolean controlling whether unassociated (free) options should be returned or not

Returns: an array of solver options associated with this solver

Definition at line 4539 of file OSOption.cpp.

SolverOption ** OSOption::getAllSolverOptions ( )

Get all solver options.

get the array of all solver options

Returns: a pointer to an array SolverOption objects; an array of other constraint options associated with this solver

Definition at line 4567 of file OSOption.cpp.

bool OSOption::setServiceURI ( std::string serviceURI )

Set the serviceURI.

set() options in the <general> element

Definition at line 7540 of file OSOption.cpp.

bool OSOption::setServiceName ( std::string serviceName )

Set the service name.

Definition at line 7548 of file OSOption.cpp.

bool OSOption::setInstanceName ( std::string instanceName )

Set the instance name.

Definition at line 7559 of file OSOption.cpp.

bool OSOption::setInstanceLocation ( std::string instanceLocation )

Set the instance location.

Definition at line 7567 of file OSOption.cpp.

bool OSOption::setInstanceLocation	(	std::string	instanceLocation,
		std::string	locationType
	)

Alternative signature to set the instance location and location type simultaneously.

Definition at line 7577 of file OSOption.cpp.

bool OSOption::setInstanceLocationType ( std::string locationType )

Set the instance location type.

Definition at line 7591 of file OSOption.cpp.

bool OSOption::setJobID ( std::string jobID )

Set the job ID.

Definition at line 7613 of file OSOption.cpp.

bool OSOption::setSolverToInvoke ( std::string solverToInvoke )

Set the solver to be invoked.

Definition at line 7621 of file OSOption.cpp.

bool OSOption::setLicense ( std::string license )

Set the license information.

Definition at line 7629 of file OSOption.cpp.

bool OSOption::setUserName ( std::string userName )

Set the username.

Definition at line 7637 of file OSOption.cpp.

bool OSOption::setPassword ( std::string password )

Set the password.

Definition at line 7645 of file OSOption.cpp.

bool OSOption::setContact ( std::string contact )

Set the contact information.

Definition at line 7653 of file OSOption.cpp.

bool OSOption::setContact	(	std::string	contact,
		std::string	transportType
	)

Alternative signature to set the contact information and transport type simultaneously.

Definition at line 7663 of file OSOption.cpp.

bool OSOption::setContactTransportType ( std::string transportType )

Set the transport type for contact.

Definition at line 7677 of file OSOption.cpp.

bool OSOption::setOtherGeneralOptions	(	int	numberOfOptions,
		OtherOption **	other
	)

Set the other general options as an entire array.

Parameters

numberOfOptions	contains the number of other options to be set
other	is a pointer to an array of OtherOption objects

Definition at line 7699 of file OSOption.cpp.

bool OSOption::setAnOtherGeneralOption	(	std::string	name,
		std::string	value,
		std::string	description
	)

Add another general option to the <other> option array.

Parameters

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)

Definition at line 7716 of file OSOption.cpp.

bool OSOption::setMinDiskSpace	(	std::string	unit,
		std::string	description,
		double	value
	)

Set the minimum disk space required for the current job.

set() options in the <system> element

Parameters

unit	- select the unit (Kb, Mb, etc.)
description	- further description (can be used for documentation)
value	- number of units of disk space required

Definition at line 7731 of file OSOption.cpp.

bool OSOption::setMinDiskSpace ( double value )

Alternate signature to set only the number of units.

Definition at line 7746 of file OSOption.cpp.

bool OSOption::setMinDiskSpaceUnit ( std::string unit )

Definition at line 7756 of file OSOption.cpp.

bool OSOption::setMinMemorySize	(	std::string	unit,
		std::string	description,
		double	value
	)

Set the minimum memory size required for the current job.

Parameters

unit	- select the unit (Kb, Mb, etc.)
description	- further description (can be used for documentation)
value	- number of units of memory size required

Definition at line 7778 of file OSOption.cpp.

bool OSOption::setMinMemorySize ( double value )

Alternate signature to set only the number of units.

Definition at line 7793 of file OSOption.cpp.

bool OSOption::setMinMemoryUnit ( std::string unit )

Definition at line 7803 of file OSOption.cpp.

bool OSOption::setMinCPUSpeed	(	std::string	unit,
		std::string	description,
		double	value
	)

Set the minimum CPU speed required for the current job.

Parameters

unit	- select the unit (MHz, GHz, TFlops etc.)
description	- further description (can be used for documentation)
value	- number of units of CPU speed required

Definition at line 7835 of file OSOption.cpp.

bool OSOption::setMinCPUSpeed ( double value )

Alternate signature to set only the number of units.

Definition at line 7825 of file OSOption.cpp.

bool OSOption::setMinCPUSpeedUnit ( std::string unit )

Definition at line 7850 of file OSOption.cpp.

bool OSOption::setMinCPUNumber	(	int	number,
		std::string	description
	)

Set the minimum number of CPU cores required for the current job.

Parameters

number	- number of CPU cores required
description	- further description (can be used for documentation)

Definition at line 7882 of file OSOption.cpp.

bool OSOption::setMinCPUNumber ( int number )

Alternate signature to set only the number of cores.

Definition at line 7872 of file OSOption.cpp.

bool OSOption::setOtherSystemOptions	(	int	numberOfOptions,
		OtherOption **	other
	)

Definition at line 7893 of file OSOption.cpp.

bool OSOption::setAnOtherSystemOption	(	std::string	name,
		std::string	value,
		std::string	description
	)

Definition at line 7911 of file OSOption.cpp.

bool OSOption::setServiceType ( std::string serviceType )

set() options in the <service> element

Definition at line 7925 of file OSOption.cpp.

bool OSOption::setOtherServiceOptions	(	int	numberOfOptions,
		OtherOption **	other
	)

Definition at line 7945 of file OSOption.cpp.

bool OSOption::setAnOtherServiceOption	(	std::string	name,
		std::string	value,
		std::string	description
	)

Definition at line 7962 of file OSOption.cpp.

bool OSOption::setMaxTime	(	double	value,
		std::string	unit
	)

Definition at line 7985 of file OSOption.cpp.

bool OSOption::setMaxTime ( double value )

set() options in the <job> element

Definition at line 7975 of file OSOption.cpp.

bool OSOption::setMaxTimeUnit ( std::string unit )

Definition at line 8000 of file OSOption.cpp.

bool OSOption::setRequestedStartTime ( std::string time )

Definition at line 8022 of file OSOption.cpp.

bool OSOption::setJobDependencies	(	int	numberOfDependencies,
		std::string *	jobDependencies
	)

Definition at line 8031 of file OSOption.cpp.

bool OSOption::setAnotherJobDependency ( std::string jobID )

Definition at line 8043 of file OSOption.cpp.

bool OSOption::setRequiredDirectories	(	int	numberOfPaths,
		std::string *	paths
	)

Definition at line 8053 of file OSOption.cpp.

bool OSOption::setAnotherRequiredDirectory ( std::string path )

Definition at line 8065 of file OSOption.cpp.

bool OSOption::setRequiredFiles	(	int	numberOfPaths,
		std::string *	paths
	)

Definition at line 8075 of file OSOption.cpp.

bool OSOption::setAnotherRequiredFile ( std::string path )

Definition at line 8087 of file OSOption.cpp.

bool OSOption::setDirectoriesToMake	(	int	numberOfPaths,
		std::string *	paths
	)

Definition at line 8097 of file OSOption.cpp.

bool OSOption::setAnotherDirectoryToMake ( std::string path )

Definition at line 8109 of file OSOption.cpp.

bool OSOption::setFilesToMake	(	int	numberOfPaths,
		std::string *	paths
	)

Definition at line 8119 of file OSOption.cpp.

bool OSOption::setAnotherFileToMake ( std::string path )

Definition at line 8131 of file OSOption.cpp.

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

Parameters

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

Definition at line 8140 of file OSOption.cpp.

bool OSOption::setInputDirectoriesToMove	(	int	numberOfPathPairs,
		PathPair **	pathPair
	)

Definition at line 8178 of file OSOption.cpp.

bool OSOption::setAnotherInputDirectoryToMove	(	std::string	fromPath,
		std::string	toPath,
		bool	makeCopy
	)

Definition at line 8190 of file OSOption.cpp.

bool OSOption::setInputFilesToMove	(	int	numberOfPathPairs,
		PathPair **	pathPair
	)

Definition at line 8200 of file OSOption.cpp.

bool OSOption::setAnotherInputFileToMove	(	std::string	fromPath,
		std::string	toPath,
		bool	makeCopy
	)

Definition at line 8212 of file OSOption.cpp.

bool OSOption::setOutputFilesToMove	(	int	numberOfPathPairs,
		PathPair **	pathPair
	)

Definition at line 8222 of file OSOption.cpp.

bool OSOption::setAnotherOutputFileToMove	(	std::string	fromPath,
		std::string	toPath,
		bool	makeCopy
	)

Definition at line 8234 of file OSOption.cpp.

bool OSOption::setOutputDirectoriesToMove	(	int	numberOfPathPairs,
		PathPair **	pathPair
	)

Definition at line 8244 of file OSOption.cpp.

bool OSOption::setAnotherOutputDirectoryToMove	(	std::string	fromPath,
		std::string	toPath,
		bool	makeCopy
	)

Definition at line 8256 of file OSOption.cpp.

bool OSOption::setFilesToDelete	(	int	numberOfPaths,
		std::string *	paths
	)

Definition at line 8266 of file OSOption.cpp.

bool OSOption::setAnotherFileToDelete ( std::string path )

Definition at line 8278 of file OSOption.cpp.

bool OSOption::setDirectoriesToDelete	(	int	numberOfPaths,
		std::string *	paths
	)

Definition at line 8288 of file OSOption.cpp.

bool OSOption::setAnotherDirectoryToDelete ( std::string path )

Definition at line 8300 of file OSOption.cpp.

bool OSOption::setProcessesToKill	(	int	numberOfProcesses,
		std::string *	processes
	)

Definition at line 8310 of file OSOption.cpp.

bool OSOption::setAnotherProcessToKill ( std::string process )

Definition at line 8322 of file OSOption.cpp.

bool OSOption::setOtherJobOptions	(	int	numberOfOptions,
		OtherOption **	other
	)

Definition at line 8332 of file OSOption.cpp.

bool OSOption::setAnOtherJobOption	(	std::string	name,
		std::string	value,
		std::string	description
	)

Definition at line 8349 of file OSOption.cpp.

bool OSOption::setNumberOfVariables ( int numberOfVariables )

Definition at line 8360 of file OSOption.cpp.

bool OSOption::setNumberOfObjectives ( int numberOfObjectives )

Definition at line 8368 of file OSOption.cpp.

bool OSOption::setNumberOfConstraints ( int numberOfConstraints )

Definition at line 8376 of file OSOption.cpp.

bool OSOption::setInitVarValues	(	int	numberOfVar,
		int *	idx,
		double *	value,
		std::string *	name
	)

Definition at line 8385 of file OSOption.cpp.

bool OSOption::setInitVarValuesSparse	(	int	numberOfVar,
		InitVarValue **	var
	)

Definition at line 8399 of file OSOption.cpp.

bool OSOption::setInitVarValuesSparse	(	int	numberOfVar,
		InitVarValue **	var,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 8418 of file OSOption.cpp.

bool OSOption::setInitVarValuesDense	(	int	numberOfVar,
		double *	value
	)

Definition at line 8429 of file OSOption.cpp.

bool OSOption::setAnotherInitVarValue	(	int	idx,
		double	value
	)

Definition at line 8453 of file OSOption.cpp.

bool OSOption::setInitVarValuesString	(	int	numberOfVar,
		int *	idx,
		std::string *	value,
		std::string *	name
	)

Definition at line 8464 of file OSOption.cpp.

bool OSOption::setInitVarValuesStringSparse	(	int	numberOfVar,
		InitVarValueString **	var
	)

Definition at line 8478 of file OSOption.cpp.

bool OSOption::setInitVarValuesStringSparse	(	int	numberOfVar,
		InitVarValueString **	var,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 8499 of file OSOption.cpp.

bool OSOption::setInitVarValuesStringDense	(	int	numberOfVar,
		std::string *	value
	)

Definition at line 8510 of file OSOption.cpp.

bool OSOption::setAnotherInitVarValueString	(	int	idx,
		std::string	value
	)

Definition at line 8533 of file OSOption.cpp.

bool OSOption::setInitBasisStatus	(	int	object,
		int	status,
		int *	i,
		int	ni
	)

Definition at line 8544 of file OSOption.cpp.

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.

Parameters

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)

Definition at line 8595 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeights	(	int	numberOfVar,
		int *	idx,
		double *	value,
		std::string *	name
	)

Definition at line 8633 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeightsSparse	(	int	numberOfVar,
		BranchingWeight **	var
	)

Definition at line 8647 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeightsSparse	(	int	numberOfVar,
		BranchingWeight **	var,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 8666 of file OSOption.cpp.

bool OSOption::setIntegerVariableBranchingWeightsDense	(	int	numberOfVar,
		double *	value
	)

Definition at line 8677 of file OSOption.cpp.

bool OSOption::setAnotherIntegerVariableBranchingWeight	(	int	idx,
		double	value
	)

Definition at line 8700 of file OSOption.cpp.

bool OSOption::setSOSVariableBranchingWeights	(	int	numberOfSOS,
		SOSWeights **	sos
	)

Definition at line 8712 of file OSOption.cpp.

bool OSOption::setAnotherSOSVariableBranchingWeight	(	int	sosIdx,
		int	nvar,
		double	weight,
		int *	idx,
		double *	value,
		std::string *	name
	)

Definition at line 8731 of file OSOption.cpp.

bool OSOption::setNumberOfOtherVariableOptions ( int numberOfOther )

Definition at line 8742 of file OSOption.cpp.

bool OSOption::setOtherVariableOptions	(	int	numberOfVar,
		OtherVariableOption **	var
	)

Definition at line 8887 of file OSOption.cpp.

bool OSOption::setAnOtherVariableOption ( OtherVariableOption * varOption )

Definition at line 8904 of file OSOption.cpp.

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.

Parameters

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

Definition at line 8763 of file OSOption.cpp.

bool OSOption::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 <constraints> element.

Parameters

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

Definition at line 8804 of file OSOption.cpp.

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.

Parameters

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)

Definition at line 8863 of file OSOption.cpp.

bool OSOption::setInitObjValues	(	int	numberOfObj,
		int *	idx,
		double *	value,
		std::string *	name
	)

Definition at line 8913 of file OSOption.cpp.

bool OSOption::setInitObjValuesSparse	(	int	numberOfObj,
		InitObjValue **	obj
	)

Definition at line 8927 of file OSOption.cpp.

bool OSOption::setInitObjValuesSparse	(	int	numberOfObj,
		InitObjValue **	obj,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 8946 of file OSOption.cpp.

bool OSOption::setInitObjValuesDense	(	int	numberOfObj,
		double *	value
	)

Definition at line 8957 of file OSOption.cpp.

bool OSOption::setAnotherInitObjValue	(	int	idx,
		double	value
	)

Definition at line 8980 of file OSOption.cpp.

bool OSOption::setInitObjBounds	(	int	numberOfObj,
		int *	idx,
		double *	lbValue,
		double *	ubValue,
		std::string *	name
	)

Definition at line 8991 of file OSOption.cpp.

bool OSOption::setInitObjBoundsSparse	(	int	numberOfObj,
		InitObjBound **	obj
	)

Definition at line 9006 of file OSOption.cpp.

bool OSOption::setInitObjBoundsSparse	(	int	numberOfObj,
		InitObjBound **	obj,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 9025 of file OSOption.cpp.

bool OSOption::setInitObjBoundsDense	(	int	numberOfObj,
		double *	lb,
		double *	ub
	)

Definition at line 9036 of file OSOption.cpp.

bool OSOption::setAnotherInitObjBound	(	int	idx,
		double	lbValue,
		double	ubValue
	)

Definition at line 9058 of file OSOption.cpp.

bool OSOption::setNumberOfOtherObjectiveOptions ( int numberOfOther )

Definition at line 9092 of file OSOption.cpp.

bool OSOption::setOtherObjectiveOptions	(	int	numberOfObj,
		OtherObjectiveOption **	obj
	)

Definition at line 9152 of file OSOption.cpp.

bool OSOption::setAnOtherObjectiveOption ( OtherObjectiveOption * objOption )

Definition at line 9169 of file OSOption.cpp.

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.

Parameters

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

Definition at line 9112 of file OSOption.cpp.

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.

Parameters

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)

Definition at line 9069 of file OSOption.cpp.

bool OSOption::setInitConValues	(	int	numberOfCon,
		int *	idx,
		double *	value,
		std::string *	name
	)

Definition at line 9179 of file OSOption.cpp.

bool OSOption::setInitConValuesSparse	(	int	numberOfCon,
		InitConValue **	con
	)

Definition at line 9194 of file OSOption.cpp.

bool OSOption::setInitConValuesSparse	(	int	numberOfCon,
		InitConValue **	con,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 9213 of file OSOption.cpp.

bool OSOption::setInitConValuesDense	(	int	numberOfCon,
		double *	value
	)

Definition at line 9224 of file OSOption.cpp.

bool OSOption::setAnotherInitConValue	(	int	idx,
		double	value
	)

Definition at line 9247 of file OSOption.cpp.

bool OSOption::setInitDualValues	(	int	numberOfCon,
		int *	idx,
		double *	lbValue,
		double *	ubValue,
		std::string *	name
	)

Definition at line 9258 of file OSOption.cpp.

bool OSOption::setInitDualVarValuesSparse	(	int	numberOfCon,
		InitDualVarValue **	con
	)

Definition at line 9272 of file OSOption.cpp.

bool OSOption::setInitDualVarValuesSparse	(	int	numberOfCon,
		InitDualVarValue **	con,
		ENUM_COMBINE_ARRAYS	disp
	)

Definition at line 9291 of file OSOption.cpp.

bool OSOption::setInitDualVarValuesDense	(	int	numberOfCon,
		double *	lb,
		double *	ub
	)

Definition at line 9302 of file OSOption.cpp.

bool OSOption::setAnotherInitDualVarValue	(	int	idx,
		double	lbValue,
		double	ubValue
	)

Definition at line 9325 of file OSOption.cpp.

bool OSOption::setNumberOfOtherConstraintOptions ( int numberOfOther )

Definition at line 9336 of file OSOption.cpp.

bool OSOption::setOtherConstraintOptions	(	int	numberOfOptions,
		OtherConstraintOption **	other
	)

Definition at line 9421 of file OSOption.cpp.

bool OSOption::setAnOtherConstraintOption ( OtherConstraintOption * optionValue )

Definition at line 9438 of file OSOption.cpp.

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.

Parameters

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

Definition at line 9356 of file OSOption.cpp.

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.

Parameters

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)

Definition at line 9396 of file OSOption.cpp.

bool OSOption::setNumberOfSolverOptions ( int numberOfOptions )

Definition at line 9448 of file OSOption.cpp.

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.

Parameters

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)

Definition at line 9462 of file OSOption.cpp.

bool OSOption::setSolverOptions	(	int	numberOfSolverOptions,
		SolverOption **	solverOption
	)

Definition at line 9492 of file OSOption.cpp.

bool OSOption::setAnotherSolverOption	(	std::string	name,
		std::string	value,
		std::string	solver,
		std::string	category,
		std::string	type,
		std::string	description
	)

Definition at line 9509 of file OSOption.cpp.

bool OSOption::setOptionInt	(	std::string	optionName,
		int	optionValue
	)

Definition at line 9583 of file OSOption.cpp.

bool OSOption::setOptionStr	(	std::string	optionName,
		std::string	optionValue
	)

Definition at line 9520 of file OSOption.cpp.

bool OSOption::setOptionDbl	(	std::string	optionName,
		double	value
	)

Definition at line 9592 of file OSOption.cpp.

Member Data Documentation

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.

double* OSOption::m_mdInitVarValuesDense

private

m_mdInitVarValuesDense holds the initial variable values in dense form

Definition at line 3625 of file OSOption.h.

std::string* OSOption::m_mdInitVarValuesStringDense

private

m_mdInitVarValuesStringDense holds the initial values for string-valued variables

Definition at line 3630 of file OSOption.h.

int* OSOption::m_mdInitBasisStatusDense

private

m_mdInitBasisStatusDense holds the initial basis status in dense form

Definition at line 3635 of file OSOption.h.

double* OSOption::m_mdIntegerVariableBranchingWeightsDense

private

m_mdIntegerVariableBranchingWeightsDense holds the branching weights for integer variables

Definition at line 3640 of file OSOption.h.

double* OSOption::m_mdInitObjValuesDense

private

m_mdInitObjValuesDense holds initial objective values in dense form

Definition at line 3645 of file OSOption.h.

double* OSOption::m_mdInitObjLowerBoundsDense

private

m_mdInitObjLowerBoundsDense holds initial lower bounds for the objectives in dense form

Definition at line 3650 of file OSOption.h.

double* OSOption::m_mdInitObjUpperBoundsDense

private

m_mdInitObjUpperBoundsDense holds initial upper bounds for the objectives in dense form

Definition at line 3655 of file OSOption.h.

double* OSOption::m_mdInitConValuesDense

private

m_mdInitConValuesDense holds initial constraint values in dense form

Definition at line 3660 of file OSOption.h.

double* OSOption::m_mdInitDualVarLowerBoundsDense

private

m_mdInitDualVarLowerBoundsDense holds initial dual values for the lower bound of the constraints in dense form

Definition at line 3666 of file OSOption.h.

double* OSOption::m_mdInitDualVarUpperBoundsDense

private

m_mdInitDualVarUpperBoundsDense holds initial dual values for the upper bound of the constraints in dense form

Definition at line 3672 of file OSOption.h.

The documentation for this class was generated from the following files:

/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.h
/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSOption.cpp

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation