My Project
SOSWeights Class Reference

the SOSWeights class. More...

#include <OSOption.h>

Public Member Functions

 SOSWeights ()
 Default constructor.
 
 ~SOSWeights ()
 Class destructor.
 
bool IsEqual (SOSWeights *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 (SOSWeights *that)
 A function to make a deep copy of an instance of this class.
 
bool setVar (int numberOfVar, BranchingWeight **var)
 A function to set an array of elements.
 
bool addVar (int idx, double value)
 A function to add a element.
 

Public Attributes

int sosIdx
 index of the SOS (to match the OSiL file)
 
double groupWeight
 branching weight for the entire SOS
 
int numberOfVar
 number of children
 
BranchingWeight ** var
 branching weights for individual variables
 

Detailed Description

the SOSWeights 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 1775 of file OSOption.h.

Constructor & Destructor Documentation

◆ SOSWeights()

SOSWeights::SOSWeights ( )

Default constructor.

Definition at line 616 of file OSOption.cpp.

◆ ~SOSWeights()

SOSWeights::~SOSWeights ( )

Class destructor.

Definition at line 627 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool SOSWeights::IsEqual ( SOSWeights * that)

A function to check for the equality of two objects.

Definition at line 11093 of file OSOption.cpp.

◆ setRandom()

bool SOSWeights::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 12776 of file OSOption.cpp.

◆ deepCopyFrom()

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

◆ setVar()

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

A function to set an array of elements.

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

Definition at line 5723 of file OSOption.cpp.

◆ addVar()

bool SOSWeights::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

Definition at line 5760 of file OSOption.cpp.

Member Data Documentation

◆ sosIdx

int SOSWeights::sosIdx

index of the SOS (to match the OSiL file)

Definition at line 1780 of file OSOption.h.

◆ groupWeight

double SOSWeights::groupWeight

branching weight for the entire SOS

Definition at line 1783 of file OSOption.h.

◆ numberOfVar

int SOSWeights::numberOfVar

number of children

Definition at line 1786 of file OSOption.h.

◆ var

BranchingWeight** SOSWeights::var

branching weights for individual variables

Definition at line 1789 of file OSOption.h.


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