InitObjectiveBounds Class Reference

the InitObjectiveBounds class. More...

#include <OSOption.h>

Collaboration diagram for InitObjectiveBounds:
Collaboration graph
[legend]

List of all members.

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 setObj (int numberOfObj, InitObjBound **obj)
 A function to set an array of <obj> elements.
bool setObj (int numberOfObj, int *idx, double *lbValue, double *ubValue, std::string *name)
 Alternative signature for this function.
bool addObj (int idx, double lbValue, double ubValue)
 A function to add a <obj> element.

Public Attributes

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

Detailed Description

the InitObjectiveBounds 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 2111 of file OSOption.h.


Constructor & Destructor Documentation

InitObjectiveBounds::InitObjectiveBounds (  ) 

Default constructor.

Definition at line 850 of file OSOption.cpp.

InitObjectiveBounds::~InitObjectiveBounds (  ) 

Class destructor.

Definition at line 859 of file OSOption.cpp.


Member Function Documentation

bool InitObjectiveBounds::IsEqual ( InitObjectiveBounds that  ) 

A function to check for the equality of two objects.

Definition at line 10422 of file OSOption.cpp.

bool InitObjectiveBounds::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 11818 of file OSOption.cpp.

bool InitObjectiveBounds::setObj ( int  numberOfObj,
InitObjBound **  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 5858 of file OSOption.cpp.

bool InitObjectiveBounds::setObj ( int  numberOfObj,
int *  idx,
double *  lbValue,
double *  ubValue,
std::string *  name 
)

Alternative signature for this function.

Parameters:
numberOfObj,: number of <obj> elements to be set
idx,: the array of indices
lbValue,: the array of corresponding lower bounds
ubValue,: the array of corresponding upper bounds
name,: the array of objective names

Definition at line 5889 of file OSOption.cpp.

bool InitObjectiveBounds::addObj ( int  idx,
double  lbValue,
double  ubValue 
)

A function to add a <obj> element.

Parameters:
idx,: the index of the objective to be given initial bounds
lbValue,: the initial lower bound for the objective
ubValue,: the initial upper bound for the objective

Definition at line 5923 of file OSOption.cpp.


Member Data Documentation

number of <obj> children

Definition at line 2116 of file OSOption.h.

initial bounds for each objective

Definition at line 2119 of file OSOption.h.


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

Generated on 16 Feb 2012 by  doxygen 1.6.1