OS  2.10.1
Public Member Functions | Public Attributes | List of all members
IntegerVariableBranchingWeights Class Reference

the IntegerVariableBranchingWeights class. More...

#include <OSOption.h>

+ Collaboration diagram for IntegerVariableBranchingWeights:

Public Member Functions

 IntegerVariableBranchingWeights ()
 Default constructor. More...
 
 ~IntegerVariableBranchingWeights ()
 Class destructor. More...
 
bool IsEqual (IntegerVariableBranchingWeights *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 (IntegerVariableBranchingWeights *that)
 A function to make a deep copy of an instance of this class. More...
 
bool setVar (int numberOfVar, BranchingWeight **var)
 A function to set an array of elements. More...
 
bool setVar (int numberOfVar, BranchingWeight **var, ENUM_COMBINE_ARRAYS disp)
 Alternative signature for this function. More...
 
bool setVar (int numberOfVar, int *idx, double *value, std::string *name)
 Another alternative signature for this function. More...
 
bool addVar (int idx, double value)
 A function to add a element. More...
 
bool addVar (int numberOfVar, BranchingWeight **var)
 Alternative signature for this function. More...
 

Public Attributes

int numberOfVar
 number of children More...
 
BranchingWeight ** var
 branching weight for each variable More...
 

Detailed Description

the IntegerVariableBranchingWeights class.

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

Definition at line 1671 of file OSOption.h.

Constructor & Destructor Documentation

§ IntegerVariableBranchingWeights()

IntegerVariableBranchingWeights::IntegerVariableBranchingWeights ( )

Default constructor.

§ ~IntegerVariableBranchingWeights()

IntegerVariableBranchingWeights::~IntegerVariableBranchingWeights ( )

Class destructor.

Member Function Documentation

§ IsEqual()

bool IntegerVariableBranchingWeights::IsEqual ( IntegerVariableBranchingWeights that)

A function to check for the equality of two objects.

§ setRandom()

bool IntegerVariableBranchingWeights::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)

§ deepCopyFrom()

bool IntegerVariableBranchingWeights::deepCopyFrom ( IntegerVariableBranchingWeights 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

§ setVar() [1/3]

bool IntegerVariableBranchingWeights::setVar ( int  numberOfVar,
BranchingWeight **  var 
)

A function to set an array of elements.

Parameters
numberOfVarnumber of elements to be set
varthe array of elements to be that are to be set

§ setVar() [2/3]

bool IntegerVariableBranchingWeights::setVar ( int  numberOfVar,
BranchingWeight **  var,
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

§ setVar() [3/3]

bool IntegerVariableBranchingWeights::setVar ( int  numberOfVar,
int *  idx,
double *  value,
std::string *  name 
)

Another alternative signature for this function.

Parameters
numberOfVarnumber of elements to be set
idxthe array of indices
valuethe array of corresponding values
namethe array of corresponding names

§ addVar() [1/2]

bool IntegerVariableBranchingWeights::addVar ( int  idx,
double  value 
)

A function to add a element.

Parameters
idxthe index of the variable to be given a branching weight
valuethe branching weight to be added

§ addVar() [2/2]

bool IntegerVariableBranchingWeights::addVar ( int  numberOfVar,
BranchingWeight **  var 
)

Alternative signature for this function.

A function to add an array of elements simultaneously

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set

Member Data Documentation

§ numberOfVar

int IntegerVariableBranchingWeights::numberOfVar

number of children

Definition at line 1676 of file OSOption.h.

§ var

BranchingWeight** IntegerVariableBranchingWeights::var

branching weight for each variable

Definition at line 1679 of file OSOption.h.


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