OptimizationSolution Class Reference

The OptimizationSolution Class. More...

#include <OSResult.h>

Collaboration diagram for OptimizationSolution:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OptimizationSolution ()
 Default constructor.
 ~OptimizationSolution ()
 Class destructor.
bool IsEqual (OptimizationSolution *that)
 A function to check for the equality of two objects.
 OptimizationSolution ()
 Default constructor.
 ~OptimizationSolution ()
 Class destructor.

Public Attributes

int targetObjectiveIdx
 the index of the objective function for which we are reporting solution information
bool weightedObjectives
 a marker to track whether the objectives are weighted
OptimizationSolutionStatusstatus
 status is a pointer to an OptimizationSolutionStatus object associated with this optimization solution
std::string message
 a message associated with this solution
VariableSolutionvariables
 variables holds the solution information for the variables
ObjectiveSolutionobjectives
 objectives holds the solution information for the objectives
ConstraintSolutionconstraints
 constraints holds the solution information for the constraints
OtherSolutionResultsotherSolutionResults
 otherSolutionResults is a pointer to an OtherSolutionResults object that is associated with this optimization solution
int numberOfOtherResults
 the number of other results associated with this solution
OptimizationSolutionStatusstatus
 status is a pointer to an OptimizationSolutionStatus object associated with this optimization solution
VariableSolutionvariables
 variables holds the solution information for the variables
ObjectiveSolutionobjectives
 objectives holds the solution information for the objectives
ConstraintSolutionconstraints
 constraints holds the solution information for the constraints
std::vector< OtherOptimizationResult * > other
 other is a pointer to an array of OtherOptimizationResult objects associated with this optimization solution

Detailed Description

The OptimizationSolution Class.

Author:
Horand Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 03/14/2004
Since:
OS 1.0
Remarks:
A class for reporting the various components of an optimization solution.

Definition at line 1799 of file OSResult.h.


Constructor & Destructor Documentation

OptimizationSolution::OptimizationSolution (  ) 

Default constructor.

Definition at line 940 of file OSResult.cpp.

OptimizationSolution::~OptimizationSolution (  ) 

Class destructor.

Definition at line 957 of file OSResult.cpp.

References constraints, objectives, otherSolutionResults, status, and variables.

OptimizationSolution::OptimizationSolution (  ) 

Default constructor.

OptimizationSolution::~OptimizationSolution (  ) 

Class destructor.


Member Function Documentation

bool OptimizationSolution::IsEqual ( OptimizationSolution that  ) 

A function to check for the equality of two objects.

Definition at line 5297 of file OSResult.cpp.

References constraints, message, objectives, otherSolutionResults, status, targetObjectiveIdx, variables, and weightedObjectives.


Member Data Documentation

int OptimizationSolution::targetObjectiveIdx

the index of the objective function for which we are reporting solution information

Definition at line 1805 of file OSResult.h.

Referenced by OSResult::getSolutionTargetObjectiveIdx(), IsEqual(), OSResult::setSolutionObjectiveIndex(), and OSResult::setSolutionTargetObjectiveIdx().

bool OptimizationSolution::weightedObjectives

a marker to track whether the objectives are weighted

Definition at line 1808 of file OSResult.h.

Referenced by OSResult::getSolutionWeightedObjectives(), IsEqual(), and OSResult::setSolutionWeightedObjectives().

OptimizationSolutionStatus* OptimizationSolution::status

status is a pointer to an OptimizationSolutionStatus object associated with this optimization solution

Definition at line 1813 of file OSResult.h.

Referenced by OSResult::getNumberOfSolutionSubstatuses(), OSResult::getOptimalDualVariableValues(), OSResult::getOptimalPrimalVariableValues(), OSResult::getSolutionStatus(), OSResult::getSolutionStatusDescription(), OSResult::getSolutionStatusType(), OSResult::getSolutionSubstatusDescription(), OSResult::getSolutionSubstatusType(), IsEqual(), OSResult::setNumberOfSolutionSubstatuses(), OSResult::setSolutionStatusDescription(), OSResult::setSolutionStatusType(), OSResult::setSolutionSubstatusDescription(), OSResult::setSolutionSubstatusType(), and ~OptimizationSolution().

std::string OptimizationSolution::message

a message associated with this solution

Definition at line 1816 of file OSResult.h.

Referenced by OSResult::getSolutionMessage(), IsEqual(), and OSResult::setSolutionMessage().

VariableSolution* OptimizationSolution::variables

variables holds the solution information for the variables

Definition at line 1821 of file OSResult.h.

Referenced by OSResult::getAnOtherVariableResultNumberOfVar(), OSResult::getNumberOfOtherVariableResults(), OSResult::getNumberOfPrimalVariableValues(), OSResult::getNumberOfVarValues(), OSResult::getNumberOfVarValuesString(), OSResult::getOptimalPrimalVariableValues(), OSResult::getOtherVariableResultDescription(), OSResult::getOtherVariableResultName(), OSResult::getOtherVariableResultNumberOfVar(), OSResult::getOtherVariableResultValue(), OSResult::getOtherVariableResultVar(), OSResult::getOtherVariableResultVarIdx(), OSResult::getVarValue(), OSResult::getVarValueIdx(), OSResult::getVarValueString(), OSResult::getVarValueStringIdx(), IsEqual(), main(), OSResult::setBasisStatus(), OSResult::setNumberOfOtherVariableResults(), OSResult::setNumberOfPrimalVariableValues(), OSResult::setNumberOfVarValues(), OSResult::setNumberOfVarValuesString(), OSResult::setOtherOptionEnumeration(), OSResult::setOtherVariableResultDescription(), OSResult::setOtherVariableResultName(), OSResult::setOtherVariableResultNumberOfEnumerations(), OSResult::setOtherVariableResultNumberOfVar(), OSResult::setOtherVariableResultValue(), OSResult::setOtherVariableResultVar(), OSResult::setOtherVariableResultVarIdx(), OSResult::setPrimalVariableValues(), OSResult::setPrimalVariableValuesDense(), OSResult::setPrimalVariableValuesSparse(), OSResult::setVarValue(), OSResult::setVarValueString(), OSrL2Gams::writeSolution(), and ~OptimizationSolution().

ObjectiveSolution* OptimizationSolution::objectives

objectives holds the solution information for the objectives

Definition at line 1826 of file OSResult.h.

Referenced by OSResult::getNumberOfObjValues(), OSResult::getNumberOfOtherObjectiveResults(), OSResult::getObjValue(), OSResult::getObjValueIdx(), OSResult::getOtherObjectiveResultDescription(), OSResult::getOtherObjectiveResultName(), OSResult::getOtherObjectiveResultNumberOfObj(), OSResult::getOtherObjectiveResultObj(), OSResult::getOtherObjectiveResultObjIdx(), OSResult::getOtherObjectiveResultValue(), IsEqual(), main(), OSResult::setBasisStatus(), OSResult::setNumberOfObjectiveValues(), OSResult::setNumberOfObjValues(), OSResult::setNumberOfOtherObjectiveResults(), OSResult::setObjectiveValues(), OSResult::setObjectiveValuesDense(), OSResult::setObjectiveValuesSparse(), OSResult::setObjValue(), OSResult::setOtherObjectiveResultDescription(), OSResult::setOtherObjectiveResultName(), OSResult::setOtherObjectiveResultNumberOfEnumerations(), OSResult::setOtherObjectiveResultNumberOfObj(), OSResult::setOtherObjectiveResultObj(), OSResult::setOtherObjectiveResultObjIdx(), OSResult::setOtherObjectiveResultValue(), OSResult::setOtherOptionEnumeration(), and ~OptimizationSolution().

ConstraintSolution* OptimizationSolution::constraints

constraints holds the solution information for the constraints

Definition at line 1831 of file OSResult.h.

Referenced by OSResult::getDualValue(), OSResult::getDualValueIdx(), OSResult::getNumberOfDualValues(), OSResult::getNumberOfOtherConstraintResults(), OSResult::getOptimalDualVariableValues(), OSResult::getOtherConstraintResultCon(), OSResult::getOtherConstraintResultConIdx(), OSResult::getOtherConstraintResultDescription(), OSResult::getOtherConstraintResultName(), OSResult::getOtherConstraintResultNumberOfCon(), OSResult::getOtherConstraintResultValue(), IsEqual(), OSResult::setBasisStatus(), OSResult::setConstraintValues(), OSResult::setConstraintValuesDense(), OSResult::setDualValue(), OSResult::setDualVariableValues(), OSResult::setDualVariableValuesDense(), OSResult::setDualVariableValuesSparse(), OSResult::setNumberOfDualValues(), OSResult::setNumberOfDualVariableValues(), OSResult::setNumberOfOtherConstraintResults(), OSResult::setOtherConstraintResultCon(), OSResult::setOtherConstraintResultConIdx(), OSResult::setOtherConstraintResultDescription(), OSResult::setOtherConstraintResultName(), OSResult::setOtherConstraintResultNumberOfCon(), OSResult::setOtherConstraintResultNumberOfEnumerations(), OSResult::setOtherConstraintResultValue(), OSResult::setOtherOptionEnumeration(), OSrL2Gams::writeSolution(), and ~OptimizationSolution().

OtherSolutionResults* OptimizationSolution::otherSolutionResults

otherSolutionResults is a pointer to an OtherSolutionResults object that is associated with this optimization solution

Definition at line 1836 of file OSResult.h.

Referenced by OSResult::getNumberOfOtherSolutionResults(), OSResult::getOtherSolutionResultCategory(), OSResult::getOtherSolutionResultDescription(), OSResult::getOtherSolutionResultItem(), OSResult::getOtherSolutionResultName(), OSResult::getOtherSolutionResultNumberOfItems(), IsEqual(), OSResult::setNumberOfOtherSolutionResults(), OSResult::setOtherSolutionResultCategory(), OSResult::setOtherSolutionResultDescription(), OSResult::setOtherSolutionResultItem(), OSResult::setOtherSolutionResultName(), OSResult::setOtherSolutionResultNumberOfItems(), and ~OptimizationSolution().

int OptimizationSolution::numberOfOtherResults

the number of other results associated with this solution

Definition at line 1193 of file OSResult.h.

OptimizationSolutionStatus* OptimizationSolution::status

status is a pointer to an OptimizationSolutionStatus object associated with this optimization solution

Definition at line 1198 of file OSResult.h.

VariableSolution* OptimizationSolution::variables

variables holds the solution information for the variables

Definition at line 1206 of file OSResult.h.

ObjectiveSolution* OptimizationSolution::objectives

objectives holds the solution information for the objectives

Definition at line 1211 of file OSResult.h.

ConstraintSolution* OptimizationSolution::constraints

constraints holds the solution information for the constraints

Definition at line 1216 of file OSResult.h.

std::vector<OtherOptimizationResult*> OptimizationSolution::other

other is a pointer to an array of OtherOptimizationResult objects associated with this optimization solution

Definition at line 1221 of file OSResult.h.


The documentation for this class was generated from the following files:
Generated on Sun Jan 2 03:06:23 2011 by  doxygen 1.4.7