My Project
InitDualVariableValues Class Reference

the InitDualVariableValues class. More...

#include <OSOption.h>

Public Member Functions

 InitDualVariableValues ()
 Default constructor.
 
 ~InitDualVariableValues ()
 Class destructor.
 
bool IsEqual (InitDualVariableValues *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 (InitDualVariableValues *that)
 A function to make a deep copy of an instance of this class.
 
bool setCon (int numberOfCon, InitDualVarValue **con)
 A function to set an array of <con> elements.
 
bool setCon (int numberOfCon, InitDualVarValue **con, ENUM_COMBINE_ARRAYS disp)
 Alternative signature for this function.
 
bool setCon (int numberOfCon, int *idx, double *lbValue, double *ubValue, std::string *name)
 Another alternative signature for this function.
 
bool addCon (int idx, double lbDualValue, double ubDualValue)
 A function to add a <con> element.
 
bool addCon (int numberOfCon, InitDualVarValue **con)
 Alternative signature for this function.
 

Public Attributes

int numberOfCon
 number of <con> children
 
InitDualVarValue ** con
 initial dual values for each constraint
 

Detailed Description

the InitDualVariableValues 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 2987 of file OSOption.h.

Constructor & Destructor Documentation

◆ InitDualVariableValues()

InitDualVariableValues::InitDualVariableValues ( )

Default constructor.

Definition at line 1047 of file OSOption.cpp.

◆ ~InitDualVariableValues()

InitDualVariableValues::~InitDualVariableValues ( )

Class destructor.

Definition at line 1056 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InitDualVariableValues::IsEqual ( InitDualVariableValues * that)

A function to check for the equality of two objects.

Definition at line 11861 of file OSOption.cpp.

◆ setRandom()

bool InitDualVariableValues::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 13145 of file OSOption.cpp.

◆ deepCopyFrom()

bool InitDualVariableValues::deepCopyFrom ( InitDualVariableValues * 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 14226 of file OSOption.cpp.

◆ setCon() [1/3]

bool InitDualVariableValues::setCon ( int numberOfCon,
InitDualVarValue ** con )

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

Parameters
numberOfConnumber of <con> elements to be set
conthe array of <con> elements that are to be set

Definition at line 6984 of file OSOption.cpp.

◆ setCon() [2/3]

bool InitDualVariableValues::setCon ( int numberOfCon,
InitDualVarValue ** con,
ENUM_COMBINE_ARRAYS disp )

Alternative signature for this function.

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

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set
dispmethod of disposition if previous data exist
numberOfConnumber of <con> elements to be set
conthe array of <con> elements that are to be set
dispmethod of disposition if previous data exist

Definition at line 7021 of file OSOption.cpp.

◆ setCon() [3/3]

bool InitDualVariableValues::setCon ( int numberOfCon,
int * idx,
double * lbValue,
double * ubValue,
std::string * name )

Another alternative signature for this function.

Parameters
numberOfConnumber of <con> elements to be set
idxthe array of indices
lbValuethe array of dual values for the lower bound
ubValuethe array of dual values for the upper bound
namethe array of constraint names

Definition at line 7065 of file OSOption.cpp.

◆ addCon() [1/2]

bool InitDualVariableValues::addCon ( int idx,
double lbDualValue,
double ubDualValue )

A function to add a <con> element.

Parameters
idxthe index of the constraint to be given initial dual variables
lbDualValuean initial value for the dual variable associated with the lower bound
ubDualValuean initial value for the dual variable associated with the upper bound
idxthe index of the constraint to be given initial dual variable bounds
lbValuean initial lower bound for the dual variable
ubValuean initial upper bound for the dual variable

Definition at line 7099 of file OSOption.cpp.

◆ addCon() [2/2]

bool InitDualVariableValues::addCon ( int numberOfCon,
InitDualVarValue ** con )

Alternative signature for this function.

A function to add several <con> elements.

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

Parameters
numberOfConnumber of <con> elements to be set
objthe array of <con> elements that are to be set
numberOfVarnumber of <con> elements to be added
conthe array of <con> elements that are to be added

Definition at line 7143 of file OSOption.cpp.

Member Data Documentation

◆ numberOfCon

int InitDualVariableValues::numberOfCon

number of <con> children

Definition at line 2992 of file OSOption.h.

◆ con

InitDualVarValue** InitDualVariableValues::con

initial dual values for each constraint

Definition at line 2995 of file OSOption.h.


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