OS  2.9.3
Public Member Functions | Public Attributes | List of all members
InitObjectiveBounds Class Reference

the InitObjectiveBounds class. More...

#include <OSOption.h>

+ Collaboration diagram for InitObjectiveBounds:

Public Member Functions

 InitObjectiveBounds ()
 Default constructor. More...
 
 ~InitObjectiveBounds ()
 Class destructor. More...
 
bool IsEqual (InitObjectiveBounds *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...
 
bool deepCopyFrom (InitObjectiveBounds *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setObj (int numberOfObj, InitObjBound **obj)
 A function to set an array of <obj> elements. More...
 
bool setObj (int numberOfObj, InitObjBound **obj, ENUM_COMBINE_ARRAYS disp)
 Alternative signature for this function. More...
 
bool setObj (int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name)
 Another alternative signature for this function. More...
 
bool addObj (int idx, double lbValue, double ubValue)
 A function to add a <obj> element. More...
 
bool addObj (int numberOfObj, InitObjBound **obj)
 Alternative signature for this function. More...
 

Public Attributes

int numberOfObj
 number of <obj> children More...
 
InitObjBound ** obj
 initial bounds for each objective More...
 

Detailed Description

the InitObjectiveBounds class.

Author
Robert Fourer, Horand Gassmann, Jun Ma, Kipp Martin
Version
1.0, 21/07/2008
Since
OS 1.1
Remarks
A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 2405 of file OSOption.h.

Constructor & Destructor Documentation

InitObjectiveBounds::InitObjectiveBounds ( )

Default constructor.

InitObjectiveBounds::~InitObjectiveBounds ( )

Class destructor.

Member Function Documentation

bool InitObjectiveBounds::IsEqual ( InitObjectiveBounds that)

A function to check for the equality of two objects.

bool InitObjectiveBounds::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)
bool InitObjectiveBounds::deepCopyFrom ( InitObjectiveBounds that)

A function to make a deep copy of an instance of this class.

Parameters
thatthe instance from which information is to be copied
Returns
whether the copy was created successfully
bool InitObjectiveBounds::setObj ( int  numberOfObj,
InitObjBound **  obj 
)

A function to set an array of <obj> elements.

Parameters
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set
bool InitObjectiveBounds::setObj ( int  numberOfObj,
InitObjBound **  obj,
ENUM_COMBINE_ARRAYS  disp 
)

Alternative signature for this function.

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set
dispmethod of disposition if previous data exist
bool InitObjectiveBounds::setObj ( int  numberOfObj,
int *  idx,
double *  lbValue,
double *  ubValue,
std::string *  name 
)

Another alternative signature for this function.

Parameters
numberOfObjnumber of <obj> elements to be set
idxthe array of indices
lbValuethe array of corresponding lower bounds
ubValuethe array of corresponding upper bounds
namethe array of objective names
bool InitObjectiveBounds::addObj ( int  idx,
double  lbValue,
double  ubValue 
)

A function to add a <obj> element.

Parameters
idxthe index of the objective to be given initial bounds
lbValuethe initial lower bound for the objective
ubValuethe initial upper bound for the objective
bool InitObjectiveBounds::addObj ( int  numberOfObj,
InitObjBound **  obj 
)

Alternative signature for this function.

A function to add an array of <obj> elements simultaneously

Parameters
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set

Member Data Documentation

int InitObjectiveBounds::numberOfObj

number of <obj> children

Definition at line 2410 of file OSOption.h.

InitObjBound** InitObjectiveBounds::obj

initial bounds for each objective

Definition at line 2413 of file OSOption.h.


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