InitObjectiveValues Class Reference

the InitObjectiveValues class. More...

#include <OSOption.h>

Collaboration diagram for InitObjectiveValues:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 InitObjectiveValues ()
 Default constructor.
 ~InitObjectiveValues ()
 Class destructor.
bool IsEqual (InitObjectiveValues *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 setObj (int numberOfObj, InitObjValue **obj)
 A function to set an array of <obj> elements.
bool setObj (int numberOfObj, int *idx, double *value, std::string *name)
 Alternative signature for this function.
bool addObj (int idx, double value)
 A function to add a <obj> element.

Public Attributes

int numberOfObj
 number of <obj> children
InitObjValue ** obj
 initial value for each objective

Detailed Description

the InitObjectiveValues class.

Author:
Robert Fourer, Gus 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 1981 of file OSOption.h.


Constructor & Destructor Documentation

InitObjectiveValues::InitObjectiveValues (  ) 

Default constructor.

Definition at line 803 of file OSOption.cpp.

References obj.

InitObjectiveValues::~InitObjectiveValues (  ) 

Class destructor.

Definition at line 812 of file OSOption.cpp.

References numberOfObj, and obj.


Member Function Documentation

bool InitObjectiveValues::IsEqual ( InitObjectiveValues that  ) 

A function to check for the equality of two objects.

Definition at line 10338 of file OSOption.cpp.

References numberOfObj, and obj.

bool InitObjectiveValues::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" attributes and <XXX> children)

Definition at line 11780 of file OSOption.cpp.

References n, numberOfObj, obj, OSRand(), and InitObjValue::setRandom().

Referenced by ObjectiveOption::setRandom().

bool InitObjectiveValues::setObj ( int  numberOfObj,
InitObjValue **  obj 
)

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

Parameters:
numberOfObj,: number of <obj> elements to be set
obj,: the array of <obj> elements that are to be set

Definition at line 5754 of file OSOption.cpp.

References ErrorClass::errormsg, and obj.

Referenced by OSOption::setInitObjValues(), and OSOption::setInitObjValuesSparse().

bool InitObjectiveValues::setObj ( int  numberOfObj,
int *  idx,
double *  value,
std::string *  name 
)

Alternative signature for this function.

Parameters:
numberOfObj,: number of <obj> elements to be set
idx,: the array of indices
value,: the array of corresponding values
name,: the array of objective names

Definition at line 5785 of file OSOption.cpp.

References InitObjValue::idx, InitObjValue::name, obj, and InitObjValue::value.

bool InitObjectiveValues::addObj ( int  idx,
double  value 
)

A function to add a <obj> element.

Parameters:
idx,: the index of the objective to be given an initial value
value,: the initial value to be added

Definition at line 5814 of file OSOption.cpp.

References ErrorClass::errormsg, InitObjValue::idx, numberOfObj, obj, and InitObjValue::value.

Referenced by OSOption::setAnotherInitObjValue().


Member Data Documentation

int InitObjectiveValues::numberOfObj

number of <obj> children

Definition at line 1986 of file OSOption.h.

Referenced by addObj(), OSOption::getNumberOfInitObjValues(), IsEqual(), OSOption::setInitObjValuesSparse(), setRandom(), and ~InitObjectiveValues().

InitObjValue** InitObjectiveValues::obj

initial value for each objective

Definition at line 1989 of file OSOption.h.

Referenced by addObj(), OSOption::getInitObjValuesSparse(), InitObjectiveValues(), IsEqual(), OSOption::setInitObjValuesDense(), setObj(), setRandom(), and ~InitObjectiveValues().


The documentation for this class was generated from the following files:
Generated on Wed Nov 30 03:11:36 2011 by  doxygen 1.4.7