VarValue Class Reference

VarValue Class. More...

#include <OSResult.h>

Collaboration diagram for VarValue:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Public Attributes

int idx
 idx is the index on variable in the solution
std::string name
 optional name
double value

Detailed Description

VarValue Class.

Author:
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 03/14/2004
Since:
OS 1.0
Remarks:
A class that is used to provide the value and index associated with the variables in the solution.

Definition at line 846 of file OSResult.h.


Constructor & Destructor Documentation

VarValue::VarValue (  ) 

Default constructor.

Definition at line 412 of file OSResult.cpp.

VarValue::~VarValue (  ) 

Class destructor.

Definition at line 423 of file OSResult.cpp.

VarValue::VarValue (  ) 

Default constructor.

VarValue::~VarValue (  ) 

Class destructor.


Member Function Documentation

bool VarValue::IsEqual ( VarValue that  ) 

A function to check for the equality of two objects.

Definition at line 6858 of file OSResult.cpp.

References idx, isEqual(), name, and value.

bool VarValue::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" atrbutes and <XXX> children)

Definition at line 8508 of file OSResult.cpp.

References OSRand().

Referenced by VariableValues::setRandom().


Member Data Documentation

int VarValue::idx

idx is the index on variable in the solution

Definition at line 851 of file OSResult.h.

Referenced by OSResult::getOptimalPrimalVariableValues(), OSResult::getVarValueIdx(), IsEqual(), OSResult::setPrimalVariableValues(), OSResult::setPrimalVariableValuesDense(), OSResult::setPrimalVariableValuesSparse(), OSResult::setVarValue(), and OSrL2Gams::writeSolution().

std::string VarValue::name

optional name

Definition at line 854 of file OSResult.h.

Referenced by OSResult::getVarValueName(), IsEqual(), and OSResult::setVarValue().

double VarValue::value

Definition at line 859 of file OSResult.h.

Referenced by OSResult::getOptimalPrimalVariableValues(), OSResult::getVarValue(), IsEqual(), OSResult::setPrimalVariableValues(), OSResult::setPrimalVariableValuesDense(), OSResult::setPrimalVariableValuesSparse(), OSResult::setVarValue(), and OSrL2Gams::writeSolution().


The documentation for this class was generated from the following files:
Generated on Thu Sep 22 03:14:07 2011 by  doxygen 1.4.7