The Result Class. More...

#include <OSResult.h>

Collaboration diagram for OSResult:

Public Member Functions
	OSResult ()
	Default constructor. More...

	~OSResult ()
	Class destructor. More...

bool	setHeader (std::string name, std::string source, std::string fileCreator, std::string description, std::string licence)
	A function to populate an instance of the result header element. More...

bool	IsEqual (OSResult *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...

GeneralStatus *	getGeneralStatus ()
	Get the general status. More...

std::string	getGeneralStatusType ()
	Get the general status type, which can be: success, error, warning. More...

std::string	getGeneralStatusDescription ()
	Get the general status description. More...

int	getNumberOfGeneralSubstatuses ()
	Get the number of substatuses. More...

std::string	getGeneralSubstatusName (int i)
	Get the i_th general substatus name. More...

std::string	getGeneralSubstatusDescription (int i)
	Get the i_th general substatus description. More...

std::string	getGeneralMessage ()
	Get the general message. More...

std::string	getServiceName ()
	Get service name. More...

std::string	getServiceURI ()
	Get service uri. More...

std::string	getInstanceName ()
	Get instance name. More...

std::string	getJobID ()
	Get the job id. More...

std::string	getSolverInvoked ()
	Get the solver invoked. More...

std::string	getTimeStamp ()
	Get the time stamp. More...

int	getNumberOfOtherGeneralResults ()
	Get the number of other results in the <general> element. More...

std::string	getOtherGeneralResultName (int idx)
	Get the name of the i-th other result in the <general> element. More...

std::string	getOtherGeneralResultValue (int idx)

std::string	getOtherGeneralResultDescription (int idx)

std::string	getSystemInformation ()

std::string	getAvailableDiskSpaceUnit ()

std::string	getAvailableDiskSpaceDescription ()

double	getAvailableDiskSpaceValue ()

std::string	getAvailableMemoryUnit ()

std::string	getAvailableMemoryDescription ()

double	getAvailableMemoryValue ()

std::string	getAvailableCPUSpeedUnit ()

std::string	getAvailableCPUSpeedDescription ()

double	getAvailableCPUSpeedValue ()

std::string	getAvailableCPUNumberDescription ()

int	getAvailableCPUNumberValue ()

int	getNumberOfOtherSystemResults ()

std::string	getOtherSystemResultName (int idx)

std::string	getOtherSystemResultValue (int idx)

std::string	getOtherSystemResultDescription (int idx)

std::string	getCurrentState ()

int	getCurrentJobCount ()

int	getTotalJobsSoFar ()

std::string	getTimeServiceStarted ()

double	getServiceUtilization ()

int	getNumberOfOtherServiceResults ()

std::string	getOtherServiceResultName (int idx)

std::string	getOtherServiceResultValue (int idx)

std::string	getOtherServiceResultDescription (int idx)

std::string	getJobStatus ()

std::string	getJobSubmitTime ()

std::string	getScheduledStartTime ()

std::string	getActualStartTime ()

std::string	getJobEndTime ()

int	getTimeNumber ()
	Get the number of time measurements. More...

double	getTimeValue ()
	Get the time measurement. More...

int	getNumberOfTimes ()

std::string	getTimingInfoUnit (int idx)

std::string	getTimingInfoType (int idx)

std::string	getTimingInfoCategory (int idx)

std::string	getTimingInfoDescription (int idx)

double	getTimingInfoValue (int idx)

std::string	getUsedDiskSpaceUnit ()

std::string	getUsedDiskSpaceDescription ()

double	getUsedDiskSpaceValue ()

std::string	getUsedMemoryUnit ()

std::string	getUsedMemoryDescription ()

double	getUsedMemoryValue ()

std::string	getUsedCPUSpeedUnit ()

std::string	getUsedCPUSpeedDescription ()

double	getUsedCPUSpeedValue ()

std::string	getUsedCPUNumberDescription ()

int	getUsedCPUNumberValue ()

int	getNumberOfOtherJobResults ()

std::string	getOtherJobResultName (int idx)

std::string	getOtherJobResultValue (int idx)

std::string	getOtherJobResultDescription (int idx)

int	getVariableNumber ()
	Get variable number. More...

int	getObjectiveNumber ()
	Get objective number. More...

int	getConstraintNumber ()
	Get constraint number. More...

int	getSolutionNumber ()
	get the number of solutions. More...

OptimizationSolutionStatus *	getSolutionStatus (int solIdx)
	Get the [i]th optimization solution status, where i equals the given solution index. More...

std::string	getSolutionStatusType (int solIdx)
	Get the [i]th optimization solution status type, where i equals the given solution index. More...

std::string	getSolutionStatusDescription (int solIdx)
	Get the [i]th optimization solution status description, where i equals the given solution index. More...

int	getNumberOfSolutionSubstatuses (int solIdx)

std::string	getSolutionSubstatusType (int solIdx, int substatusIdx)

std::string	getSolutionSubstatusDescription (int solIdx, int substatusIdx)

int	getSolutionTargetObjectiveIdx (int solIdx)

std::string	getSolutionTargetObjectiveName (int solIdx)

bool	getSolutionWeightedObjectives (int solIdx)
	Get the [i]th optimization solution form of the objective. More...

std::string	getSolutionMessage (int solIdx)
	Get the [i]th optimization solution message, where i equals the given solution index. More...

int	getNumberOfPrimalVariableValues (int solIdx)

int	getNumberOfVarValues (int solIdx)

int	getVarValueIdx (int solIdx, int varIdx)

std::string	getVarValueName (int solIdx, int varIdx)

double	getVarValue (int solIdx, int varIdx)

std::vector< IndexValuePair * >	getOptimalPrimalVariableValues (int solIdx)
	Get one solution of optimal primal variable values. More...

int	getNumberOfVarValuesString (int solIdx)

int	getVarValueStringIdx (int solIdx, int varIdx)

std::string	getVarValueStringName (int solIdx, int varIdx)

std::string	getVarValueString (int solIdx, int varIdx)

int	getBasisStatusNumberOfEl (int solIdx, int object, int status)
	Get the number of indices that belong to a particular basis status. More...

int	getBasisStatusEl (int solIdx, int object, int status, int j)
	Get an entry in the array of indices that belong to a particular basis status. More...

int	getBasisInformationDense (int solIdx, int object, int *resultArray, int dim)
	Get the basis information associated with the variables, objectives or constraints for some solution. More...

int	getNumberOfOtherVariableResults (int solIdx)
	Get numberOfOtherVariableResult. More...

int	getAnOtherVariableResultNumberOfVar (int solIdx, int iOther)
	Get getAnOtherVariableResultNumberOfVar. More...

std::string	getOtherVariableResultName (int solIdx, int otherIdx)

std::string	getOtherVariableResultType (int solIdx, int otherIdx)

std::string	getOtherVariableResultValue (int solIdx, int otherIdx)

std::string	getOtherVariableResultDescription (int solIdx, int otherIdx)

int	getOtherVariableResultNumberOfVar (int solIdx, int otherIdx)

int	getOtherVariableResultNumberOfEnumerations (int solIdx, int otherIdx)

int	getOtherVariableResultVarIdx (int solIdx, int otherIdx, int varIdx)

std::string	getOtherVariableResultVar (int solIdx, int otherIdx, int varIdx)

std::string	getOtherVariableResultArrayType (int solIdx, int otherIdx)
	Get the type of values contained in the or <enumeration> array associated with an <other> result for some solution. More...

std::string	getOtherVariableResultEnumerationValue (int solIdx, int otherIdx, int enumIdx)
	Get the value of an enum associated with an <other> result for some solution. More...

std::string	getOtherVariableResultEnumerationDescription (int solIdx, int otherIdx, int enumIdx)
	Get the description of an enum associated with an <other> result for some solution. More...

int	getOtherVariableResultEnumerationNumberOfEl (int solIdx, int otherIdx, int enumIdx)
	Get the size of an enum associated with an <other> result for some solution. More...

int	getOtherVariableResultEnumerationEl (int solIdx, int otherIdx, int enumIdx, int j)
	Get one index of an enum associated with an <other> result for some solution. More...

int	getOtherVariableResultArrayDense (int solIdx, int otherIdx, std::string *resultArray, int dim)
	Get the values of a array or an <enumeration> associated with an <other> result for some solution. More...

int	getNumberOfObjValues (int solIdx)

int	getObjValueIdx (int solIdx, int objIdx)

std::string	getObjValueName (int solIdx, int objIdx)

double	getObjValue (int solIdx, int objIdx)

double	getOptimalObjValue (int objIdx, int solIdx)
	Get one solution's optimal objective value. More...

int	getNumberOfOtherObjectiveResults (int solIdx)

std::string	getOtherObjectiveResultName (int solIdx, int otherIdx)

std::string	getOtherObjectiveResultType (int solIdx, int otherIdx)

std::string	getOtherObjectiveResultValue (int solIdx, int otherIdx)

std::string	getOtherObjectiveResultDescription (int solIdx, int otherIdx)

int	getOtherObjectiveResultNumberOfObj (int solIdx, int otherIdx)

int	getOtherObjectiveResultNumberOfEnumerations (int solIdx, int otherIdx)

int	getOtherObjectiveResultObjIdx (int solIdx, int otherIdx, int objIdx)

std::string	getOtherObjectiveResultObj (int solIdx, int otherIdx, int objIdx)

std::string	getOtherObjectiveResultArrayType (int solIdx, int otherIdx)
	Get the type of values contained in the <obj> or <enumeration> array associated with an <other> result for some solution. More...

std::string	getOtherObjectiveResultEnumerationValue (int solIdx, int otherIdx, int enumIdx)
	Get the value of an enum associated with an <other> result for some solution. More...

std::string	getOtherObjectiveResultEnumerationDescription (int solIdx, int otherIdx, int enumIdx)
	Get the description of an enum associated with an <other> result for some solution. More...

int	getOtherObjectiveResultEnumerationNumberOfEl (int solIdx, int otherIdx, int enumIdx)
	Get the size of an enum associated with an <other> result for some solution. More...

int	getOtherObjectiveResultEnumerationEl (int solIdx, int otherIdx, int enumIdx, int j)
	Get one index of an enum associated with an <other> result for some solution. More...

int	getOtherObjectiveResultArrayDense (int solIdx, int otherIdx, std::string *resultArray, int dim)
	Get the values of an <obj> array or an <enumeration> associated with an <other> result for some solution. More...

int	getNumberOfDualValues (int solIdx)

int	getDualValueIdx (int solIdx, int conIdx)

std::string	getDualValueName (int solIdx, int objIdx)

double	getDualValue (int solIdx, int conIdx)

std::vector< IndexValuePair * >	getOptimalDualVariableValues (int solIdx)
	Get one solution of optimal dual variable values. More...

int	getNumberOfOtherConstraintResults (int solIdx)

std::string	getOtherConstraintResultName (int solIdx, int otherIdx)

std::string	getOtherConstraintResultType (int solIdx, int otherIdx)

std::string	getOtherConstraintResultValue (int solIdx, int otherIdx)

std::string	getOtherConstraintResultDescription (int solIdx, int otherIdx)

int	getOtherConstraintResultNumberOfCon (int solIdx, int otherIdx)

int	getOtherConstraintResultNumberOfEnumerations (int solIdx, int otherIdx)

int	getOtherConstraintResultConIdx (int solIdx, int otherIdx, int conIdx)

std::string	getOtherConstraintResultCon (int solIdx, int otherIdx, int conIdx)

std::string	getOtherConstraintResultArrayType (int solIdx, int otherIdx)
	Get the type of values contained in the <con> or <enumeration> array associated with an <other> result for some solution. More...

std::string	getOtherConstraintResultEnumerationValue (int solIdx, int otherIdx, int enumIdx)
	Get the value of an enum associated with an <other> result for some solution. More...

std::string	getOtherConstraintResultEnumerationDescription (int solIdx, int otherIdx, int enumIdx)
	Get the description of an enum associated with an <other> result for some solution. More...

int	getOtherConstraintResultEnumerationNumberOfEl (int solIdx, int otherIdx, int enumIdx)
	Get the size of an enum associated with an <other> result for some solution. More...

int	getOtherConstraintResultEnumerationEl (int solIdx, int otherIdx, int enumIdx, int j)
	Get one index of an enum associated with an <other> result for some solution. More...

int	getOtherConstraintResultArrayDense (int solIdx, int otherIdx, std::string *resultArray, int dim)
	Get the values of a <con> array or an <enumeration> associated with an <other> result for some solution. More...

int	getNumberOfOtherSolutionResults (int solIdx)

std::string	getOtherSolutionResultName (int solIdx, int otherIdx)

std::string	getOtherSolutionResultValue (int solIdx, int otherIdx)

std::string	getOtherSolutionResultCategory (int solIdx, int otherIdx)

std::string	getOtherSolutionResultDescription (int solIdx, int otherIdx)

int	getOtherSolutionResultNumberOfItems (int solIdx, int otherIdx)

std::string	getOtherSolutionResultItem (int solIdx, int otherIdx, int itemIdx)

int	getNumberOfSolverOutputs ()

std::string	getSolverOutputName (int otherIdx)

std::string	getSolverOutputCategory (int otherIdx)

std::string	getSolverOutputDescription (int otherIdx)

int	getSolverOutputNumberOfItems (int otherIdx)

std::string	getSolverOutputItem (int otherIdx, int itemIdx)

bool	setGeneralStatus (GeneralStatus *status)
	Set the general status. More...

bool	setGeneralStatusType (std::string type)
	Set the general status type, which can be: success, error, warning. More...

bool	setNumberOfGeneralSubstatuses (int num)
	Set the number of substatus elements. More...

bool	setGeneralStatusDescription (std::string description)
	Set the general status description. More...

bool	setGeneralSubstatusName (int idx, std::string name)
	Set the general substatus name. More...

bool	setGeneralSubstatusDescription (int idx, std::string description)
	Set the general substatus description. More...

bool	setGeneralMessage (std::string message)
	Set the general message. More...

bool	setServiceName (std::string serviceName)
	Set service name. More...

bool	setServiceURI (std::string serviceURI)
	Set service uri. More...

bool	setInstanceName (std::string instanceName)
	Set instance name. More...

bool	setJobID (std::string jobID)
	Set job id. More...

bool	setSolverInvoked (std::string solverInvoked)
	Set solver invoked. More...

bool	setTimeStamp (std::string timeStamp)
	Set time stamp. More...

bool	setNumberOfOtherGeneralResults (int num)
	Set number of other general results. More...

bool	setOtherGeneralResultName (int idx, std::string name)
	Set the general otherResult name. More...

bool	setOtherGeneralResultValue (int idx, std::string value)
	Set the general otherResult value. More...

bool	setOtherGeneralResultDescription (int idx, std::string description)
	Set the general otherResult description. More...

bool	setSystemInformation (std::string systemInformation)
	Set the system information. More...

bool	setAvailableDiskSpaceUnit (std::string unit)
	Set the unit in which available disk space is measured. More...

bool	setAvailableDiskSpaceDescription (std::string description)
	Set the description of available disk space. More...

bool	setAvailableDiskSpaceValue (double value)
	Set the amount of available disk space. More...

bool	setAvailableMemoryUnit (std::string unit)
	Set the unit in which available memory is measured. More...

bool	setAvailableMemoryDescription (std::string description)
	Set the description of available memory. More...

bool	setAvailableMemoryValue (double value)
	Set the amount of available memory. More...

bool	setAvailableCPUSpeedUnit (std::string unit)
	Set the unit in which available CPU speed is measured. More...

bool	setAvailableCPUSpeedDescription (std::string description)
	Set the description of available CPU speed. More...

bool	setAvailableCPUSpeedValue (double value)
	Set the available CPU speed. More...

bool	setAvailableCPUNumberDescription (std::string description)
	Set the description of available number of CPUs. More...

bool	setAvailableCPUNumberValue (int value)
	Set the available number of CPUs. More...

bool	setNumberOfOtherSystemResults (int num)
	Set number of other system results. More...

bool	setOtherSystemResultName (int idx, std::string name)
	Set the system otherResult name. More...

bool	setOtherSystemResultValue (int idx, std::string value)
	Set the system otherResult value. More...

bool	setOtherSystemResultDescription (int idx, std::string description)
	Set the system otherResult description. More...

bool	setCurrentState (std::string currentState)
	Set the current state of the service. More...

bool	setCurrentJobCount (int jobCount)
	Set the current job count. More...

bool	setTotalJobsSoFar (int number)
	Set the total number of jobs so far. More...

bool	setTimeServiceStarted (std::string startTime)
	Set the time the service was started. More...

bool	setServiceUtilization (double value)
	Set the service utilitzation. More...

bool	setNumberOfOtherServiceResults (int num)
	Set number of other service results. More...

bool	setOtherServiceResultName (int idx, std::string name)
	Set the service otherResult name. More...

bool	setOtherServiceResultValue (int idx, std::string value)
	Set the service otherResult value. More...

bool	setOtherServiceResultDescription (int idx, std::string description)
	Set the service otherResult description. More...

bool	setJobStatus (std::string status)
	Set the job status. More...

bool	setJobSubmitTime (std::string submitTime)
	Set the time when the job was submitted. More...

bool	setScheduledStartTime (std::string scheduledStartTime)
	Set the job's scheduled start time. More...

bool	setActualStartTime (std::string actualStartTime)
	Set the job's actual start time. More...

bool	setJobEndTime (std::string endTime)
	Set the time when the job finished. More...

bool	setTime (double time)
	Set time. More...

bool	addTimingInformation (std::string type, std::string category, std::string unit, std::string description, double value)
	Add timing information. More...

bool	setTimingInformation (int idx, std::string type, std::string category, std::string unit, std::string description, double value)
	Set timing information. More...

bool	setNumberOfTimes (int numberOfTimes)
	Set the number of time measurements and initial the time array. More...

bool	setTimeNumber (int timeNumber)
	Set the number of time measurements. More...

bool	setUsedDiskSpaceUnit (std::string unit)
	Set the unit in which used disk space is measured. More...

bool	setUsedDiskSpaceDescription (std::string description)
	Set the description of used disk space. More...

bool	setUsedDiskSpaceValue (double value)
	Set the amount of used disk space. More...

bool	setUsedMemoryUnit (std::string unit)
	Set the unit in which used memory is measured. More...

bool	setUsedMemoryDescription (std::string description)
	Set the description of used memory. More...

bool	setUsedMemoryValue (double value)
	Set the amount of used memory. More...

bool	setUsedCPUSpeedUnit (std::string unit)
	Set the unit in which used CPU speed is measured. More...

bool	setUsedCPUSpeedDescription (std::string description)
	Set the description of used CPU speed. More...

bool	setUsedCPUSpeedValue (double value)
	Set the used CPU speed. More...

bool	setUsedCPUNumberDescription (std::string description)
	Set the description of used number of CPUs. More...

bool	setUsedCPUNumberValue (int value)
	Set the used number of CPUs. More...

bool	setNumberOfOtherJobResults (int num)
	Set number of other job results. More...

bool	setOtherJobResultName (int idx, std::string name)
	Set the job otherResult name. More...

bool	setOtherJobResultValue (int idx, std::string value)
	Set the job otherResult value. More...

bool	setOtherJobResultDescription (int idx, std::string description)
	Set the job otherResult description. More...

bool	setVariableNumber (int variableNumber)
	Set the variable number. More...

bool	setObjectiveNumber (int objectiveNumber)
	Set the objective number. More...

bool	setConstraintNumber (int constraintNumber)
	Set the constraint number. More...

bool	setSolutionNumber (int number)
	set the number of solutions. More...

bool	setSolutionStatus (int solIdx, std::string type, std::string description)
	Set the [i]th optimization solution status, where i equals the given solution index. More...

bool	setSolutionStatusType (int solIdx, std::string type)
	Set the [i]th optimization solution status type. More...

bool	setNumberOfSolutionSubstatuses (int solIdx, int num)
	Set the [i]th optimization solution's number of substatus elements. More...

bool	setSolutionStatusDescription (int solIdx, std::string description)
	Set the [i]th optimization solution status description. More...

bool	setSolutionSubstatusType (int solIdx, int substatusIdx, std::string type)
	Set the solution substatus type. More...

bool	setSolutionSubstatusDescription (int solIdx, int substatusIdx, std::string description)
	Set the solution substatus description. More...

bool	setSolutionTargetObjectiveIdx (int solIdx, int objectiveIdx)
	Set the [i]th optimization solution's objective index, where i equals the given solution index. More...

bool	setSolutionTargetObjectiveName (int solIdx, std::string objectiveName)
	Set the [i]th optimization solution's objective name, where i equals the given solution index. More...

bool	setSolutionWeightedObjectives (int solIdx, bool weightedObjectives)
	Record whether the [i]th optimization solution uses weighted objectives, where i equals the given solution index. More...

bool	setSolutionMessage (int solIdx, std::string msg)
	Set the [i]th optimization solution's message, where i equals the given solution index. More...

bool	setNumberOfPrimalVariableValues (int solIdx, int n)
	Set the [i]th optimization solution's number of primal variable values, where i equals the given solution index. More...

bool	setPrimalVariableValuesSparse (int solIdx, std::vector< IndexValuePair * > x)
	Set the [i]th optimization solution's primal variable values, where i equals the given solution index. More...

bool	setPrimalVariableValuesDense (int solIdx, double *x)
	Set the [i]th optimization solution's primal variable values, where i equals the given solution index. More...

bool	setNumberOfVarValues (int solIdx, int numberOfVar)
	Set the number of primal variables to be given a value. More...

bool	setVarValue (int solIdx, int number, int idx, std::string name, double val)
	Set a primal variable value. More...

bool	setNumberOfVarValuesString (int solIdx, int numberOfVar)
	Set the number of string-valued primal variables to be given a value. More...

bool	setVarValueString (int solIdx, int number, int idx, std::string name, std::string str)
	Set a string-valued primal variable value. More...

bool	setBasisStatus (int solIdx, int object, int status, int *i, int ni)
	Set the basis status of a number of variables/constraints/objectives. More...

bool	setNumberOfOtherVariableResults (int solIdx, int numberOfOtherVariableResults)
	Set the [i]th optimization solution's other (non-standard/solver specific) variable-related results, where i equals the given solution index. More...

bool	setAnOtherVariableResultSparse (int solIdx, int otherIdx, std::string name, std::string value, std::string description, int idx, std::string s, int n)
	Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index. More...

bool	setAnOtherVariableResultSparse (int solIdx, int otherIdx, std::string name, std::string value, std::string description, int idx, std::string s, int n, std::string type, std::string varType, std::string enumType)
	Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index. More...

bool	setAnOtherVariableResultDense (int solIdx, int otherIdx, std::string name, std::string value, std::string description, std::string *s)
	Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index. More...

bool	setAnOtherVariableResultDense (int solIdx, int otherIdx, std::string name, std::string value, std::string description, std::string *s, std::string type, std::string varType, std::string enumType)
	Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index. More...

bool	setOtherVariableResultNumberOfVar (int solIdx, int otherIdx, int numberOfVar)
	Set the number of children of another (non-standard/solver specific) variable-related result, for the [i]th solution. More...

bool	setOtherVariableResultNumberOfEnumerations (int solIdx, int otherIdx, int numberOfEnumerations)
	Set the number of <enumeration> children of another (non-standard/solver specific) variable-related result, for the [i]th solution. More...

bool	setOtherVariableResultName (int solIdx, int otherIdx, std::string name)
	Set the name of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultType (int solIdx, int otherIdx, std::string type)
	Set the type of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultVarType (int solIdx, int otherIdx, std::string varType)
	Set the varType of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultEnumType (int solIdx, int otherIdx, std::string enumType)
	Set the enumType of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultValue (int solIdx, int otherIdx, std::string value)
	Set the value of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultDescription (int solIdx, int otherIdx, std::string description)
	Set the description of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultSolver (int solIdx, int otherIdx, std::string solver)
	Set the solver of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultCategory (int solIdx, int otherIdx, std::string category)
	Set the category of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultVarIdx (int solIdx, int otherIdx, int varIdx, int idx)
	Set the index of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultVarName (int solIdx, int otherIdx, int varIdx, std::string name)
	Set the name of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherVariableResultVar (int solIdx, int otherIdx, int varIdx, std::string value)
	Set the value of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherOptionOrResultEnumeration (int solIdx, int otherIdx, int object, int enumIdx, std::string value, std::string description, int *i, int ni)
	Set the value and corresponding indices of another (non-standard/solver specific) variable-related result, for the [k]th solution, where k equals the given solution index. More...

bool	setNumberOfOtherObjectiveResults (int solIdx, int numberOfOtherObjectiveResults)
	Set the [i]th optimization solution's other (non-standard/solver specific) objective-related results, where i equals the given solution index. More...

bool	setNumberOfObjValues (int solIdx, int numberOfObj)
	Set the number of objectives to be given a value. More...

bool	setNumberOfObjectiveValues (int solIdx, int n)
	Set the [i]th optimization solution's number of objective values, where i equals the given solution index. More...

bool	setObjectiveValuesSparse (int solIdx, std::vector< IndexValuePair * > x)
	Set the [i]th optimization solution's objective values, where i equals the given solution index. More...

bool	setObjectiveValuesDense (int solIdx, double *objectiveValues)
	Set the [i]th optimization solution's objective values, where i equals the given solution index. More...

bool	setObjValue (int solIdx, int number, int idx, std::string name, double val)
	Set an objective value. More...

bool	setOtherObjectiveResultNumberOfObj (int solIdx, int otherIdx, int numberOfObj)
	Set the number of <obj> children of another (non-standard/solver specific) objective-related result, for the [i]th solution. More...

bool	setOtherObjectiveResultNumberOfEnumerations (int solIdx, int otherIdx, int numberOfObj)
	Set the number of <enumeration> children of another (non-standard/solver specific) objective-related result, for the [i]th solution. More...

bool	setOtherObjectiveResultName (int solIdx, int otherIdx, std::string name)
	Set the name of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultType (int solIdx, int otherIdx, std::string type)
	Set the type of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultObjType (int solIdx, int otherIdx, std::string objType)
	Set the objType of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultEnumType (int solIdx, int otherIdx, std::string enumType)
	Set the enumType of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultValue (int solIdx, int otherIdx, std::string value)
	Set the value of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultDescription (int solIdx, int otherIdx, std::string description)
	Set the description of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultSolver (int solIdx, int otherIdx, std::string solver)
	Set the solver of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultCategory (int solIdx, int otherIdx, std::string category)
	Set the category of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultObjIdx (int solIdx, int otherIdx, int objIdx, int idx)
	Set the index of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultObjName (int solIdx, int otherIdx, int objIdx, std::string name)
	Set the name of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherObjectiveResultObj (int solIdx, int otherIdx, int objIdx, std::string value)
	Set the value of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setNumberOfOtherConstraintResults (int solIdx, int numberOfOtherConstraintResults)
	Set the [i]th optimization solution's other (non-standard/solver specific) constraint-related results, where i equals the given solution index. More...

bool	setNumberOfDualValues (int solIdx, int numberOfCon)
	Set the number of constraints to be given a value. More...

bool	setNumberOfDualVariableValues (int solIdx, int n)
	Set the [i]th optimization solution's number of dual variable values, where i equals the given solution index. More...

bool	setDualVariableValuesSparse (int solIdx, std::vector< IndexValuePair * > x)
	Set the [i]th optimization solution's dual variable values, where i equals the given solution index. More...

bool	setDualVariableValuesDense (int solIdx, double *y)
	Set the [i]th optimization solution's dual variable values, where i equals the given solution index. More...

bool	setConstraintValuesDense (int solIdx, double *constraintValues)
	Set the [i]th optimization solution's constraint values, where i equals the given solution index. More...

bool	setDualValue (int solIdx, int number, int idx, std::string name, double val)
	Set a dual value. More...

bool	setOtherConstraintResultNumberOfCon (int solIdx, int otherIdx, int numberOfCon)
	Set the number of <con> children of another (non-standard/solver specific) constraint-related result, for the [i]th solution. More...

bool	setOtherConstraintResultNumberOfEnumerations (int solIdx, int otherIdx, int numberOfCon)
	Set the number of <enumeration> children of another (non-standard/solver specific) constraint-related result, for the [i]th solution. More...

bool	setOtherConstraintResultName (int solIdx, int otherIdx, std::string name)
	Set the name of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultType (int solIdx, int otherIdx, std::string type)
	Set the type of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultConType (int solIdx, int otherIdx, std::string conType)
	Set the conType of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultEnumType (int solIdx, int otherIdx, std::string enumType)
	Set the enumType of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultValue (int solIdx, int otherIdx, std::string value)
	Set the value of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultDescription (int solIdx, int otherIdx, std::string description)
	Set the description of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultSolver (int solIdx, int otherIdx, std::string solver)
	Set the solver of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultCategory (int solIdx, int otherIdx, std::string category)
	Set the category of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultConIdx (int solIdx, int otherIdx, int conIdx, int idx)
	Set the index of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultConName (int solIdx, int otherIdx, int conIdx, std::string name)
	Set the name of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setOtherConstraintResultCon (int solIdx, int otherIdx, int conIdx, std::string value)
	Set the value of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index. More...

bool	setMatrixVariableSolution (int solIdx, int numberOfMatrixVar_, int numberOfOtherMatrixVariableResults_)
	Set the [i]th optimization solution's MatrixVariableSolution, where i equals the given solution index. More...

bool	setMatrixVarValuesAttributes (int solIdx, int idx, int matrixVarIdx, int numberOfRows, int numberOfColumns, ENUM_MATRIX_SYMMETRY symmetry=ENUM_MATRIX_SYMMETRY_none, ENUM_MATRIX_TYPE type=ENUM_MATRIX_TYPE_unknown, std::string name="")
	A method to set general attributes for a matrixVar in the [i]th optimization solution, where i equals the given solution index. More...

bool	setMatrixVarValuesBlockStructure (int solIdx, int idx, int colOffset, int colOffsetSize, int rowOffset, int rowOffsetSize, int numberOfBlocks, int blocksConstructorIdx=0)
	A method to set the block structure for the values of a matrixVar in the [i]th optimization solution, where i equals the given solution index. More...

bool	setMatrixVarValuesBlockElements (int solIdx, int idx, int blkno, int blkRowIdx, int blkColIdx, int nz, int start, int index, MatrixElementValues *value, ENUM_MATRIX_TYPE valueType, ENUM_MATRIX_SYMMETRY symmetry=ENUM_MATRIX_SYMMETRY_none, bool rowMajor=false)
	A method to set the elements within a block of a matrixVar in the [i]th optimization solution, where i equals the given solution index. More...

bool	setMatrixVariablesOtherResultGeneralAttributes (int solIdx, int idx, std::string name, std::string description, std::string value, std::string type, std::string solver, std::string category, int numberOfMatrixVar=0, std::string matrixType="", int numberOfEnumerations=0, std::string enumType="")
	A method to set general attributes for another (non-standard/solver specific) result associated with the matrix variables in the [i]th optimization solution, where i equals the given solution index. More...

bool	setMatrixVariablesOtherResultMatrixAttributes (int solIdx, int otherIdx, int matrixVarIdx, int numberOfRows, int numberOfColumns, ENUM_MATRIX_SYMMETRY symmetry=ENUM_MATRIX_SYMMETRY_none, ENUM_MATRIX_TYPE type=ENUM_MATRIX_TYPE_unknown, std::string name="")
	A method to set attributes for a matrixVar in the [j]th other result associated with matrix variables in the the [i]th optimization solution, where i equals the given solution index and j equals a given other result index. More...

bool	setMatrixVariablesOtherResultBlockStructure (int solIdx, int otherIdx, int matrixVarIdx, int colOffset, int colOffsetSize, int rowOffset, int rowOffsetSize, int numberOfBlocks, int blocksConstructorIdx=0)
	A method to set the block structure for the values of a matrixVar associated with the [j]th "other" result of the [i]th optimization solution, where i equals the given solution index, and j equals the index of the other result. More...

bool	setMatrixVariablesOtherResultBlockElements (int solIdx, int otherIdx, int matrixVarIdx, int blkno, int blkRowIdx, int blkColIdx, int nz, int start, int index, MatrixElementValues *value, ENUM_MATRIX_TYPE valueType, ENUM_MATRIX_SYMMETRY symmetry=ENUM_MATRIX_SYMMETRY_none, bool rowMajor=false)
	A method to set the elements within a block of a matrixVar associated with the [j]th "other" result in the [i]th optimization solution, where i equals the given solution index and j equals the index of the other result. More...

bool	setNumberOfOtherSolutionResults (int solIdx, int numberOfOtherSolutionResults)
	Set the [i]th optimization solution's other (non-standard/solver specific) solution-related results, where i equals the given solution index. More...

bool	setOtherSolutionResultName (int solIdx, int otherIdx, std::string name)
	Set the name associated with the [j]th other solution result of solution [i]. More...

bool	setOtherSolutionResultValue (int solIdx, int otherIdx, std::string value)
	Set the value associated with the [j]th other solution result of solution [i]. More...

bool	setOtherSolutionResultCategory (int solIdx, int otherIdx, std::string category)
	Set the category associated with the [j]th other solution result of solution [i]. More...

bool	setOtherSolutionResultDescription (int solIdx, int otherIdx, std::string description)
	Set the description associated with the [j]th other solution result of solution [i]. More...

bool	setOtherSolutionResultNumberOfItems (int solIdx, int otherIdx, int numberOfItems)
	Set the number of items associated with the [j]th other solution result of solution [i]. More...

bool	setOtherSolutionResultItem (int solIdx, int otherIdx, int itemIdx, std::string item)
	Set one item associated with the [j]th other solution result of solution [i]. More...

bool	setAnOtherSolutionResult (int solIdx, std::string name, std::string value, std::string category, std::string description, int numberOfItems, std::string *item)
	Set another solution result of solution [i]. More...

bool	setNumberOfSolverOutputs (int numberOfSolverOutputs)
	Set the number of other solver outputs. More...

bool	setSolverOutputName (int otherIdx, std::string name)
	Set the name associated with the [j]th solver output. More...

bool	setSolverOutputCategory (int otherIdx, std::string category)
	Set the category associated with the [j]th solver output. More...

bool	setSolverOutputDescription (int otherIdx, std::string description)
	Set the description associated with the [j]th solver output. More...

bool	setSolverOutputNumberOfItems (int otherIdx, int numberOfItems)
	Set the number of items associated with the [j]th solver output. More...

bool	setSolverOutputItem (int otherIdx, int itemIdx, std::string item)
	Set one item associated with the [j]th solver output. More...

	OSResult ()
	Default constructor. More...

	~OSResult ()
	Class destructor. More...

GeneralStatus *	getGeneralStatus ()
	Get the general status. More...

std::string	getGeneralStatusType ()
	Get the general status type, which can be: success, error, warning. More...

std::string	getGeneralStatusDescription ()
	Get the general status description. More...

std::string	getServiceName ()
	Get service name. More...

std::string	getServiceURI ()
	Get service uri. More...

std::string	getInstanceName ()
	Get instance name. More...

std::string	getJobID ()
	Get the job id. More...

std::string	getGeneralMessage ()
	Get the general message. More...

int	getTimeNumber ()
	Get the number of time measurements. More...

double	getTimeValue ()
	Get the time measurement. More...

double *	getOptimalPrimalVariableValues (int objIdx)
	Get one solution of optimal primal variable values. More...

double *	getOptimalDualVariableValues (int objIdx)
	Get one solution of optimal dual variable values. More...

OptimizationSolutionStatus *	getSolutionStatus (int solIdx)
	Get the [i]th optimization solution status, where i equals the given solution index. More...

std::string	getSolutionStatusType (int solIdx)
	Get the [i]th optimization solution status type, where i equals the given solution index. More...

std::string	getSolutionStatusDescription (int solIdx)
	Get the [i]th optimization solution status description, where i equals the given solution index. More...

std::string	getSolutionMessage (int solIdx)
	Get the [i]th optimization solution message, where i equals the given solution index. More...

int	getVariableNumber ()
	Get variable number. More...

int	getObjectiveNumber ()
	Get objective number. More...

int	getConstraintNumber ()
	Get constraint number. More...

int	getSolutionNumber ()
	get the number of solutions. More...

int	getNumberOfOtherVariableResults (int solIdx)
	Get numberOfOtherVariableResult. More...

bool	setGeneralStatus (GeneralStatus *status)
	Set the general status. More...

bool	setGeneralStatusType (std::string type)
	Set the general status type, which can be: success, error, warning. More...

bool	setGeneralStatusDescription (std::string description)
	Set the general status description. More...

bool	setGeneralMessage (std::string message)
	Set the general message. More...

bool	setServiceName (std::string serviceName)
	Set service name. More...

bool	setServiceURI (std::string serviceURI)
	Set service uri. More...

bool	setInstanceName (std::string instanceName)
	Set instance name. More...

bool	setJobID (std::string jobID)
	Set job id. More...

bool	setTime (double time)
	Set time. More...

bool	addTimingInformation (std::string type, std::string category, std::string unit, std::string description, double value)
	Add timing information. More...

bool	setTimeNumber (int timeNumber)
	Set the number of time measurements. More...

bool	setVariableNumber (int variableNumber)
	Set the variable number. More...

bool	setObjectiveNumber (int objectiveNumber)
	Set the objective number. More...

bool	setConstraintNumber (int constraintNumber)
	Set the constraint number. More...

bool	setSolutionNumber (int number)
	set the number of solutions. More...

bool	setSolutionStatus (int solIdx, std::string type, std::string description)
	Set the [i]th optimization solution status, where i equals the given solution index. More...

bool	setSolutionObjectiveIndex (int solIdx, int objectiveIdx)
	Set the [i]th optimization solution's objective index, where i equals the given solution index. More...

bool	setNumberOfPrimalVariableValues (int solIdx, int n)
	Set the [i]th optimization solution's number of primal variable values, where i equals the given solution index. More...

bool	setPrimalVariableValues (int solIdx, double *x, int n)
	Set the [i]th optimization solution's primal variable values, where i equals the given solution index. More...

bool	setNumberOfOtherVariableResults (int solIdx, int numberOfOtherVariableResults)
	Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index. More...

bool	setAnOtherVariableResult (int solIdx, int otherIdx, std::string name, std::string description, int indexes, std::string s, int n)
	Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index. More...

bool	setObjectiveValues (int solIdx, double *objectiveValues, int n)
	Set the [i]th optimization solution's objective values, where i equals the given solution index. More...

bool	setDualVariableValues (int solIdx, double lbValues, double ubValues, int n)
	Set the [i]th optimization solution's dual variable values, where i equals the given solution index. More...

bool	setDualVariableValues (int solIdx, double *y, int n)
	Set the [i]th optimization solution's dual variable values, where i equals the given solution index. More...

bool	setConstraintValues (int solIdx, double *constraintValues, int n)
	Set the [i]th optimization solution's constraint values, where i equals the given solution index. More...

Public Attributes
GeneralFileHeader *	resultHeader
	header information More...

GeneralResult *	general
	general holds the first child of the OSResult specified by the OSrL Schema. More...

SystemResult *	system
	system holds the second child of the OSResult specified by the OSrL Schema. More...

ServiceResult *	service
	service holds the third child of the OSResult specified by the OSrL Schema. More...

JobResult *	job
	job holds the fourth child of the OSResult specified by the OSrL Schema. More...

OptimizationResult *	optimization
	optimization holds the fifth child of the OSResult specified by the OSrL Schema. More...

int	m_iVariableNumber
	m_iVariableNumber holds the variable number. More...

int	m_iObjectiveNumber
	m_iObjectiveNumber holds the objective number. More...

int	m_iConstraintNumber
	m_iConstraintNumber holds the constraint number. More...

int	m_iNumberOfOtherVariableResults
	m_iNumberOfOtherVariableResults holds the number of OtherVariableResult objects. More...

double *	m_mdPrimalValues
	m_mdPrimalValues a vector of primal variables. More...

double *	m_mdDualValues
	m_mdDualValues a vector of dual variables. More...

std::vector< IndexValuePair * >	primalVals

std::vector< IndexValuePair * >	dualVals

Detailed Description

The Result Class.

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

Version: 1.0, 03/14/2004

Since: OS 1.0

Remarks: A class for holding all the solution information.

Definition at line 2548 of file OSResult.h.

Constructor & Destructor Documentation

OSResult::OSResult ( )

Default constructor.

Definition at line 1382 of file OSResult.cpp.

OSResult::~OSResult ( )

Class destructor.

Definition at line 1402 of file OSResult.cpp.

OSResult::OSResult ( )

Default constructor.

OSResult::~OSResult ( )

Class destructor.

Member Function Documentation

bool OSResult::setHeader	(	std::string	name,
		std::string	source,
		std::string	fileCreator,
		std::string	description,
		std::string	licence
	)

A function to populate an instance of the result header element.

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 4052 of file OSResult.cpp.

bool OSResult::IsEqual ( OSResult * that )

A function to check for the equality of two objects.

Definition at line 7485 of file OSResult.cpp.

bool OSResult::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 9698 of file OSResult.cpp.

GeneralStatus * OSResult::getGeneralStatus ( )

Get the general status.

Returns: the general status.

Definition at line 1473 of file OSResult.cpp.

string OSResult::getGeneralStatusType ( )

Get the general status type, which can be: success, error, warning.

Returns: the general status type, null if none.

Definition at line 1479 of file OSResult.cpp.

string OSResult::getGeneralStatusDescription ( )

Get the general status description.

Returns: the general status description, null or empty std::string if none.

Definition at line 1486 of file OSResult.cpp.

int OSResult::getNumberOfGeneralSubstatuses ( )

Get the number of substatuses.

Returns: the number of substatuses, -1 if general status does not exist.

Definition at line 1493 of file OSResult.cpp.

string OSResult::getGeneralSubstatusName ( int i )

Get the i_th general substatus name.

Parameters

i	the number of the substatus (must be between 0 and numberOfSubstatuses)

Returns: the general substatus name, null if none.

Definition at line 1500 of file OSResult.cpp.

string OSResult::getGeneralSubstatusDescription ( int i )

Get the i_th general substatus description.

Parameters

i	the number of the substatus (must be between 0 and numberOfSubstatuses)

Returns: the general substatus description, null or empty std::string if none.

Definition at line 1510 of file OSResult.cpp.

string OSResult::getGeneralMessage ( )

Get the general message.

Returns: the general message.

Definition at line 1520 of file OSResult.cpp.

string OSResult::getServiceName ( )

Get service name.

Returns: the service name.

Definition at line 1526 of file OSResult.cpp.

string OSResult::getServiceURI ( )

Get service uri.

Returns: the service uri.

Definition at line 1532 of file OSResult.cpp.

string OSResult::getInstanceName ( )

Get instance name.

Returns: the instance name.

Definition at line 1538 of file OSResult.cpp.

string OSResult::getJobID ( )

Get the job id.

Returns: the job id.

Definition at line 1544 of file OSResult.cpp.

string OSResult::getSolverInvoked ( )

Get the solver invoked.

Returns: the solver invoked.

Definition at line 1550 of file OSResult.cpp.

string OSResult::getTimeStamp ( )

Get the time stamp.

Returns: the time stamp.

Definition at line 1556 of file OSResult.cpp.

int OSResult::getNumberOfOtherGeneralResults ( )

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

Returns: the number of other <general> results.

Definition at line 1562 of file OSResult.cpp.

string OSResult::getOtherGeneralResultName ( int idx )

Get the name of the i-th other result in the <general> element.

Parameters

i	holds the number of the result whose name is saught.

Returns: the name of the other <general> result.

Definition at line 1569 of file OSResult.cpp.

string OSResult::getOtherGeneralResultValue ( int idx )

Definition at line 1579 of file OSResult.cpp.

string OSResult::getOtherGeneralResultDescription ( int idx )

Definition at line 1589 of file OSResult.cpp.

string OSResult::getSystemInformation ( )

Definition at line 1599 of file OSResult.cpp.

string OSResult::getAvailableDiskSpaceUnit ( )

Definition at line 1605 of file OSResult.cpp.

string OSResult::getAvailableDiskSpaceDescription ( )

Definition at line 1612 of file OSResult.cpp.

double OSResult::getAvailableDiskSpaceValue ( )

Definition at line 1619 of file OSResult.cpp.

string OSResult::getAvailableMemoryUnit ( )

Definition at line 1626 of file OSResult.cpp.

string OSResult::getAvailableMemoryDescription ( )

Definition at line 1633 of file OSResult.cpp.

double OSResult::getAvailableMemoryValue ( )

Definition at line 1640 of file OSResult.cpp.

string OSResult::getAvailableCPUSpeedUnit ( )

Definition at line 1647 of file OSResult.cpp.

string OSResult::getAvailableCPUSpeedDescription ( )

Definition at line 1654 of file OSResult.cpp.

double OSResult::getAvailableCPUSpeedValue ( )

Definition at line 1661 of file OSResult.cpp.

string OSResult::getAvailableCPUNumberDescription ( )

Definition at line 1668 of file OSResult.cpp.

int OSResult::getAvailableCPUNumberValue ( )

Definition at line 1675 of file OSResult.cpp.

int OSResult::getNumberOfOtherSystemResults ( )

Definition at line 1682 of file OSResult.cpp.

string OSResult::getOtherSystemResultName ( int idx )

Definition at line 1689 of file OSResult.cpp.

string OSResult::getOtherSystemResultValue ( int idx )

Definition at line 1699 of file OSResult.cpp.

string OSResult::getOtherSystemResultDescription ( int idx )

Definition at line 1709 of file OSResult.cpp.

string OSResult::getCurrentState ( )

Definition at line 1719 of file OSResult.cpp.

int OSResult::getCurrentJobCount ( )

Definition at line 1725 of file OSResult.cpp.

int OSResult::getTotalJobsSoFar ( )

Definition at line 1731 of file OSResult.cpp.

string OSResult::getTimeServiceStarted ( )

Definition at line 1737 of file OSResult.cpp.

double OSResult::getServiceUtilization ( )

Definition at line 1743 of file OSResult.cpp.

int OSResult::getNumberOfOtherServiceResults ( )

Definition at line 1749 of file OSResult.cpp.

string OSResult::getOtherServiceResultName ( int idx )

Definition at line 1756 of file OSResult.cpp.

string OSResult::getOtherServiceResultValue ( int idx )

Definition at line 1766 of file OSResult.cpp.

string OSResult::getOtherServiceResultDescription ( int idx )

Definition at line 1776 of file OSResult.cpp.

string OSResult::getJobStatus ( )

Definition at line 1786 of file OSResult.cpp.

string OSResult::getJobSubmitTime ( )

Definition at line 1792 of file OSResult.cpp.

string OSResult::getScheduledStartTime ( )

Definition at line 1798 of file OSResult.cpp.

string OSResult::getActualStartTime ( )

Definition at line 1804 of file OSResult.cpp.

string OSResult::getJobEndTime ( )

Definition at line 1810 of file OSResult.cpp.

int OSResult::getTimeNumber ( )

Get the number of time measurements.

Returns: the number of time measurements

Definition at line 1995 of file OSResult.cpp.

double OSResult::getTimeValue ( )

Get the time measurement.

In the first instance, assume that there is only a single measure, which is the total elapsed time in seconds

Returns: the time measurement

Definition at line 1987 of file OSResult.cpp.

int OSResult::getNumberOfTimes ( )

Definition at line 1816 of file OSResult.cpp.

string OSResult::getTimingInfoUnit ( int idx )

Definition at line 1823 of file OSResult.cpp.

string OSResult::getTimingInfoType ( int idx )

Definition at line 1833 of file OSResult.cpp.

string OSResult::getTimingInfoCategory ( int idx )

Definition at line 1843 of file OSResult.cpp.

string OSResult::getTimingInfoDescription ( int idx )

Definition at line 1853 of file OSResult.cpp.

double OSResult::getTimingInfoValue ( int idx )

Definition at line 1863 of file OSResult.cpp.

string OSResult::getUsedDiskSpaceUnit ( )

Definition at line 1873 of file OSResult.cpp.

string OSResult::getUsedDiskSpaceDescription ( )

Definition at line 1880 of file OSResult.cpp.

double OSResult::getUsedDiskSpaceValue ( )

Definition at line 1887 of file OSResult.cpp.

string OSResult::getUsedMemoryUnit ( )

Definition at line 1894 of file OSResult.cpp.

string OSResult::getUsedMemoryDescription ( )

Definition at line 1901 of file OSResult.cpp.

double OSResult::getUsedMemoryValue ( )

Definition at line 1908 of file OSResult.cpp.

string OSResult::getUsedCPUSpeedUnit ( )

Definition at line 1915 of file OSResult.cpp.

string OSResult::getUsedCPUSpeedDescription ( )

Definition at line 1922 of file OSResult.cpp.

double OSResult::getUsedCPUSpeedValue ( )

Definition at line 1929 of file OSResult.cpp.

string OSResult::getUsedCPUNumberDescription ( )

Definition at line 1936 of file OSResult.cpp.

int OSResult::getUsedCPUNumberValue ( )

Definition at line 1943 of file OSResult.cpp.

int OSResult::getNumberOfOtherJobResults ( )

Definition at line 1950 of file OSResult.cpp.

string OSResult::getOtherJobResultName ( int idx )

Definition at line 1957 of file OSResult.cpp.

string OSResult::getOtherJobResultValue ( int idx )

Definition at line 1967 of file OSResult.cpp.

string OSResult::getOtherJobResultDescription ( int idx )

Definition at line 1977 of file OSResult.cpp.

int OSResult::getVariableNumber ( )

Get variable number.

Returns: variable number, -1 if no information.

Definition at line 2003 of file OSResult.cpp.

int OSResult::getObjectiveNumber ( )

Get objective number.

Returns: objective number, -1 if no information.

Definition at line 2013 of file OSResult.cpp.

int OSResult::getConstraintNumber ( )

Get constraint number.

Returns: constraint number, -1 if no information.

Definition at line 2023 of file OSResult.cpp.

int OSResult::getSolutionNumber ( )

get the number of solutions.

Returns: the number of solutions, 0 if none.

Definition at line 2033 of file OSResult.cpp.

OptimizationSolutionStatus * OSResult::getSolutionStatus ( int solIdx )

Get the [i]th optimization solution status, where i equals the given solution index.

The solution status includes the status type, optional descriptions and possibly substatuses.

Parameters

solIdx holds the solution index to get the solution status.

Returns: the optimization solution status that corresponds to solIdx, null if none.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OptimizationSolutionStatus

Definition at line 2041 of file OSResult.cpp.

string OSResult::getSolutionStatusType ( int solIdx )

Get the [i]th optimization solution status type, where i equals the given solution index.

The solution status type can be: unbounded, globallyOptimal, locallyOptimal, optimal, bestSoFar, feasible, infeasible, stoppedByLimit, unsure, error, other

Parameters

solIdx holds the solution index to get the solution status type.

Returns: the optimization solution status type that corresponds to solIdx, null or empty std::string if none.

Definition at line 2051 of file OSResult.cpp.

string OSResult::getSolutionStatusDescription ( int solIdx )

Get the [i]th optimization solution status description, where i equals the given solution index.

Parameters

solIdx holds the solution index to get the solution status description.

Returns: the optimization solution status description that corresponds to solIdx, null or empty std::string if none.

Definition at line 2062 of file OSResult.cpp.

int OSResult::getNumberOfSolutionSubstatuses ( int solIdx )

Definition at line 2073 of file OSResult.cpp.

string OSResult::getSolutionSubstatusType	(	int	solIdx,
		int	substatusIdx
	)

Definition at line 2084 of file OSResult.cpp.

string OSResult::getSolutionSubstatusDescription	(	int	solIdx,
		int	substatusIdx
	)

Definition at line 2097 of file OSResult.cpp.

int OSResult::getSolutionTargetObjectiveIdx ( int solIdx )

Definition at line 2110 of file OSResult.cpp.

std::string OSResult::getSolutionTargetObjectiveName ( int solIdx )

Definition at line 2120 of file OSResult.cpp.

bool OSResult::getSolutionWeightedObjectives ( int solIdx )

Get the [i]th optimization solution form of the objective.

Parameters

solIdx holds the solution index to get the solution status description.

Returns: whether weighting is applied to the objective.

Definition at line 2130 of file OSResult.cpp.

string OSResult::getSolutionMessage ( int solIdx )

Get the [i]th optimization solution message, where i equals the given solution index.

Parameters

solIdx holds the solution index to get the solution message.

Returns: the optimization solution message that corresponds to solIdx, null or empty if none.

Definition at line 2140 of file OSResult.cpp.

int OSResult::getNumberOfPrimalVariableValues ( int solIdx )

Definition at line 2149 of file OSResult.cpp.

int OSResult::getNumberOfVarValues ( int solIdx )

Definition at line 2161 of file OSResult.cpp.

int OSResult::getVarValueIdx	(	int	solIdx,
		int	varIdx
	)

Definition at line 2173 of file OSResult.cpp.

std::string OSResult::getVarValueName	(	int	solIdx,
		int	varIdx
	)

Definition at line 2187 of file OSResult.cpp.

double OSResult::getVarValue	(	int	solIdx,
		int	varIdx
	)

Definition at line 2201 of file OSResult.cpp.

double * OSResult::getOptimalPrimalVariableValues ( int solIdx )

Get one solution of optimal primal variable values.

Parameters

solIdx holds the solution index the optimal solution corresponds to.

Returns: a vector of variable indexes and values, an empty vector if no optimal value.

Definition at line 2215 of file OSResult.cpp.

int OSResult::getNumberOfVarValuesString ( int solIdx )

Definition at line 2247 of file OSResult.cpp.

int OSResult::getVarValueStringIdx	(	int	solIdx,
		int	varIdx
	)

Definition at line 2259 of file OSResult.cpp.

std::string OSResult::getVarValueStringName	(	int	solIdx,
		int	varIdx
	)

Definition at line 2273 of file OSResult.cpp.

std::string OSResult::getVarValueString	(	int	solIdx,
		int	varIdx
	)

Definition at line 2287 of file OSResult.cpp.

int OSResult::getBasisStatusNumberOfEl	(	int	solIdx,
		int	object,
		int	status
	)

Get the number of indices that belong to a particular basis status.

Parameters

solIdx	holds the solution index for the current solution
object	describes the kind of indices to be retrieved (legal values are described in ENUM_BASIS_STATUS — see OSGeneral.h)
status	gives the basis status type

Definition at line 2301 of file OSResult.cpp.

int OSResult::getBasisStatusEl	(	int	solIdx,
		int	object,
		int	status,
		int	j
	)

Get an entry in the array of indices that belong to a particular basis status.

Parameters

solIdx	holds the solution index for the current solution
object	describes the kind of indices to be retrieved (legal values are described in ENUM_BASIS_STATUS — see OSGeneral.h)
status	gives the basis status (basic, atLower, atUpper, etc.)
j	is the (zero-based) position of the desired entry within the index array

Definition at line 2334 of file OSResult.cpp.

int OSResult::getBasisInformationDense	(	int	solIdx,
		int	object,
		int *	resultArray,
		int	dim
	)

Get the basis information associated with the variables, objectives or constraints for some solution.

Parameters

solIdx	is the solution index
object	describes the kind of indices to be retrieved (legal values are described in ENUM_PROBLEM_COMPONENT — see OSGeneral.h)
resultArray	is the array that returns the basis information
dim	is the dimension of the resultArray

Returns: whether the operation was successful: < 0: error condition = 0: no data encountered

0: success

Definition at line 2374 of file OSResult.cpp.

int OSResult::getNumberOfOtherVariableResults ( int solIdx )

Get numberOfOtherVariableResult.

Returns: numberOfOtherVariableResult, -1 if no information.

Definition at line 2456 of file OSResult.cpp.

int OSResult::getAnOtherVariableResultNumberOfVar	(	int	solIdx,
		int	iOther
	)

Get getAnOtherVariableResultNumberOfVar.

Returns: the number of variables in the i'th other variable result, -1 if no information.

Definition at line 2473 of file OSResult.cpp.

string OSResult::getOtherVariableResultName	(	int	solIdx,
		int	otherIdx
	)

Definition at line 2488 of file OSResult.cpp.

string OSResult::getOtherVariableResultType	(	int	solIdx,
		int	otherIdx
	)

Definition at line 2504 of file OSResult.cpp.

string OSResult::getOtherVariableResultValue	(	int	solIdx,
		int	otherIdx
	)

Definition at line 2520 of file OSResult.cpp.

string OSResult::getOtherVariableResultDescription	(	int	solIdx,
		int	otherIdx
	)

Definition at line 2536 of file OSResult.cpp.

int OSResult::getOtherVariableResultNumberOfVar	(	int	solIdx,
		int	otherIdx
	)

Definition at line 2552 of file OSResult.cpp.

int OSResult::getOtherVariableResultNumberOfEnumerations	(	int	solIdx,
		int	otherIdx
	)

Definition at line 2607 of file OSResult.cpp.

int OSResult::getOtherVariableResultVarIdx	(	int	solIdx,
		int	otherIdx,
		int	varIdx
	)

Definition at line 2568 of file OSResult.cpp.

string OSResult::getOtherVariableResultVar	(	int	solIdx,
		int	otherIdx,
		int	varIdx
	)

Definition at line 2587 of file OSResult.cpp.

std::string OSResult::getOtherVariableResultArrayType	(	int	solIdx,
		int	otherIdx
	)

Get the type of values contained in the or <enumeration> array associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result

Returns: the array type

Definition at line 2623 of file OSResult.cpp.

std::string OSResult::getOtherVariableResultEnumerationValue	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the value of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the value

Definition at line 2646 of file OSResult.cpp.

std::string OSResult::getOtherVariableResultEnumerationDescription	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the description of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the description

Definition at line 2673 of file OSResult.cpp.

int OSResult::getOtherVariableResultEnumerationNumberOfEl	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the size of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the number of indices that assume this level

Definition at line 2700 of file OSResult.cpp.

int OSResult::getOtherVariableResultEnumerationEl	(	int	solIdx,
		int	otherIdx,
		int	enumIdx,
		int	j
	)

Get one index of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result
enumIdx	is the index of the current enumeration level
j	is the (zero-based) position of the index within the index array

Returns: the array of indices

Definition at line 2727 of file OSResult.cpp.

int OSResult::getOtherVariableResultArrayDense	(	int	solIdx,
		int	otherIdx,
		std::string *	resultArray,
		int	dim
	)

Get the values of a array or an <enumeration> associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result
resultArray	is the array that returns the content of the or <enumeration> array
dim	is the array dimension

Returns: whether the operation was successful: < 0: error condition = 0: no data encountered

0: number of data items set

Definition at line 2755 of file OSResult.cpp.

int OSResult::getNumberOfObjValues ( int solIdx )

Definition at line 3007 of file OSResult.cpp.

int OSResult::getObjValueIdx	(	int	solIdx,
		int	objIdx
	)

Definition at line 3020 of file OSResult.cpp.

std::string OSResult::getObjValueName	(	int	solIdx,
		int	objIdx
	)

Definition at line 3035 of file OSResult.cpp.

double OSResult::getObjValue	(	int	solIdx,
		int	objIdx
	)

Definition at line 3050 of file OSResult.cpp.

double OSResult::getOptimalObjValue	(	int	objIdx,
		int	solIdx
	)

Get one solution's optimal objective value.

Parameters

objIdx	holds the objective index the optimal value corresponds to.
solIdx	holds the solution index the optimal value corresponds to.

Returns: a double with the optimal objective function value.

Definition at line 3065 of file OSResult.cpp.

int OSResult::getNumberOfOtherObjectiveResults ( int solIdx )

Definition at line 3094 of file OSResult.cpp.

string OSResult::getOtherObjectiveResultName	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3109 of file OSResult.cpp.

string OSResult::getOtherObjectiveResultType	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3125 of file OSResult.cpp.

string OSResult::getOtherObjectiveResultValue	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3141 of file OSResult.cpp.

string OSResult::getOtherObjectiveResultDescription	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3157 of file OSResult.cpp.

int OSResult::getOtherObjectiveResultNumberOfObj	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3173 of file OSResult.cpp.

int OSResult::getOtherObjectiveResultNumberOfEnumerations	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3229 of file OSResult.cpp.

int OSResult::getOtherObjectiveResultObjIdx	(	int	solIdx,
		int	otherIdx,
		int	objIdx
	)

Definition at line 3189 of file OSResult.cpp.

string OSResult::getOtherObjectiveResultObj	(	int	solIdx,
		int	otherIdx,
		int	objIdx
	)

Definition at line 3208 of file OSResult.cpp.

std::string OSResult::getOtherObjectiveResultArrayType	(	int	solIdx,
		int	otherIdx
	)

Get the type of values contained in the <obj> or <enumeration> array associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result

Returns: the array type

Definition at line 3246 of file OSResult.cpp.

std::string OSResult::getOtherObjectiveResultEnumerationValue	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the value of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the value

Definition at line 3269 of file OSResult.cpp.

std::string OSResult::getOtherObjectiveResultEnumerationDescription	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the description of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the description

Definition at line 3297 of file OSResult.cpp.

int OSResult::getOtherObjectiveResultEnumerationNumberOfEl	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the size of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the number of indices that assume this level

Definition at line 3325 of file OSResult.cpp.

int OSResult::getOtherObjectiveResultEnumerationEl	(	int	solIdx,
		int	otherIdx,
		int	enumIdx,
		int	j
	)

Get one index of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level
j	is the (zero-based) position of the index in the array

Returns: the array of indices

Definition at line 3353 of file OSResult.cpp.

int OSResult::getOtherObjectiveResultArrayDense	(	int	solIdx,
		int	otherIdx,
		std::string *	resultArray,
		int	dim
	)

Get the values of an <obj> array or an <enumeration> associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result
resultArray	is the array that returns the content of the <obj> or <enumeration> array
dim	is the array dimension

Returns: whether the operation was successful: < 0: error condition = 0: no data encountered

0: number of data items set

Definition at line 3381 of file OSResult.cpp.

int OSResult::getNumberOfDualValues ( int solIdx )

Definition at line 3446 of file OSResult.cpp.

int OSResult::getDualValueIdx	(	int	solIdx,
		int	conIdx
	)

Definition at line 3459 of file OSResult.cpp.

std::string OSResult::getDualValueName	(	int	solIdx,
		int	objIdx
	)

Definition at line 3474 of file OSResult.cpp.

double OSResult::getDualValue	(	int	solIdx,
		int	conIdx
	)

Definition at line 3489 of file OSResult.cpp.

double * OSResult::getOptimalDualVariableValues ( int solIdx )

Get one solution of optimal dual variable values.

Parameters

solIdx holds the solution index the optimal solution corresponds to.

Returns: a vector of variable indexes and values, an empty vector if no optimal value.

Definition at line 3504 of file OSResult.cpp.

int OSResult::getNumberOfOtherConstraintResults ( int solIdx )

Definition at line 3536 of file OSResult.cpp.

string OSResult::getOtherConstraintResultName	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3551 of file OSResult.cpp.

string OSResult::getOtherConstraintResultType	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3567 of file OSResult.cpp.

string OSResult::getOtherConstraintResultValue	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3583 of file OSResult.cpp.

string OSResult::getOtherConstraintResultDescription	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3599 of file OSResult.cpp.

int OSResult::getOtherConstraintResultNumberOfCon	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3615 of file OSResult.cpp.

int OSResult::getOtherConstraintResultNumberOfEnumerations	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3693 of file OSResult.cpp.

int OSResult::getOtherConstraintResultConIdx	(	int	solIdx,
		int	otherIdx,
		int	conIdx
	)

Definition at line 3631 of file OSResult.cpp.

string OSResult::getOtherConstraintResultCon	(	int	solIdx,
		int	otherIdx,
		int	conIdx
	)

Definition at line 3650 of file OSResult.cpp.

std::string OSResult::getOtherConstraintResultArrayType	(	int	solIdx,
		int	otherIdx
	)

Get the type of values contained in the <con> or <enumeration> array associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result

Returns: the array type

Definition at line 3670 of file OSResult.cpp.

std::string OSResult::getOtherConstraintResultEnumerationValue	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the value of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result
enumIdx	is the index of the current enumeration level

Returns: the value

Definition at line 3710 of file OSResult.cpp.

std::string OSResult::getOtherConstraintResultEnumerationDescription	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the description of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the description

Definition at line 3738 of file OSResult.cpp.

int OSResult::getOtherConstraintResultEnumerationNumberOfEl	(	int	solIdx,
		int	otherIdx,
		int	enumIdx
	)

Get the size of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level

Returns: the number of indices that assume this level

Definition at line 3765 of file OSResult.cpp.

int OSResult::getOtherConstraintResultEnumerationEl	(	int	solIdx,
		int	otherIdx,
		int	enumIdx,
		int	j
	)

Get one index of an enum associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result is the index of the current enumeration level
j	is the (zeo-based) position of the entry in the array

Returns: the array of indices

Definition at line 3792 of file OSResult.cpp.

int OSResult::getOtherConstraintResultArrayDense	(	int	solIdx,
		int	otherIdx,
		std::string *	resultArray,
		int	dim
	)

Get the values of a <con> array or an <enumeration> associated with an <other> result for some solution.

Parameters

solIdx	is the solution index
otherIndex	is the index of the current <other> result
resultArray	is the array that returns the content of the <con> or <enumeration> array
dim	is the array dimension

Returns: whether the operation was successful: < 0: error condition = 0: no data encountered

0: number of data items set

Definition at line 3819 of file OSResult.cpp.

int OSResult::getNumberOfOtherSolutionResults ( int solIdx )

Definition at line 3886 of file OSResult.cpp.

string OSResult::getOtherSolutionResultName	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3898 of file OSResult.cpp.

string OSResult::getOtherSolutionResultValue	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3913 of file OSResult.cpp.

string OSResult::getOtherSolutionResultCategory	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3928 of file OSResult.cpp.

string OSResult::getOtherSolutionResultDescription	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3943 of file OSResult.cpp.

int OSResult::getOtherSolutionResultNumberOfItems	(	int	solIdx,
		int	otherIdx
	)

Definition at line 3958 of file OSResult.cpp.

string OSResult::getOtherSolutionResultItem	(	int	solIdx,
		int	otherIdx,
		int	itemIdx
	)

Definition at line 3973 of file OSResult.cpp.

int OSResult::getNumberOfSolverOutputs ( )

Definition at line 3991 of file OSResult.cpp.

string OSResult::getSolverOutputName ( int otherIdx )

Definition at line 3997 of file OSResult.cpp.

string OSResult::getSolverOutputCategory ( int otherIdx )

Definition at line 4007 of file OSResult.cpp.

string OSResult::getSolverOutputDescription ( int otherIdx )

Definition at line 4017 of file OSResult.cpp.

int OSResult::getSolverOutputNumberOfItems ( int otherIdx )

Definition at line 4027 of file OSResult.cpp.

string OSResult::getSolverOutputItem	(	int	otherIdx,
		int	itemIdx
	)

Definition at line 4037 of file OSResult.cpp.

bool OSResult::setGeneralStatus ( GeneralStatus * status )

Set the general status.

Parameters

status holds the general status.

Returns: whether the general status is set successfully.

Definition at line 4060 of file OSResult.cpp.

bool OSResult::setGeneralStatusType ( std::string type )

Set the general status type, which can be: success, error, warning.

Parameters

type	holds the general status type

Returns: whether the general status type is set successfully or not.

bool OSResult::setNumberOfGeneralSubstatuses ( int num )

Set the number of substatus elements.

Parameters

num	holds the number of substatuses (a nonegative integer)

Returns: whether the number of substatuses is set successfully or not.

Definition at line 4085 of file OSResult.cpp.

bool OSResult::setGeneralStatusDescription ( std::string description )

Set the general status description.

Parameters

description holds the general status description.

Returns: whether the general status description is set successfully or not.

bool OSResult::setGeneralSubstatusName	(	int	idx,
		std::string	name
	)

Set the general substatus name.

Parameters

name	holds the general substatus name
idx	holds the index of the substatus in the array

Returns: whether the general substatus name is set successfully or not.

Definition at line 4102 of file OSResult.cpp.

bool OSResult::setGeneralSubstatusDescription	(	int	idx,
		std::string	description
	)

Set the general substatus description.

Parameters

description	holds the general substatus description.
idx	holds the index of the substatus in the array

Returns: whether the general status description is set successfully or not.

Definition at line 4111 of file OSResult.cpp.

bool OSResult::setGeneralMessage ( std::string message )

Set the general message.

Parameters

message holds the general message.

Returns: whether process message is set successfully.

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

Set service name.

Parameters

serviceName holds the name of the service.

Returns: whether the service name is set successfully.

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

Set service uri.

Parameters

serviceURI holds the uri of the service.

Returns: whether the service uri is set successfully.

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

Set instance name.

Parameters

instanceName holds the name of the instance.

Returns: whether the instance name is set successfully.

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

Set job id.

Parameters

jobID holds the job id.

Returns: whether the job id is set successfully.

bool OSResult::setSolverInvoked ( std::string solverInvoked )

Set solver invoked.

Parameters

solverInvoked holds the solver invoked.

Returns: whether the solver invoked is set successfully.

Definition at line 4155 of file OSResult.cpp.

bool OSResult::setTimeStamp ( std::string timeStamp )

Set time stamp.

Parameters

time	holds the time stamp.

Returns: whether the time stamp is set successfully.

Definition at line 4162 of file OSResult.cpp.

bool OSResult::setNumberOfOtherGeneralResults ( int num )

Set number of other general results.

Parameters

num	holds the number of other general results.

Returns: whether the number was set successfully.

Definition at line 4169 of file OSResult.cpp.

bool OSResult::setOtherGeneralResultName	(	int	idx,
		std::string	name
	)

Set the general otherResult name.

Parameters

name	holds the general otherResult name
idx	holds the index of the otherResult in the array

Returns: whether the general otherResult name is set successfully or not.

Definition at line 4186 of file OSResult.cpp.

bool OSResult::setOtherGeneralResultValue	(	int	idx,
		std::string	value
	)

Set the general otherResult value.

Parameters

name	holds the general otherResult value
idx	holds the index of the otherResult in the array

Returns: whether the general otherResult value is set successfully or not.

Definition at line 4196 of file OSResult.cpp.

bool OSResult::setOtherGeneralResultDescription	(	int	idx,
		std::string	description
	)

Set the general otherResult description.

Parameters

name	holds the general otherResult description
idx	holds the index of the otherResult in the array

Returns: whether the general otherResult description is set successfully or not.

Definition at line 4206 of file OSResult.cpp.

bool OSResult::setSystemInformation ( std::string systemInformation )

Set the system information.

Parameters

systemInformation holds the system information

Returns: whether the system information was set successfully or not.

Definition at line 4216 of file OSResult.cpp.

bool OSResult::setAvailableDiskSpaceUnit ( std::string unit )

Set the unit in which available disk space is measured.

Parameters

unit	holds unit (byte, kilobyte, megabtye, gigabyte, terabyte, petabyte)

Returns: whether the system information was set successfully or not.

Definition at line 4223 of file OSResult.cpp.

bool OSResult::setAvailableDiskSpaceDescription ( std::string description )

Set the description of available disk space.

Parameters

description holds further information about available disk space

Returns: whether the system information was set successfully or not.

Definition at line 4232 of file OSResult.cpp.

bool OSResult::setAvailableDiskSpaceValue ( double value )

Set the amount of available disk space.

Parameters

value holds the number of disk space units

Returns: whether the system information was set successfully or not.

Definition at line 4240 of file OSResult.cpp.

bool OSResult::setAvailableMemoryUnit ( std::string unit )

Set the unit in which available memory is measured.

Parameters

unit	holds unit (byte, kilobyte, megabtye, gigabyte, terabyte)

Returns: whether the system information was set successfully or not.

Definition at line 4248 of file OSResult.cpp.

bool OSResult::setAvailableMemoryDescription ( std::string description )

Set the description of available memory.

Parameters

description holds further information about available memory

Returns: whether the system information was set successfully or not.

Definition at line 4257 of file OSResult.cpp.

bool OSResult::setAvailableMemoryValue ( double value )

Set the amount of available memory.

Parameters

value holds the number of memory units

Returns: whether the system information was set successfully or not.

Definition at line 4265 of file OSResult.cpp.

bool OSResult::setAvailableCPUSpeedUnit ( std::string unit )

Set the unit in which available CPU speed is measured.

Parameters

unit	holds unit

Returns: whether the system information was set successfully or not.

Definition at line 4273 of file OSResult.cpp.

bool OSResult::setAvailableCPUSpeedDescription ( std::string description )

Set the description of available CPU speed.

Parameters

description holds further information about the CPU speed

Returns: whether the system information was set successfully or not.

Definition at line 4282 of file OSResult.cpp.

bool OSResult::setAvailableCPUSpeedValue ( double value )

Set the available CPU speed.

Parameters

value holds the available CPU speed

Returns: whether the system information was set successfully or not.

Definition at line 4290 of file OSResult.cpp.

bool OSResult::setAvailableCPUNumberDescription ( std::string description )

Set the description of available number of CPUs.

Parameters

description is used to impart further info about the CPUs

Returns: whether the system information was set successfully or not.

Definition at line 4298 of file OSResult.cpp.

bool OSResult::setAvailableCPUNumberValue ( int value )

Set the available number of CPUs.

Parameters

value holds the available number of CPUs

Returns: whether the system information was set successfully or not.

Definition at line 4306 of file OSResult.cpp.

bool OSResult::setNumberOfOtherSystemResults ( int num )

Set number of other system results.

Parameters

num	holds the number of other system results.

Returns: whether the number was set successfully.

Definition at line 4314 of file OSResult.cpp.

bool OSResult::setOtherSystemResultName	(	int	idx,
		std::string	name
	)

Set the system otherResult name.

Parameters

name	holds the system otherResult name
idx	holds the index of the otherResult in the array

Returns: whether the system otherResult name is set successfully or not.

Definition at line 4331 of file OSResult.cpp.

bool OSResult::setOtherSystemResultValue	(	int	idx,
		std::string	value
	)

Set the system otherResult value.

Parameters

name	holds the system otherResult value
idx	holds the index of the otherResult in the array

Returns: whether the system otherResult value is set successfully or not.

Definition at line 4341 of file OSResult.cpp.

bool OSResult::setOtherSystemResultDescription	(	int	idx,
		std::string	description
	)

Set the system otherResult description.

Parameters

name	holds the system otherResult description
idx	holds the index of the otherResult in the array

Returns: whether the system otherResult description is set successfully or not.

Definition at line 4351 of file OSResult.cpp.

bool OSResult::setCurrentState ( std::string currentState )

Set the current state of the service.

Parameters

currentState holds the current state

Returns: whether the service information was set successfully or not.

Definition at line 4361 of file OSResult.cpp.

bool OSResult::setCurrentJobCount ( int jobCount )

Set the current job count.

Parameters

jobCount holds the current job count

Returns: whether the service information was set successfully or not.

Definition at line 4370 of file OSResult.cpp.

bool OSResult::setTotalJobsSoFar ( int number )

Set the total number of jobs so far.

Parameters

number holds the total number of jobs

Returns: whether the service information was set successfully or not.

Definition at line 4377 of file OSResult.cpp.

bool OSResult::setTimeServiceStarted ( std::string startTime )

Set the time the service was started.

Parameters

startTime holds the starting time

Returns: whether the service information was set successfully or not.

Definition at line 4384 of file OSResult.cpp.

bool OSResult::setServiceUtilization ( double value )

Set the service utilitzation.

Parameters

value holds the service utilitzation

Returns: whether the service information was set successfully or not.

Definition at line 4391 of file OSResult.cpp.

bool OSResult::setNumberOfOtherServiceResults ( int num )

Set number of other service results.

Parameters

num	holds the number of other service results.

Returns: whether the number was set successfully.

Definition at line 4398 of file OSResult.cpp.

bool OSResult::setOtherServiceResultName	(	int	idx,
		std::string	name
	)

Set the service otherResult name.

Parameters

name	holds the service otherResult name
idx	holds the index of the otherResult in the array

Returns: whether the service otherResult name is set successfully or not.

Definition at line 4415 of file OSResult.cpp.

bool OSResult::setOtherServiceResultValue	(	int	idx,
		std::string	value
	)

Set the service otherResult value.

Parameters

name	holds the service otherResult value
idx	holds the index of the otherResult in the array

Returns: whether the service otherResult value is set successfully or not.

Definition at line 4425 of file OSResult.cpp.

bool OSResult::setOtherServiceResultDescription	(	int	idx,
		std::string	description
	)

Set the service otherResult description.

Parameters

name	holds the service otherResult description
idx	holds the index of the otherResult in the array

Returns: whether the service otherResult description is set successfully or not.

Definition at line 4435 of file OSResult.cpp.

bool OSResult::setJobStatus ( std::string status )

Set the job status.

Parameters

status holds the job status

Returns: whether the job status was set successfully or not.

Definition at line 4445 of file OSResult.cpp.

bool OSResult::setJobSubmitTime ( std::string submitTime )

Set the time when the job was submitted.

Parameters

submitTime holds the time when the job was submitted

Returns: whether the information was set successfully or not.

Definition at line 4454 of file OSResult.cpp.

bool OSResult::setScheduledStartTime ( std::string scheduledStartTime )

Set the job's scheduled start time.

Parameters

scheduledStartTime holds the scheduled start time

Returns: whether the information was set successfully or not.

Definition at line 4461 of file OSResult.cpp.

bool OSResult::setActualStartTime ( std::string actualStartTime )

Set the job's actual start time.

Parameters

actualStartTime holds the actual start time

Returns: whether the information was set successfully or not.

Definition at line 4468 of file OSResult.cpp.

bool OSResult::setJobEndTime ( std::string endTime )

Set the time when the job finished.

Parameters

endTime holds the time when the job finished

Returns: whether the information was set successfully or not.

Definition at line 4475 of file OSResult.cpp.

bool OSResult::setTime ( double time )

Set time.

Parameters

time	holds the time.

Returns: whether the time is set successfully.

Definition at line 4482 of file OSResult.cpp.

bool OSResult::addTimingInformation	(	std::string	type,
		std::string	category,
		std::string	unit,
		std::string	description,
		double	value
	)

Add timing information.

Parameters

type	holds the timer type (cpuTime/elapsedTime/other).
category	holds the timer category (total/input/preprocessing, etc.)
unit	holds the timer unit (tick/milliscond/second/minute/etc.)
description	holds further information about the timer.
value	holds the time measurement.

Returns: whether the time is set successfully.

Definition at line 4487 of file OSResult.cpp.

bool OSResult::setTimingInformation	(	int	idx,
		std::string	type,
		std::string	category,
		std::string	unit,
		std::string	description,
		double	value
	)

Set timing information.

Parameters

idx	holds the index within the time array of the item to be set
type	holds the timer type (cpuTime/elapsedTime/other).
category	holds the timer category (total/input/preprocessing, etc.)
unit	holds the timer unit (tick/milliscond/second/minute/etc.)
description	holds further information about the timer.
value	holds the time measurement.

Returns: whether the time is set successfully.

Definition at line 4520 of file OSResult.cpp.

bool OSResult::setNumberOfTimes ( int numberOfTimes )

Set the number of time measurements and initial the time array.

Parameters

numberOfTimes holds the number of measurements

Returns: whether the function completed successfully or not.

Definition at line 4542 of file OSResult.cpp.

bool OSResult::setTimeNumber ( int timeNumber )

Set the number of time measurements.

Parameters

timeNumber holds the number of measurements

Returns: whether the time number is set successfully or not.

Definition at line 4560 of file OSResult.cpp.

bool OSResult::setUsedDiskSpaceUnit ( std::string unit )

Set the unit in which used disk space is measured.

Parameters

unit	holds unit (byte, kilobyte, megabtye, gigabyte, terabyte, petabyte)

Returns: whether the information was set successfully or not.

Definition at line 4570 of file OSResult.cpp.

bool OSResult::setUsedDiskSpaceDescription ( std::string description )

Set the description of used disk space.

Parameters

description holds further information about used disk space

Returns: whether the information was set successfully or not.

Definition at line 4580 of file OSResult.cpp.

bool OSResult::setUsedDiskSpaceValue ( double value )

Set the amount of used disk space.

Parameters

value holds the number of disk space units

Returns: whether the information was set successfully or not.

Definition at line 4588 of file OSResult.cpp.

bool OSResult::setUsedMemoryUnit ( std::string unit )

Set the unit in which used memory is measured.

Parameters

unit	holds unit (byte, kilobyte, megabtye, gigabyte, terabyte)

Returns: whether the information was set successfully or not.

Definition at line 4596 of file OSResult.cpp.

bool OSResult::setUsedMemoryDescription ( std::string description )

Set the description of used memory.

Parameters

description holds further information about used memory

Returns: whether the information was set successfully or not.

Definition at line 4606 of file OSResult.cpp.

bool OSResult::setUsedMemoryValue ( double value )

Set the amount of used memory.

Parameters

value holds the number of memory units

Returns: whether the information was set successfully or not.

Definition at line 4614 of file OSResult.cpp.

bool OSResult::setUsedCPUSpeedUnit ( std::string unit )

Set the unit in which used CPU speed is measured.

Parameters

unit	holds unit

Returns: whether the information was set successfully or not.

Definition at line 4622 of file OSResult.cpp.

bool OSResult::setUsedCPUSpeedDescription ( std::string description )

Set the description of used CPU speed.

Parameters

description holds further information about the CPU speed

Returns: whether the information was set successfully or not.

Definition at line 4632 of file OSResult.cpp.

bool OSResult::setUsedCPUSpeedValue ( double value )

Set the used CPU speed.

Parameters

value holds the used CPU speed

Returns: whether the information was set successfully or not.

Definition at line 4640 of file OSResult.cpp.

bool OSResult::setUsedCPUNumberDescription ( std::string description )

Set the description of used number of CPUs.

Parameters

description is used to impart further info about the CPUs

Returns: whether the system information was set successfully or not.

Definition at line 4648 of file OSResult.cpp.

bool OSResult::setUsedCPUNumberValue ( int value )

Set the used number of CPUs.

Parameters

value holds the used number of CPUs

Returns: whether the information was set successfully or not.

Definition at line 4656 of file OSResult.cpp.

bool OSResult::setNumberOfOtherJobResults ( int num )

Set number of other job results.

Parameters

num	holds the number of other job results.

Returns: whether the number was set successfully.

Definition at line 4664 of file OSResult.cpp.

bool OSResult::setOtherJobResultName	(	int	idx,
		std::string	name
	)

Set the job otherResult name.

Parameters

name	holds the job otherResult name
idx	holds the index of the otherResult in the array

Returns: whether the job otherResult name is set successfully or not.

Definition at line 4681 of file OSResult.cpp.

bool OSResult::setOtherJobResultValue	(	int	idx,
		std::string	value
	)

Set the job otherResult value.

Parameters

name	holds the job otherResult value
idx	holds the index of the otherResult in the array

Returns: whether the job otherResult value is set successfully or not.

Definition at line 4691 of file OSResult.cpp.

bool OSResult::setOtherJobResultDescription	(	int	idx,
		std::string	description
	)

Set the job otherResult description.

Parameters

name	holds the job otherResult description
idx	holds the index of the otherResult in the array

Returns: whether the job otherResult description is set successfully or not.

Definition at line 4701 of file OSResult.cpp.

bool OSResult::setVariableNumber ( int variableNumber )

Set the variable number.

Parameters

variableNumber holds the number of variables

Returns: whether the variable number is set successfully or not.

Definition at line 4712 of file OSResult.cpp.

bool OSResult::setObjectiveNumber ( int objectiveNumber )

Set the objective number.

Parameters

objectiveNumber holds the number of objectives

Returns: whether the objective number is set successfully or not.

Definition at line 4721 of file OSResult.cpp.

bool OSResult::setConstraintNumber ( int constraintNumber )

Set the constraint number.

Parameters

constraintNumber holds the number of constraints

Returns: whether the constraint number is set successfully or not.

Definition at line 4731 of file OSResult.cpp.

bool OSResult::setSolutionNumber ( int number )

set the number of solutions.

This method must be called before setting other optimization solution related results. Before this method is called, the setVariableNumber(int), setObjectiveNumber(int), setConstraintNumber(int) methods have to be called first.

Parameters

number holds the number of solutions to set.

Returns: whether the solution number is set successfully.

See Also: setVariableNumber(int); setObjectiveNumber(int); setConstraintNumber(int)

Definition at line 4740 of file OSResult.cpp.

bool OSResult::setSolutionStatus	(	int	solIdx,
		std::string	type,
		std::string	description
	)

Set the [i]th optimization solution status, where i equals the given solution index.

The solution status includes the status type, optional descriptions and possibly substatuses. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the solution status.
status	holds the optimization solution status to set.

Returns: whether the optimization solution status is set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OptimizationSolutionStatus; setSolutionNumber(int)

bool OSResult::setSolutionStatusType	(	int	solIdx,
		std::string	type
	)

Set the [i]th optimization solution status type.

Parameters

solIdx	holds the solution index whose status to set.
type	holds the solution status type

Returns: whether the solution status type is set successfully or not.

Definition at line 4773 of file OSResult.cpp.

bool OSResult::setNumberOfSolutionSubstatuses	(	int	solIdx,
		int	num
	)

Set the [i]th optimization solution's number of substatus elements.

Parameters

solIdx	holds the solution index whose status to set.
num	holds the number of substatuses (a nonegative integer)

Returns: whether the number of substatuses is set successfully or not.

Definition at line 4810 of file OSResult.cpp.

bool OSResult::setSolutionStatusDescription	(	int	solIdx,
		std::string	description
	)

Set the [i]th optimization solution status description.

Parameters

solIdx	holds the solution index whose status to set.
description	holds the solution status description.

Returns: whether the solution status description is set successfully or not.

Definition at line 4791 of file OSResult.cpp.

bool OSResult::setSolutionSubstatusType	(	int	solIdx,
		int	substatusIdx,
		std::string	type
	)

Set the solution substatus type.

Parameters

solIdx	holds the solution index whose status to set.
substatusIdx	holds the index of the substatus in the array
type	holds the general substatus type

Returns: whether the general substatus type is set successfully or not.

Definition at line 4839 of file OSResult.cpp.

bool OSResult::setSolutionSubstatusDescription	(	int	solIdx,
		int	substatusIdx,
		std::string	description
	)

Set the solution substatus description.

Parameters

solIdx	holds the solution index whose status to set.
substatusIdx	holds the index of the substatus in the array
description	holds the general substatus description.

Returns: whether the solution status description is set successfully or not.

Definition at line 4856 of file OSResult.cpp.

bool OSResult::setSolutionTargetObjectiveIdx	(	int	solIdx,
		int	objectiveIdx
	)

Set the [i]th optimization solution's objective index, where i equals the given solution index.

The first objective's index should be -1, the second -2, and so on. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective index.
objectiveIdx	holds the objective index to set. All the objective indexes are negative starting from -1 downward.

Returns: whether the optimization objective index is set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 4870 of file OSResult.cpp.

bool OSResult::setSolutionTargetObjectiveName	(	int	solIdx,
		std::string	objectiveName
	)

Set the [i]th optimization solution's objective name, where i equals the given solution index.

The first objective's index should be -1, the second -2, and so on. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective index.
objectiveName	holds the objective indexname to set.

Returns: whether the optimization objective name is set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 4887 of file OSResult.cpp.

bool OSResult::setSolutionWeightedObjectives	(	int	solIdx,
		bool	weightedObjectives
	)

Record whether the [i]th optimization solution uses weighted objectives, where i equals the given solution index.

Parameters

solIdx	holds the solution index to set the objective index.
weightedObjectives	holds the value "true" or "false".

Returns: whether the information was set successfully or not.

Definition at line 4903 of file OSResult.cpp.

bool OSResult::setSolutionMessage	(	int	solIdx,
		std::string	msg
	)

Set the [i]th optimization solution's message, where i equals the given solution index.

The first objective's index should be -1, the second -2, and so on. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective index.
msg	holds the solution message to set.

Returns: whether the optimization objective index is set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 4917 of file OSResult.cpp.

bool OSResult::setNumberOfPrimalVariableValues	(	int	solIdx,
		int	n
	)

Set the [i]th optimization solution's number of primal variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
n	holds the number of elements in the array x

Returns: whether primal variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 4933 of file OSResult.cpp.

bool OSResult::setPrimalVariableValuesSparse	(	int	solIdx,
		std::vector< IndexValuePair * >	x
	)

Set the [i]th optimization solution's primal variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
x	holds a vector of type IndexValuePair; the idx component holds the index of the variable; the value component holds its value. The vector could be null if all variables are 0.

Returns: whether primal variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 4962 of file OSResult.cpp.

bool OSResult::setPrimalVariableValuesDense	(	int	solIdx,
		double *	x
	)

Set the [i]th optimization solution's primal variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
x	holds a double dense array of variable values to set; it could be null if all variables are 0.

Returns: whether primal variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5001 of file OSResult.cpp.

bool OSResult::setNumberOfVarValues	(	int	solIdx,
		int	numberOfVar
	)

Set the number of primal variables to be given a value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
numberOfVar	holds the number of primal variables that are to be set

Returns: whether the information was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5040 of file OSResult.cpp.

bool OSResult::setVarValue	(	int	solIdx,
		int	number,
		int	idx,
		std::string	name,
		double	val
	)

Set a primal variable value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
number	holds the location within the sparse array var that is to be used
idx	holds the index of the primal variable that is to be set
name	holds the variable name (or an empty string).
val	holds the variable value to set.

Returns: whether primal variable value was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5068 of file OSResult.cpp.

bool OSResult::setNumberOfVarValuesString	(	int	solIdx,
		int	numberOfVar
	)

Set the number of string-valued primal variables to be given a value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
numberOfVar	holds the number of primal variables that are to be set

Returns: whether the information was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5114 of file OSResult.cpp.

bool OSResult::setVarValueString	(	int	solIdx,
		int	number,
		int	idx,
		std::string	name,
		std::string	str
	)

Set a string-valued primal variable value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
number	holds the location within the sparse array var that is to be used
idx	holds the index of the primal variable that is to be set
name	holds the variable name (or an empty string).
str	holds the variable value to set.

Returns: whether primal variable value was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5147 of file OSResult.cpp.

bool OSResult::setBasisStatus	(	int	solIdx,
		int	object,
		int	status,
		int *	i,
		int	ni
	)

Set the basis status of a number of variables/constraints/objectives.

Parameters

solIdx	holds the index of the solution to which the basis values belong.
object	holds the type of basis object to be used (legal values are taken from the ENUM_PROBLEM_COMPONENT enumeration — see OSGeneral.h))
status	holds the status which is to be used (legal values are taken from the ENUM_BASIS_STATUS enumeration — see OSGeneral.h)
i	holds the integer array whose values are to be transferred. (NOTE WELL: This method does not handle individual variables --- the entire basis must be processed at once.)
ni	holds the number of elements of i

Returns: whether basis status was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5192 of file OSResult.cpp.

bool OSResult::setNumberOfOtherVariableResults	(	int	solIdx,
		int	numberOfOtherVariableResults
	)

Set the [i]th optimization solution's other (non-standard/solver specific) variable-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first. This method then allocates the memory for the new OtherVariableResult objects

Parameters

solIdx	is the solution index
numberOfOtherVariableResult	holds the number of OtherVariableResult objects Each other variable result contains the name (required), an optional description (std::string) and an optional value (std::string). Each other variable result can also optionally contain an array OtherVarResult for each variable. The OtherVarResult contains a variable idx (required) and an optional std::string value.

Returns: whether the other variable results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5236 of file OSResult.cpp.

bool OSResult::setAnOtherVariableResultSparse	(	int	solIdx,
		int	otherIdx,
		std::string	name,
		std::string	value,
		std::string	description,
		int *	idx,
		std::string *	s,
		int	n
	)

Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the new OtherVariableResult object
name	holds the name of the other element
value	holds the value of the other element
idx	holds a pointer to the indexes of the var element
s	holds a pointer to the array of values of the var element
n	holds the number of elements of the array

Returns: whether the other variable results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

bool OSResult::setAnOtherVariableResultSparse	(	int	solIdx,
		int	otherIdx,
		std::string	name,
		std::string	value,
		std::string	description,
		int *	idx,
		std::string *	s,
		int	n,
		std::string	type,
		std::string	varType,
		std::string	enumType
	)

Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index.

This alternate signature sets the type of the value attribute and the and <enumeration> arrays

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx holds the solution index

otherIdx holds the index of the new OtherVariableResult object

name holds the name of the other element

value holds the value of the other element

idx holds a pointer to the indexes of the var element

s holds a pointer to the array of values of the var element

n holds the number of elements of the array

type holds the type of the <other> element's value attribute

varType holds the type of the <other> element's array

enumType holds the type of the <other> element's <enumeration> array

Returns
whether the other variable results are set successfully or not.

See Also
org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult

org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult

setSolutionNumber(int)

bool OSResult::setAnOtherVariableResultDense	(	int	solIdx,
		int	otherIdx,
		std::string	name,
		std::string	value,
		std::string	description,
		std::string *	s
	)

Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the new OtherVariableResult object
name	holds the name of the other element
value	holds the value of the other element
s	holds a pointer to the array of values of the var element

Returns: whether the other variable results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

bool OSResult::setAnOtherVariableResultDense	(	int	solIdx,
		int	otherIdx,
		std::string	name,
		std::string	value,
		std::string	description,
		std::string *	s,
		std::string	type,
		std::string	varType,
		std::string	enumType
	)

Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index.

This alternate signature sets the type of the value attribute and the and <enumeration> arrays

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx holds the solution index

otherIdx holds the index of the new OtherVariableResult object

name holds the name of the other element

value holds the value of the other element

s holds a pointer to the array of values of the var element

type holds the type of the <other> element's value attribute

varType holds the type of the <other> element's array

enumType holds the type of the <other> element's <enumeration> array

Returns
whether the other variable results are set successfully or not.

See Also
org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult

org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult

setSolutionNumber(int)

bool OSResult::setOtherVariableResultNumberOfVar	(	int	solIdx,
		int	otherIdx,
		int	numberOfVar
	)

Set the number of children of another (non-standard/solver specific) variable-related result, for the [i]th solution.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
numberOfVar	holds the number of children

Returns: whether the other variable result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5390 of file OSResult.cpp.

bool OSResult::setOtherVariableResultNumberOfEnumerations	(	int	solIdx,
		int	otherIdx,
		int	numberOfEnumerations
	)

Set the number of <enumeration> children of another (non-standard/solver specific) variable-related result, for the [i]th solution.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
numberOfEnumerations	holds the number of <enumeration> children

Returns: whether the other variable result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5412 of file OSResult.cpp.

bool OSResult::setOtherVariableResultName	(	int	solIdx,
		int	otherIdx,
		std::string	name
	)

Set the name of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
name	holds the name of the other element

Returns: whether the other variable result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5433 of file OSResult.cpp.

bool OSResult::setOtherVariableResultType	(	int	solIdx,
		int	otherIdx,
		std::string	type
	)

Set the type of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
type	holds the type of the other element

Returns: whether the other variable result's type was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5452 of file OSResult.cpp.

bool OSResult::setOtherVariableResultVarType	(	int	solIdx,
		int	otherIdx,
		std::string	varType
	)

Set the varType of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
varType	holds the data type of the array of the <other> element

Returns: whether the other variable result's varType was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5471 of file OSResult.cpp.

bool OSResult::setOtherVariableResultEnumType	(	int	solIdx,
		int	otherIdx,
		std::string	enumType
	)

Set the enumType of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
enumType	holds the data type of the <enumeration> array of the <other> element

Returns: whether the other variable result's enumType was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5490 of file OSResult.cpp.

bool OSResult::setOtherVariableResultValue	(	int	solIdx,
		int	otherIdx,
		std::string	value
	)

Set the value of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
value	holds the name of the other element

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5509 of file OSResult.cpp.

bool OSResult::setOtherVariableResultDescription	(	int	solIdx,
		int	otherIdx,
		std::string	description
	)

Set the description of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
description	holds the name of the other element

Returns: whether the other variable result's description was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5528 of file OSResult.cpp.

bool OSResult::setOtherVariableResultSolver	(	int	solIdx,
		int	otherIdx,
		std::string	solver
	)

Set the solver of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
solver	holds the type of the other element

Returns: whether the other variable result's solver was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5547 of file OSResult.cpp.

bool OSResult::setOtherVariableResultCategory	(	int	solIdx,
		int	otherIdx,
		std::string	category
	)

Set the category of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
category	holds the type of the other element

Returns: whether the other variable result's category was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5566 of file OSResult.cpp.

bool OSResult::setOtherVariableResultVarIdx	(	int	solIdx,
		int	otherIdx,
		int	varIdx,
		int	idx
	)

Set the index of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
varIdx	holds the index of the location to which the information is stored
idx	holds the index of the variable to which the information belongs

Returns: whether the other variable result's index was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5585 of file OSResult.cpp.

bool OSResult::setOtherVariableResultVarName	(	int	solIdx,
		int	otherIdx,
		int	varIdx,
		std::string	name
	)

Set the name of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
varIdx	holds the index of the location to which the information is stored
name	holds the name of the variable to which the information belongs

Returns: whether the other variable result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5601 of file OSResult.cpp.

bool OSResult::setOtherVariableResultVar	(	int	solIdx,
		int	otherIdx,
		int	varIdx,
		std::string	value
	)

Set the value of another (non-standard/solver specific) variable-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
varIdx	holds the index of the location to which the information is stored
value	holds the value of the variable to which the information belongs

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5616 of file OSResult.cpp.

bool OSResult::setOtherOptionOrResultEnumeration	(	int	solIdx,
		int	otherIdx,
		int	object,
		int	enumIdx,
		std::string	value,
		std::string	description,
		int *	i,
		int	ni
	)

Set the value and corresponding indices of another (non-standard/solver specific) variable-related result, for the [k]th solution, where k equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherVariableResult object
object	holds the object to which this enumeration pertains (legal values are taken from the ENUM_PROBLEM_COMPONENT enumeration — see OSGeneral.h))
enumIdx	holds the index of the OtherOptionOrResultEnumeration object
value	holds the value of this result
description	holds a description of this result
i	holds the indices of the variables that take on this value
ni	holds the dimension of the index vector i

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 5631 of file OSResult.cpp.

bool OSResult::setNumberOfOtherObjectiveResults	(	int	solIdx,
		int	numberOfOtherObjectiveResults
	)

Set the [i]th optimization solution's other (non-standard/solver specific) objective-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first. This method then allocates the memory for the new OtherObjectiveResult objects

Parameters

solIdx	is the solution index
numberOfOtherObjectiveResult	holds the number of OtherObjectiveResult objects Each other objective result contains the name (required), an optional description (std::string) and an optional value (std::string). Each other objective result can also optionally contain an array OtherObjResult for each objective. The OtherObjResult contains an objective idx (required) and an optional std::string value.

Returns: whether the other objective results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 5690 of file OSResult.cpp.

bool OSResult::setNumberOfObjValues	(	int	solIdx,
		int	numberOfObj
	)

Set the number of objectives to be given a value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective values.
numberOfObj	holds the number of objectives that are to be set

Returns: whether the information was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5719 of file OSResult.cpp.

bool OSResult::setNumberOfObjectiveValues	(	int	solIdx,
		int	n
	)

Set the [i]th optimization solution's number of objective values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
n	holds the number of elements in the array x

Returns: whether objctive values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5754 of file OSResult.cpp.

bool OSResult::setObjectiveValuesSparse	(	int	solIdx,
		std::vector< IndexValuePair * >	x
	)

Set the [i]th optimization solution's objective values, where i equals the given solution index.

Usually one of the objective is what the solution was solved for (or based on). Its index should be indicated in the solution's objectiveIdx attribute. Based on this objective's solution, the rest of the objective values are (optionally) calculated. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective values.
x	holds a vector of type IndexValuePair; the idx component holds the index of the objective; the value component holds its value. The vector could be null if all objectives are 0. Possibly only the objective that the solution is based on has the value, and the rest of the objective values all get a Double.NaN value, meaning that they are not calculated.

Returns: whether objective values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5784 of file OSResult.cpp.

bool OSResult::setObjectiveValuesDense	(	int	solIdx,
		double *	objectiveValues
	)

Set the [i]th optimization solution's objective values, where i equals the given solution index.

Usually one of the objective is what the solution was solved for (or based on). Its index should be indicated in the solution's objectiveIdx attribute. Based on this objective's solution, the rest of the objective values are (optionally) calculated. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective values.
objectiveValues	holds the double sparse array of objective values to set. Possibly only the objective that the solution is based on has the value, and the rest of the objective values all get a Double.NaN value, meaning that they are not calculated.

Returns: whether objective values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5824 of file OSResult.cpp.

bool OSResult::setObjValue	(	int	solIdx,
		int	number,
		int	idx,
		std::string	name,
		double	val
	)

Set an objective value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective values.
number	holds the location within the sparse array obj that is to be used
idx	holds the index of the objective that is to be set
name	holds the objective name (or an empty string).
val	holds the objective value to set.

Returns: whether primal variable value was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 5867 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultNumberOfObj	(	int	solIdx,
		int	otherIdx,
		int	numberOfObj
	)

Set the number of <obj> children of another (non-standard/solver specific) objective-related result, for the [i]th solution.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
numberOfObj	holds the number of <obj> children

Returns: whether the other objective result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 5912 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultNumberOfEnumerations	(	int	solIdx,
		int	otherIdx,
		int	numberOfObj
	)

Set the number of <enumeration> children of another (non-standard/solver specific) objective-related result, for the [i]th solution.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
numberOfObj	holds the number of <obj> children

Returns: whether the other objective result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 5937 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultName	(	int	solIdx,
		int	otherIdx,
		std::string	name
	)

Set the name of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
name	holds the name of the other element

Returns: whether the other objective result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 5958 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultType	(	int	solIdx,
		int	otherIdx,
		std::string	type
	)

Set the type of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
name	holds the type of the <other> element

Returns: whether the other objective result's type was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 5977 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultObjType	(	int	solIdx,
		int	otherIdx,
		std::string	objType
	)

Set the objType of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
name	holds the data type of the <other> element's array

Returns: whether the other objective result's objType was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 5996 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultEnumType	(	int	solIdx,
		int	otherIdx,
		std::string	enumType
	)

Set the enumType of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
name	holds the data type of the <other> element's <enumeration> array

Returns: whether the other objective result's enumType was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6015 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultValue	(	int	solIdx,
		int	otherIdx,
		std::string	value
	)

Set the value of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
value	holds the name of the other element

Returns: whether the other objective result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6034 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultDescription	(	int	solIdx,
		int	otherIdx,
		std::string	description
	)

Set the description of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
description	holds the name of the other element

Returns: whether the other objective result's description was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6053 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultSolver	(	int	solIdx,
		int	otherIdx,
		std::string	solver
	)

Set the solver of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
solver	holds the solver of the other element

Returns: whether the other Objective result's solver was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6072 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultCategory	(	int	solIdx,
		int	otherIdx,
		std::string	category
	)

Set the category of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
category	holds the category of the other element

Returns: whether the other objective result's category was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6091 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultObjIdx	(	int	solIdx,
		int	otherIdx,
		int	objIdx,
		int	idx
	)

Set the index of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
objIdx	holds the index of the location to which the information is stored
idx	holds the index of the objective to which the information belongs

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6110 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultObjName	(	int	solIdx,
		int	otherIdx,
		int	objIdx,
		std::string	name
	)

Set the name of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
objIdx	holds the index of the location to which the information is stored
name	holds the name of the objective to which the information belongs

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6126 of file OSResult.cpp.

bool OSResult::setOtherObjectiveResultObj	(	int	solIdx,
		int	otherIdx,
		int	objIdx,
		std::string	value
	)

Set the value of another (non-standard/solver specific) objective-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherObjectiveResult object
objIdx	holds the index of the location to which the information is stored
value	holds the value of the objective to which the information belongs

Returns: whether the other objective result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherObjectiveResult; org.optimizationservices.oscommon.datastructure.osresult.OtherObjResult; setSolutionNumber(int)

Definition at line 6141 of file OSResult.cpp.

bool OSResult::setNumberOfOtherConstraintResults	(	int	solIdx,
		int	numberOfOtherConstraintResults
	)

Set the [i]th optimization solution's other (non-standard/solver specific) constraint-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first. This method then allocates the memory for the new OtherConstraintResult objects

Parameters

solIdx	is the solution index
numberOfOtherConstraintResults	holds the number of OtherConstraintResult objects Each other objective result contains the name (required), an optional description (std::string) and an optional value (std::string). Each other constraint result can also optionally contain an array OtherConResult for each constraint. The OtherConResult contains a constraint idx (required) and an optional std::string value.

Returns: whether the other objective results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6156 of file OSResult.cpp.

bool OSResult::setNumberOfDualValues	(	int	solIdx,
		int	numberOfCon
	)

Set the number of constraints to be given a value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
numberOfCon	holds the number of constraint that are to be set

Returns: whether the information was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 6185 of file OSResult.cpp.

bool OSResult::setNumberOfDualVariableValues	(	int	solIdx,
		int	n
	)

Set the [i]th optimization solution's number of dual variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the dual variable values.
n	holds the number of elements in the array x

Returns: whether dual variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 6219 of file OSResult.cpp.

bool OSResult::setDualVariableValuesSparse	(	int	solIdx,
		std::vector< IndexValuePair * >	x
	)

Set the [i]th optimization solution's dual variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the dual variable values.
x	holds a vector of type IndexValuePair; the idx component holds the index of the constraint; the value component holds its value. The vector could be null if all dual variables are 0.

Returns: whether dual variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 6248 of file OSResult.cpp.

bool OSResult::setDualVariableValuesDense	(	int	solIdx,
		double *	y
	)

Set the [i]th optimization solution's dual variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the dual variable values.
y	holds a double dense array of variable dual values; it could be NULL if all values are 0.

Returns: whether dual variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 6291 of file OSResult.cpp.

bool OSResult::setConstraintValuesDense	(	int	solIdx,
		double *	constraintValues
	)

Set the [i]th optimization solution's constraint values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
constraintValues	holds the a double dense array of constraint values to set; it could be null if all constraint values are 0.

Returns: whether constraint values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 6335 of file OSResult.cpp.

bool OSResult::setDualValue	(	int	solIdx,
		int	number,
		int	idx,
		std::string	name,
		double	val
	)

Set a dual value.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
number	holds the location within the sparse array con that is to be used
idx	holds the index of the constraint that is to be set
name	holds the constraint name (or an empty string).
val	holds the constraint value to set.

Returns: whether dual variable value was set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 6379 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultNumberOfCon	(	int	solIdx,
		int	otherIdx,
		int	numberOfCon
	)

Set the number of <con> children of another (non-standard/solver specific) constraint-related result, for the [i]th solution.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
numberOfCon	holds the number of <con> children

Returns: whether the other constraint result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6424 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultNumberOfEnumerations	(	int	solIdx,
		int	otherIdx,
		int	numberOfCon
	)

Set the number of <enumeration> children of another (non-standard/solver specific) constraint-related result, for the [i]th solution.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
numberOfCon	holds the number of <con> children

Returns: whether the other constraint result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6447 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultName	(	int	solIdx,
		int	otherIdx,
		std::string	name
	)

Set the name of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
name	holds the name of the other element

Returns: whether the other constraint result's name was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6468 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultType	(	int	solIdx,
		int	otherIdx,
		std::string	type
	)

Set the type of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
name	holds the type of the <other> element

Returns: whether the other constraint result's type was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6487 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultConType	(	int	solIdx,
		int	otherIdx,
		std::string	conType
	)

Set the conType of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
name	holds the type of the <other> element's <con> array

Returns: whether the other constraint result's conType was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6506 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultEnumType	(	int	solIdx,
		int	otherIdx,
		std::string	enumType
	)

Set the enumType of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
name	holds the type of the <other> element's <enumeration> array

Returns: whether the other constraint result's enumType was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6525 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultValue	(	int	solIdx,
		int	otherIdx,
		std::string	value
	)

Set the value of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
value	holds the name of the other element

Returns: whether the other constraint result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6544 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultDescription	(	int	solIdx,
		int	otherIdx,
		std::string	description
	)

Set the description of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
description	holds the name of the other element

Returns: whether the other constraint result's description was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6563 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultSolver	(	int	solIdx,
		int	otherIdx,
		std::string	solver
	)

Set the solver of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
solver	holds the solver of the other element

Returns: whether the other constraint result's solver was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6582 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultCategory	(	int	solIdx,
		int	otherIdx,
		std::string	category
	)

Set the category of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
category	holds the category of the other element

Returns: whether the other constraint result's category was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6601 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultConIdx	(	int	solIdx,
		int	otherIdx,
		int	conIdx,
		int	idx
	)

Set the index of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
conIdx	holds the index of the location to which the information is stored
idx	holds the index of the onstraint to which the information belongs

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6620 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultConName	(	int	solIdx,
		int	otherIdx,
		int	conIdx,
		std::string	name
	)

Set the name of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
conIdx	holds the index of the location to which the information is stored
name	holds the name of the constraint to which the information belongs

Returns: whether the other variable result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6636 of file OSResult.cpp.

bool OSResult::setOtherConstraintResultCon	(	int	solIdx,
		int	otherIdx,
		int	conIdx,
		std::string	value
	)

Set the value of another (non-standard/solver specific) constraint-related result, for the [i]th solution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the OtherConstraintResult object
conIdx	holds the index of the location to which the information is stored
value	holds the value of the constraint to which the information belongs

Returns: whether the other constraint result's value was set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherConstraintResult; org.optimizationservices.oscommon.datastructure.osresult.OtherConResult; setSolutionNumber(int)

Definition at line 6651 of file OSResult.cpp.

bool OSResult::setMatrixVariableSolution	(	int	solIdx,
		int	numberOfMatrixVar_,
		int	numberOfOtherMatrixVariableResults_
	)

Set the [i]th optimization solution's MatrixVariableSolution, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first. This method then allocates the memory for the new MatrixVariableSolution objects. Further methods then store the values into the data structure.

Parameters

solIdx	is the solution index
numberOfMatrixVar_	holds the number of matrixVar elements for which values are to be provided
numberOfOtherMatrixVariableResults_	holds the number of <other> elements for which values are to be provided

Returns: whether the matrix variable results are set successfully or not.

Definition at line 6666 of file OSResult.cpp.

bool OSResult::setMatrixVarValuesAttributes	(	int	solIdx,
		int	idx,
		int	matrixVarIdx,
		int	numberOfRows,
		int	numberOfColumns,
		ENUM_MATRIX_SYMMETRY	symmetry = `ENUM_MATRIX_SYMMETRY_none`,
		ENUM_MATRIX_TYPE	type = `ENUM_MATRIX_TYPE_unknown`,
		std::string	name = `""`
	)

A method to set general attributes for a matrixVar in the [i]th optimization solution, where i equals the given solution index.

Before this method is called, the setMatrixVariableSolution() method has to be called first. This method then sets the matrix dimensions and other basic attributes. Further methods then store the values into the data structure.

Parameters

solIdx	is the solution index
idx	holds the index of the matrixVar (in the MatrixVariableValues array)
matrixVarIdx	holds the index of the matrixVar (as defined in the OS instance)
numberOfRows	holds the number of rows in the matrixVar
numberOfColumns	holds the number of columns in the matrixVar
symmetry	(optional) holds the type of symmetry (if not present, the default value is "none"
type	(optional) holds the type of values in the nonzeroes of the matrix (if not present, the default value is "unknown")
name	(optional) holds the name of this matrixVar (the default is the empty string) for which values are to be provided

Returns: whether the matrix variable attributes are set successfully or not.

Definition at line 6703 of file OSResult.cpp.

bool OSResult::setMatrixVarValuesBlockStructure	(	int	solIdx,
		int	idx,
		int *	colOffset,
		int	colOffsetSize,
		int *	rowOffset,
		int	rowOffsetSize,
		int	numberOfBlocks,
		int	blocksConstructorIdx = `0`
	)

A method to set the block structure for the values of a matrixVar in the [i]th optimization solution, where i equals the given solution index.

Before this method is called, the setMatrixVariableSolution() method has to be called first. This method then allocates the block structure for the new MatrixVar objects in the solution. Further methods then store the values into the data structure.

Parameters

solIdx	is the solution index
idx	holds the index of the matrixVar for which values are to be provided (as derived from the <values> element in matrixProgramming
colOffset	is an array of column offsets that define the partition of the columns within the block structure
colOffsetSize	gives the size of the colOffset array
rowOffset	is an array of row offsets that define the partition of the rows within the block structure
rowOffsetSize	gives the size of the rowOffset array
numberOfBlocks	gives the number of blocks
blocksConstructorIdx	gives the index of the MatrixBlocks node in the array of constructors of the matrixVar. The default is 0.

Returns: whether the matrix variable block structure was set successfully or not.

Definition at line 6737 of file OSResult.cpp.

bool OSResult::setMatrixVarValuesBlockElements	(	int	solIdx,
		int	idx,
		int	blkno,
		int	blkRowIdx,
		int	blkColIdx,
		int	nz,
		int *	start,
		int *	index,
		MatrixElementValues *	value,
		ENUM_MATRIX_TYPE	valueType,
		ENUM_MATRIX_SYMMETRY	symmetry = `ENUM_MATRIX_SYMMETRY_none`,
		bool	rowMajor = `false`
	)

A method to set the elements within a block of a matrixVar in the [i]th optimization solution, where i equals the given solution index.

Before this method is called, the setMatrixVarBlockStructure() method has to be called first. This method then allocates the elements for the new MatrixVar blocks in the solution.

Parameters

solIdx	is the solution index
idx	holds the index of the matrixVar for which values are to be provided (as derived from the <values> element in matrixProgramming
blkno	is the number of the block for which elements are provided the partition of the columns within the block structure
blkRowIdx	gives the index of the block row in which the block is located
blkColIdx	gives the index of the block column in which the block is located
nz	gives the number of (nonzero) values
start	gives the start elements (column or row starts, depending on whether rowMajor is false or true)
index	gives the array of row or column (depending on rowMajor) indices
value	gives the data structure for (nonzero) values that need to be stored
valueType	gives the type of values (see OSParameters.h)
symmetry	gives the form of symmetry. (The default is NONE.)
rowMajor	indicates whther the elements are stored column by column (if rowMajor is false) or row by row (if rowMajor is true). The default is rowMajor = false.

Remarks: each block object can handle only one type of elements, although different blocks may contain different types of values

Returns: whether the matrix variable block structure was set successfully or not.

Definition at line 6789 of file OSResult.cpp.

bool OSResult::setMatrixVariablesOtherResultGeneralAttributes	(	int	solIdx,
		int	idx,
		std::string	name,
		std::string	description,
		std::string	value,
		std::string	type,
		std::string	solver,
		std::string	category,
		int	numberOfMatrixVar = `0`,
		std::string	matrixType = `""`,
		int	numberOfEnumerations = `0`,
		std::string	enumType = `""`
	)

A method to set general attributes for another (non-standard/solver specific) result associated with the matrix variables in the [i]th optimization solution, where i equals the given solution index.

Before this method is called, the setMatrixVariableSolution() method has to be called first. This method then sets the matrix dimensions and other basic attributes. Further methods then store the values into the data structure.

Parameters

solIdx	is the solution index
idx	holds the index of the other result (in the array of <other> solutions)
name	holds the name of the <other> result
description	can be used to hold a further description of the result
value	holds a scalar value associated with the <other> result
type	describes the type of value represented by the scalar result
solver	gives the solver with which this result is associated
category	can be used to specify a further category within the solver
numberOfMatrixVar	gives the number of matrixVar elements associated with this result. This argument is optional and defaults to 0.
matrixType	can be used to associate a type with the values of the matrixVar elements. This argument is optional and defaults to the empty string ("").
numberOfEnumerations	gives the number of levels associated with an enumeration of matrixVar elements pertaining to this result. The argument is optional and defaults to 0.
enumType	can be used to associate a type with the values of the enumeration. This argument is optional and defaults to the empty string ("").

Returns: whether the attributes are set successfully or not.

Definition at line 6922 of file OSResult.cpp.

bool OSResult::setMatrixVariablesOtherResultMatrixAttributes	(	int	solIdx,
		int	otherIdx,
		int	matrixVarIdx,
		int	numberOfRows,
		int	numberOfColumns,
		ENUM_MATRIX_SYMMETRY	symmetry = `ENUM_MATRIX_SYMMETRY_none`,
		ENUM_MATRIX_TYPE	type = `ENUM_MATRIX_TYPE_unknown`,
		std::string	name = `""`
	)

A method to set attributes for a matrixVar in the [j]th other result associated with matrix variables in the the [i]th optimization solution, where i equals the given solution index and j equals a given other result index.

Before this method is called, the setMatrixVariableSolution() and setMatrixVariablesOtherResultGeneralAttributes() methods have to be called. This method then sets the matrix dimensions and other basic attributes. Further methods then store the values into the data structure.

Parameters

solIdx	is the solution index
otherIdx	holds the index of the other matrix variables result
matrixVarIdx	holds the index of the matrixVar (as defined in the OS instance)
numberOfRows	holds the number of rows in the matrixVar
numberOfColumns	holds the number of columns in the matrixVar
symmetry	(optional) holds the type of symmetry (if not present, the default value is "none"
type	(optional) holds the type of values in the nonzeroes of the matrix (if not present, the default value is "unknown")
name	(optional) holds the name of this matrixVar (the default is the empty string) for which values are to be provided

Returns: whether the matrix variable attributes are set successfully or not.

Definition at line 6979 of file OSResult.cpp.

bool OSResult::setMatrixVariablesOtherResultBlockStructure	(	int	solIdx,
		int	otherIdx,
		int	matrixVarIdx,
		int *	colOffset,
		int	colOffsetSize,
		int *	rowOffset,
		int	rowOffsetSize,
		int	numberOfBlocks,
		int	blocksConstructorIdx = `0`
	)

A method to set the block structure for the values of a matrixVar associated with the [j]th "other" result of the [i]th optimization solution, where i equals the given solution index, and j equals the index of the other result.

Before this method is called, the setMatrixVariableSolution() and setMatrixVariablesOtherSolutionAttributes() methods have to be called. This method then allocates the block structure for the new MatrixVar objects in the solution. Further methods then store the values into the data structure.

Parameters

solIdx	is the solution index
otherIdx	holds the index of the other solution
matrixVarIdx	holds the index of the matrixVar for which values are to be provided
colOffset	is an array of column offsets that define the partition of the columns within the block structure
colOffsetSize	gives the size of the colOffset array
rowOffset	is an array of row offsets that define the partition of the rows within the block structure
rowOffsetSize	gives the size of the rowOffset array
numberOfBlocks	gives the number of blocks
blocksConstructorIdx	gives the index of the MatrixBlocks node in the array of constructors of the matrixVar. The default is 0.

Returns: whether the matrix variable block structure was set successfully or not.

Definition at line 7021 of file OSResult.cpp.

bool OSResult::setMatrixVariablesOtherResultBlockElements	(	int	solIdx,
		int	otherIdx,
		int	matrixVarIdx,
		int	blkno,
		int	blkRowIdx,
		int	blkColIdx,
		int	nz,
		int *	start,
		int *	index,
		MatrixElementValues *	value,
		ENUM_MATRIX_TYPE	valueType,
		ENUM_MATRIX_SYMMETRY	symmetry = `ENUM_MATRIX_SYMMETRY_none`,
		bool	rowMajor = `false`
	)

A method to set the elements within a block of a matrixVar associated with the [j]th "other" result in the [i]th optimization solution, where i equals the given solution index and j equals the index of the other result.

Before this method is called, the setMatrixVariablesOtherResultBlockStructure() method has to be called first. This method then allocates the elements for the new MatrixVar blocks in the solution.

Parameters

solIdx	is the solution index
otherIdx	holds the index of the other solution
matrixVarIdx	holds the index of the matrixVar for which values are to be provided
blkno	is the number of the block for which elements are provided the partition of the columns within the block structure
blkRowIdx	gives the index of the block row in which the block is located
blkColIdx	gives the index of the block column in which the block is located
nz	gives the number of (nonzero) values
start	gives the start elements (column or row starts, depending on whether rowMajor is false or true)
index	gives the array of row or column (depending on rowMajor) indices
value	gives the data structure for (nonzero) values that need to be stored
valueType	gives the type of values (see OSParameters.h)
symmetry	gives the form of symmetry. (The default is NONE.)
rowMajor	indicates whther the elements are stored column by column (if rowMajor is false) or row by row (if rowMajor is true). The default is rowMajor = false.

Remarks: each block object can handle only one type of elements, although different blocks may contain different types of values

Returns: whether the matrix variable block structure was set successfully or not.

Definition at line 7077 of file OSResult.cpp.

bool OSResult::setNumberOfOtherSolutionResults	(	int	solIdx,
		int	numberOfOtherSolutionResults
	)

Set the [i]th optimization solution's other (non-standard/solver specific) solution-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first. This method then allocates the memory for the new OtherSolutionResult objects

Parameters

solIdx	is the solution index
numberOfOtherSolutionResults	holds the number of OtherSolutionResult objects Each other objective result contains the name (required), an optional description (std::string) and an optional category (std::string). Each other solution result can also optionally contain an array Item for each result. The Item content is string-valued.

Returns: whether the other objective results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherSolutionResult; org.optimizationservices.oscommon.datastructure.osresult.Item; setSolutionNumber(int)

Definition at line 7220 of file OSResult.cpp.

bool OSResult::setOtherSolutionResultName	(	int	solIdx,
		int	otherIdx,
		std::string	name
	)

Set the name associated with the [j]th other solution result of solution [i].

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
otherIdx	holds the index of the otherSolutionResult
name	holds the name of the otherSolutionResult

Returns: whether the other solution result was set successfully or not.

Definition at line 7249 of file OSResult.cpp.

bool OSResult::setOtherSolutionResultValue	(	int	solIdx,
		int	otherIdx,
		std::string	value
	)

Set the value associated with the [j]th other solution result of solution [i].

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
otherIdx	holds the index of the otherSolutionResult
value	holds the value of the otherSolutionResult

Returns: whether the other solution result was set successfully or not.

Definition at line 7263 of file OSResult.cpp.

bool OSResult::setOtherSolutionResultCategory	(	int	solIdx,
		int	otherIdx,
		std::string	category
	)

Set the category associated with the [j]th other solution result of solution [i].

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
otherIdx	holds the index of the otherSolutionResult
category	holds the category of the otherSolutionResult

Returns: whether the other solution result was set successfully or not.

Definition at line 7277 of file OSResult.cpp.

bool OSResult::setOtherSolutionResultDescription	(	int	solIdx,
		int	otherIdx,
		std::string	description
	)

Set the description associated with the [j]th other solution result of solution [i].

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
otherIdx	holds the index of the otherSolutionResult
category	holds the description of the otherSolutionResult

Returns: whether the other solution result was set successfully or not.

Definition at line 7292 of file OSResult.cpp.

bool OSResult::setOtherSolutionResultNumberOfItems	(	int	solIdx,
		int	otherIdx,
		int	numberOfItems
	)

Set the number of items associated with the [j]th other solution result of solution [i].

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
otherIdx	holds the index of the otherSolutionResult
numberOfItems	holds the number of items

Returns: whether the other solution result was set successfully or not.

Definition at line 7307 of file OSResult.cpp.

bool OSResult::setOtherSolutionResultItem	(	int	solIdx,
		int	otherIdx,
		int	itemIdx,
		std::string	item
	)

Set one item associated with the [j]th other solution result of solution [i].

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
otherIdx	holds the index of the otherSolutionResult
itemIdx	holds the index of the item
item	holds the value of the item

Returns: whether the other solution result item was set successfully or not.

Definition at line 7326 of file OSResult.cpp.

bool OSResult::setAnOtherSolutionResult	(	int	solIdx,
		std::string	name,
		std::string	value,
		std::string	category,
		std::string	description,
		int	numberOfItems,
		std::string *	item
	)

Set another solution result of solution [i].

Parameters

solIdx	holds the solution index i.
name	holds the name of the other solution result
value	holds the value of the other solution result
category	holds the category of the result
description	holds a description of the result
numberOfItems	holds the number of items
item	holds a pointer to the array of items (can be NULL if numberOfItems is 0)

Returns: whether the other solution result was set successfully or not.

Definition at line 7344 of file OSResult.cpp.

bool OSResult::setNumberOfSolverOutputs ( int numberOfSolverOutputs )

Set the number of other solver outputs.

Parameters

numberOfOtherSolverOutputs holds the number of SolverOutput objects Each solver output can also optionally contain an array Item for each result. The Item content is string-valued.

Returns: whether the results were set successfully or not.

Definition at line 7406 of file OSResult.cpp.

bool OSResult::setSolverOutputName	(	int	otherIdx,
		std::string	name
	)

Set the name associated with the [j]th solver output.

Parameters

otherIdx	holds the index of the solverOutput object
name	holds the name of the solver output

Returns: whether the solver output was set successfully or not.

Definition at line 7427 of file OSResult.cpp.

bool OSResult::setSolverOutputCategory	(	int	otherIdx,
		std::string	category
	)

Set the category associated with the [j]th solver output.

Parameters

otherIdx	holds the index of the solverOutput object
name	holds the category of the solver output

Returns: whether the solver output was set successfully or not.

Definition at line 7436 of file OSResult.cpp.

bool OSResult::setSolverOutputDescription	(	int	otherIdx,
		std::string	description
	)

Set the description associated with the [j]th solver output.

Parameters

otherIdx	holds the index of the solverOutput object
name	holds the description of the solver output

Returns: whether the solver output was set successfully or not.

Definition at line 7445 of file OSResult.cpp.

bool OSResult::setSolverOutputNumberOfItems	(	int	otherIdx,
		int	numberOfItems
	)

Set the number of items associated with the [j]th solver output.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

otherIdx	holds the index of the solverOutput object
numberOfItems	holds the number of items

Returns: whether the information was set successfully or not.

Definition at line 7454 of file OSResult.cpp.

bool OSResult::setSolverOutputItem	(	int	otherIdx,
		int	itemIdx,
		std::string	item
	)

Set one item associated with the [j]th solver output.

Parameters

otherIdx	holds the index of the otherSolutionResult
itemIdx	holds the index of the item
item	holds the value of the item

Returns: whether the information was set successfully or not.

Definition at line 7468 of file OSResult.cpp.

GeneralStatus* OSResult::getGeneralStatus ( )

Get the general status.

Returns: the general status.

std::string OSResult::getGeneralStatusType ( )

Get the general status type, which can be: success, error, warning.

Returns: the general status type, null if none.

std::string OSResult::getGeneralStatusDescription ( )

Get the general status description.

Returns: the general status description, null or empty std::string if none.

std::string OSResult::getServiceName ( )

Get service name.

Returns: the service name.

std::string OSResult::getServiceURI ( )

Get service uri.

Returns: the service uri.

std::string OSResult::getInstanceName ( )

Get instance name.

Returns: the instance name.

std::string OSResult::getJobID ( )

Get the job id.

Returns: the job id.

std::string OSResult::getGeneralMessage ( )

Get the general message.

Returns: the general message.

int OSResult::getTimeNumber ( )

Get the number of time measurements.

Returns: the number of time measurements

double OSResult::getTimeValue ( )

Get the time measurement.

In the first instance, assume that there is only a single measure, which is the total elapsed time in seconds

Returns: the time measurement

double* OSResult::getOptimalPrimalVariableValues ( int objIdx )

Get one solution of optimal primal variable values.

Parameters

objIdx holds the objective index the optimal value corresponds to.

Returns: a double dense array of the optimal values, null if no optimal value.

double* OSResult::getOptimalDualVariableValues ( int objIdx )

Get one solution of optimal dual variable values.

Parameters

objIdx holds the objective index the optimal value corresponds to.

Returns: a double dense array of the optimal dual values, null if no optimal value.

OptimizationSolutionStatus* OSResult::getSolutionStatus ( int solIdx )

Get the [i]th optimization solution status, where i equals the given solution index.

The solution status includes the status type, optional descriptions and possibly substatuses.

Parameters

solIdx holds the solution index to get the solution status.

Returns: the optimization solution status that corresponds to solIdx, null if none.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OptimizationSolutionStatus

std::string OSResult::getSolutionStatusType ( int solIdx )

Get the [i]th optimization solution status type, where i equals the given solution index.

The solution status type can be: unbounded, globallyOptimal, locallyOptimal, optimal, bestSoFar, feasible, infeasible, stoppedByLimit, unsure, error, other

Parameters

solIdx holds the solution index to get the solution status type.

Returns: the optimization solution status type that corresponds to solIdx, null or empty std::string if none.

std::string OSResult::getSolutionStatusDescription ( int solIdx )

Get the [i]th optimization solution status description, where i equals the given solution index.

Parameters

solIdx holds the solution index to get the solution status description.

Returns: the optimization solution status description that corresponds to solIdx, null or empty std::string if none.

std::string OSResult::getSolutionMessage ( int solIdx )

Get the [i]th optimization solution message, where i equals the given solution index.

Parameters

solIdx holds the solution index to get the solution message.

Returns: the optimization solution message that corresponds to solIdx, null or empty if none.

int OSResult::getVariableNumber ( )

Get variable number.

Returns: variable number, -1 if no information.

int OSResult::getObjectiveNumber ( )

Get objective number.

Returns: objective number, -1 if no information.

int OSResult::getConstraintNumber ( )

Get constraint number.

Returns: constraint number, -1 if no information.

int OSResult::getSolutionNumber ( )

get the number of solutions.

Returns: the number of solutions, 0 if none.

int OSResult::getNumberOfOtherVariableResults ( int solIdx )

Get numberOfOtherVariableResult.

Returns: numberOfOtherVariableResult, -1 if no information.

bool OSResult::setGeneralStatus ( GeneralStatus * status )

Set the general status.

Parameters

status holds the general status.

Returns: whether the general status is set successfully.

bool OSResult::setGeneralStatusType ( std::string type )

Set the general status type, which can be: success, error, warning.

Parameters

type	holds the general status type

Returns: whether the general status type is set successfully or not.

bool OSResult::setGeneralStatusDescription ( std::string description )

Set the general status description.

Parameters

description holds the general status description.

Returns: whether the general status description is set successfully or not.

bool OSResult::setGeneralMessage ( std::string message )

Set the general message.

Parameters

message holds the general message.

Returns: whether process message is set successfully.

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

Set service name.

Parameters

serviceName holds the name of the service.

Returns: whether the service name is set successfully.

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

Set service uri.

Parameters

serviceURI holds the uri of the service.

Returns: whether the service uri is set successfully.

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

Set instance name.

Parameters

instanceName holds the name of the instance.

Returns: whether the instance name is set successfully.

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

Set job id.

Parameters

jobID holds the job id.

Returns: whether the job id is set successfully.

bool OSResult::setTime ( double time )

Set time.

Parameters

time	holds the time.

Returns: whether the time is set successfully.

bool OSResult::addTimingInformation	(	std::string	type,
		std::string	category,
		std::string	unit,
		std::string	description,
		double	value
	)

Add timing information.

Parameters

type	holds the timer type (cpuTime/elapsedTime/other).
category	holds the timer category (total/input/preprocessing, etc.)
unit	holds the timer unit (tick/milliscond/second/minute/etc.)
description	holds further information about the timer.
value	holds the time measurement.

Returns: whether the time is set successfully.

bool OSResult::setTimeNumber ( int timeNumber )

Set the number of time measurements.

Parameters

timeNumber holds the number of measurements

Returns: whether the time number is set successfully or not.

bool OSResult::setVariableNumber ( int variableNumber )

Set the variable number.

Parameters

variableNumber holds the number of variables

Returns: whether the variable number is set successfully or not.

bool OSResult::setObjectiveNumber ( int objectiveNumber )

Set the objective number.

Parameters

objectiveNumber holds the number of objectives

Returns: whether the objective number is set successfully or not.

bool OSResult::setConstraintNumber ( int constraintNumber )

Set the constraint number.

Parameters

constraintNumber holds the number of constraints

Returns: whether the constraint number is set successfully or not.

bool OSResult::setSolutionNumber ( int number )

set the number of solutions.

This method must be called before setting other optimization solution related results. Before this method is called, the setVariableNumber(int), setObjectiveNumber(int), setConstraintNumber(int) methods have to be called first.

Parameters

number holds the number of solutions to set.

Returns: whether the solution number is set successfully.

See Also: setVariableNumber(int); setObjectiveNumber(int); setConstraintNumber(int)

bool OSResult::setSolutionStatus	(	int	solIdx,
		std::string	type,
		std::string	description
	)

Set the [i]th optimization solution status, where i equals the given solution index.

The solution status includes the status type, optional descriptions and possibly substatuses. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the solution status.
status	holds the optimization solution status to set.

Returns: whether the optimization solution status is set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OptimizationSolutionStatus; setSolutionNumber(int)

bool OSResult::setSolutionObjectiveIndex	(	int	solIdx,
		int	objectiveIdx
	)

Set the [i]th optimization solution's objective index, where i equals the given solution index.

The first objective's index should be -1, the second -2, and so on. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective index.
objectiveIdx	holds the objective index to set. All the objective indexes are negative starting from -1 downward.

Returns: whether the optimization objective index is set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 990 of file OSResult.cpp.

bool OSResult::setNumberOfPrimalVariableValues	(	int	solIdx,
		int	n
	)

Set the [i]th optimization solution's number of primal variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
n	holds the number of elements in the array x

Returns: whether primal variable values are set successfully or not.

See Also: setSolutionNumber(int)

bool OSResult::setPrimalVariableValues	(	int	solIdx,
		double *	x,
		int	n
	)

Set the [i]th optimization solution's primal variable values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the primal variable values.
x	holds the a double dense array of variable values to set; it could be null if all variables are 0.
n	holds the number of elements in the array x

Returns: whether primal variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 1028 of file OSResult.cpp.

bool OSResult::setNumberOfOtherVariableResults	(	int	solIdx,
		int	numberOfOtherVariableResults
	)

Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first. This method then allocates the memory for the new OtherVariableResult objects

Parameters

solIdx	is the solution index
numberOfOtherVariableResult	holds the number of OtherVariableResult objects Each other variable result contains the name (required), an optional description (std::string) and an optional value (std::string). Each other variable result can also optionally contain an array OtherVarResult for each variable. The OtherVarResult contains a variable idx (required) and an optional std::string value.

Returns: whether the other variable results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

bool OSResult::setAnOtherVariableResult	(	int	solIdx,
		int	otherIdx,
		std::string	name,
		std::string	description,
		int *	indexes,
		std::string *	s,
		int	n
	)

Set the [i]th optimization solution's other (non-standard/solver specific)variable-related results, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index
otherIdx	holds the index of the new OtherVariableResult object
name	holds the name of the other element
s	holds a pointer to the array of values of the var element
n	holds the number of elements of the array

Returns: whether the other variable results are set successfully or not.

See Also: org.optimizationservices.oscommon.datastructure.osresult.OtherVariableResult; org.optimizationservices.oscommon.datastructure.osresult.OtherVarResult; setSolutionNumber(int)

Definition at line 1080 of file OSResult.cpp.

bool OSResult::setObjectiveValues	(	int	solIdx,
		double *	objectiveValues,
		int	n
	)

Set the [i]th optimization solution's objective values, where i equals the given solution index.

Usually one of the objective is what the solution was solved for (or based on). Its index should be indicated in the solution's objectiveIdx attribute. Based on this objective's solution, the rest of the objective values are (optionally) calculated. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the objective values.
objectiveValues	holds the a double dense array of objective values to set. Possibly only the objective that the solution is based on has the value, and the rest of the objective values all get a Double.NaN value, meaning that they are not calculated.
n	holds the dimension of the objectiveValues array

Returns: whether objective values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 1130 of file OSResult.cpp.

bool OSResult::setDualVariableValues	(	int	solIdx,
		double *	lbValues,
		double *	ubValues,
		int	n
	)

Set the [i]th optimization solution's dual variable values, where i equals the given solution index.

The method allows setting dual values at both the constraints' lower and upper bounds. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the dual variable values.
lbValues	holds the a double dense array of variable dual values to set at the lower bounds; it could be null if all values are 0.
ubValues	holds the a double dense array of variable dual values to set at the upper bounds; it could be null if all values are 0.
n	holds the number of values in the lbValues and ubValues arrays

Returns: whether dual variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 1184 of file OSResult.cpp.

bool OSResult::setDualVariableValues	(	int	solIdx,
		double *	y,
		int	n
	)

Set the [i]th optimization solution's dual variable values, where i equals the given solution index.

The method allows setting dual values at both the constraints' lower and upper bounds. Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the dual variable values.
y	holds a double dense array of variable dual values; it could be NULL if all values are 0.
n	holds the number of elements of the array y.

Returns: whether dual variable values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 1261 of file OSResult.cpp.

bool OSResult::setConstraintValues	(	int	solIdx,
		double *	constraintValues,
		int	n
	)

Set the [i]th optimization solution's constraint values, where i equals the given solution index.

Before this method is called, the setSolutionNumber(int) method has to be called first.

Parameters

solIdx	holds the solution index to set the constraint values.
constraintValues	holds the a double dense array of constraint values to set; it could be null if all constraint values are 0.
n	holds the dimension of the array constraintValues.

Returns: whether constraint values are set successfully or not.

See Also: setSolutionNumber(int)

Definition at line 1293 of file OSResult.cpp.

Member Data Documentation

GeneralFileHeader* OSResult::resultHeader

header information

Definition at line 2556 of file OSResult.h.

GeneralResult * OSResult::general

general holds the first child of the OSResult specified by the OSrL Schema.

Definition at line 2561 of file OSResult.h.

SystemResult * OSResult::system

system holds the second child of the OSResult specified by the OSrL Schema.

Definition at line 2566 of file OSResult.h.

ServiceResult * OSResult::service

service holds the third child of the OSResult specified by the OSrL Schema.

Definition at line 2571 of file OSResult.h.

JobResult * OSResult::job

job holds the fourth child of the OSResult specified by the OSrL Schema.

Definition at line 2576 of file OSResult.h.

OptimizationResult * OSResult::optimization

optimization holds the fifth child of the OSResult specified by the OSrL Schema.

Definition at line 2581 of file OSResult.h.

int OSResult::m_iVariableNumber

m_iVariableNumber holds the variable number.

Definition at line 2614 of file OSResult.h.

int OSResult::m_iObjectiveNumber

m_iObjectiveNumber holds the objective number.

Definition at line 2619 of file OSResult.h.

int OSResult::m_iConstraintNumber

m_iConstraintNumber holds the constraint number.

Definition at line 2624 of file OSResult.h.

int OSResult::m_iNumberOfOtherVariableResults

m_iNumberOfOtherVariableResults holds the number of OtherVariableResult objects.

Definition at line 2629 of file OSResult.h.

double * OSResult::m_mdPrimalValues

m_mdPrimalValues a vector of primal variables.

Definition at line 2634 of file OSResult.h.

double * OSResult::m_mdDualValues

m_mdDualValues a vector of dual variables.

m_mdDualValues a vector of primal variables.

Definition at line 2639 of file OSResult.h.

std::vector<IndexValuePair*> OSResult::primalVals

Definition at line 2642 of file OSResult.h.

std::vector<IndexValuePair*> OSResult::dualVals

Definition at line 2644 of file OSResult.h.

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

/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSResult.h
/tmp/OS-2.10.2/OS/v2.0/OSResult.h
/tmp/OS-2.10.2/OS/src/OSCommonInterfaces/OSResult.cpp
/tmp/OS-2.10.2/OS/v2.0/OSResult.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation