OS  2.10.1
Public Member Functions | Public Attributes | List of all members
OptimizationSolution Class Reference

The OptimizationSolution Class. More...

#include <OSResult.h>

+ Collaboration diagram for OptimizationSolution:

Public Member Functions

 OptimizationSolution ()
 Default constructor. More...
 
 ~OptimizationSolution ()
 Class destructor. More...
 
bool IsEqual (OptimizationSolution *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...
 

Public Attributes

int targetObjectiveIdx
 the index of the objective function for which we are reporting solution information More...
 
std::string targetObjectiveName
 an optional name of the objective function for which we are reporting solution information More...
 
bool weightedObjectives
 a marker to track whether the objectives are weighted More...
 
OptimizationSolutionStatus * status
 status is a pointer to an OptimizationSolutionStatus object associated with this optimization solution More...
 
std::string message
 a message associated with this solution More...
 
VariableSolution * variables
 variables holds the solution information for the variables More...
 
ConstraintSolution * constraints
 constraints holds the solution information for the constraints More...
 
ObjectiveSolution * objectives
 objectives holds the solution information for the objectives More...
 
MatrixProgrammingSolution * matrixProgramming
 matrixProgramming holds the solution information for the matrix programming components: matrix variables, matrix objectives and matrix constraints More...
 
OtherSolutionResults * otherSolutionResults
 otherSolutionResults is a pointer to an OtherSolutionResults object that is associated with this optimization solution More...
 

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 2263 of file OSResult.h.

Constructor & Destructor Documentation

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.

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

A function to make a random instance of this class.

Parameters
densitycorresponds to the probability that a particular child element is created
conformantif true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Member Data Documentation

int OptimizationSolution::targetObjectiveIdx

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

Definition at line 2270 of file OSResult.h.

std::string OptimizationSolution::targetObjectiveName

an optional name of the objective function for which we are reporting solution information

Definition at line 2275 of file OSResult.h.

bool OptimizationSolution::weightedObjectives

a marker to track whether the objectives are weighted

Definition at line 2278 of file OSResult.h.

OptimizationSolutionStatus* OptimizationSolution::status

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

Definition at line 2283 of file OSResult.h.

std::string OptimizationSolution::message

a message associated with this solution

Definition at line 2286 of file OSResult.h.

VariableSolution* OptimizationSolution::variables

variables holds the solution information for the variables

Definition at line 2291 of file OSResult.h.

ConstraintSolution* OptimizationSolution::constraints

constraints holds the solution information for the constraints

Definition at line 2295 of file OSResult.h.

ObjectiveSolution* OptimizationSolution::objectives

objectives holds the solution information for the objectives

Definition at line 2300 of file OSResult.h.

MatrixProgrammingSolution* OptimizationSolution::matrixProgramming

matrixProgramming holds the solution information for the matrix programming components: matrix variables, matrix objectives and matrix constraints

Definition at line 2306 of file OSResult.h.

OtherSolutionResults* OptimizationSolution::otherSolutionResults

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

Definition at line 2311 of file OSResult.h.


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