My Project
Public Member Functions | Public Attributes | List of all members
OptimizationSolution Class Reference

The OptimizationSolution Class. More...

#include <OSResult.h>

Public Member Functions

 OptimizationSolution ()
 Default constructor.
 
 ~OptimizationSolution ()
 Class destructor.
 
bool IsEqual (OptimizationSolution *that)
 A function to check for the equality of two objects.
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class.
 
 OptimizationSolution ()
 Default constructor.
 
 ~OptimizationSolution ()
 Class destructor.
 

Public Attributes

int targetObjectiveIdx
 the index of the objective function for which we are reporting solution information
 
std::string targetObjectiveName
 an optional name of the objective function for which we are reporting solution information
 
bool weightedObjectives
 a marker to track whether the objectives are weighted
 
OptimizationSolutionStatus * status
 status is a pointer to an OptimizationSolutionStatus object associated with this optimization solution
 
std::string message
 a message associated with this solution
 
VariableSolution * variables
 variables holds the solution information for the variables
 
ConstraintSolution * constraints
 constraints holds the solution information for the constraints
 
ObjectiveSolution * objectives
 objectives holds the solution information for the objectives
 
MatrixProgrammingSolution * matrixProgramming
 matrixProgramming holds the solution information for the matrix programming components: matrix variables, matrix objectives and matrix constraints
 
OtherSolutionResults * otherSolutionResults
 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
 
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.
Author
Robert Fourer, 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() [1/2]

OptimizationSolution::OptimizationSolution ( )

Default constructor.

Definition at line 1219 of file OSResult.cpp.

◆ ~OptimizationSolution() [1/2]

OptimizationSolution::~OptimizationSolution ( )

Class destructor.

Definition at line 1238 of file OSResult.cpp.

◆ OptimizationSolution() [2/2]

OptimizationSolution::OptimizationSolution ( )

Default constructor.

◆ ~OptimizationSolution() [2/2]

OptimizationSolution::~OptimizationSolution ( )

Class destructor.

Member Function Documentation

◆ IsEqual()

bool OptimizationSolution::IsEqual ( OptimizationSolution * that)

A function to check for the equality of two objects.

Definition at line 8175 of file OSResult.cpp.

◆ setRandom()

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)

Definition at line 10113 of file OSResult.cpp.

Member Data Documentation

◆ targetObjectiveIdx

int OptimizationSolution::targetObjectiveIdx

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

Definition at line 2270 of file OSResult.h.

◆ targetObjectiveName

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.

◆ weightedObjectives

bool OptimizationSolution::weightedObjectives

a marker to track whether the objectives are weighted

Definition at line 2278 of file OSResult.h.

◆ status

OptimizationSolutionStatus * OptimizationSolution::status

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

Definition at line 2283 of file OSResult.h.

◆ message

std::string OptimizationSolution::message

a message associated with this solution

Definition at line 2286 of file OSResult.h.

◆ variables

VariableSolution * OptimizationSolution::variables

variables holds the solution information for the variables

Definition at line 2291 of file OSResult.h.

◆ constraints

ConstraintSolution * OptimizationSolution::constraints

constraints holds the solution information for the constraints

Definition at line 2295 of file OSResult.h.

◆ objectives

ObjectiveSolution * OptimizationSolution::objectives

objectives holds the solution information for the objectives

Definition at line 2300 of file OSResult.h.

◆ matrixProgramming

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

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.

◆ numberOfOtherResults

int OptimizationSolution::numberOfOtherResults

the number of other results associated with this solution

Definition at line 1192 of file OSResult.h.

◆ other

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

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

Definition at line 1220 of file OSResult.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.12.0