My Project
InitObjectiveBounds Class Reference

the InitObjectiveBounds class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

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

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

Default constructor.

Definition at line 850 of file OSOption.cpp.

◆ ~InitObjectiveBounds()

InitObjectiveBounds::~InitObjectiveBounds ( )

Class destructor.

Definition at line 859 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InitObjectiveBounds::IsEqual ( InitObjectiveBounds * that)

A function to check for the equality of two objects.

Definition at line 11491 of file OSOption.cpp.

◆ setRandom()

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)

Definition at line 12959 of file OSOption.cpp.

◆ deepCopyFrom()

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

Definition at line 14059 of file OSOption.cpp.

◆ setObj() [1/3]

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

Definition at line 6338 of file OSOption.cpp.

◆ setObj() [2/3]

bool InitObjectiveBounds::setObj ( int numberOfObj,
InitObjBound ** obj,
ENUM_COMBINE_ARRAYS disp )

Alternative signature for this function.

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

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set
dispmethod of disposition if previous data exist
numberOfObjnumber of <obj> elements to be set
objthe array of <obj> elements that are to be set
dispmethod of disposition if previous data exist

Definition at line 6376 of file OSOption.cpp.

◆ setObj() [3/3]

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

Definition at line 6420 of file OSOption.cpp.

◆ addObj() [1/2]

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

Definition at line 6454 of file OSOption.cpp.

◆ addObj() [2/2]

bool InitObjectiveBounds::addObj ( int numberOfObj,
InitObjBound ** obj )

Alternative signature for this function.

A function to add several <obj> elements.

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
numberOfVarnumber of <obj> elements to be added
objthe array of <obj> elements that are to be added

Definition at line 6498 of file OSOption.cpp.

Member Data Documentation

◆ numberOfObj

int InitObjectiveBounds::numberOfObj

number of <obj> children

Definition at line 2410 of file OSOption.h.

◆ obj

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 files: