SOSVariableBranchingWeights Class Reference

the SOSVariableBranchingWeights class. More...

#include <OSOption.h>

Collaboration diagram for SOSVariableBranchingWeights:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SOSVariableBranchingWeights ()
 Default constructor.
 ~SOSVariableBranchingWeights ()
 Class destructor.
bool IsEqual (SOSVariableBranchingWeights *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 setSOS (int numberOfSOS, SOSWeights **sos)
 A function to set an array of <sos> elements.
bool addSOS (int sosIdx, int nvar, double weight, int *idx, double *value, std::string *name)
 A function to add an <sos> element.

Public Attributes

int numberOfSOS
 number of <sos> children
SOSWeights ** sos
 branching weights for the SOS

Detailed Description

the SOSVariableBranchingWeights class.

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


Constructor & Destructor Documentation

SOSVariableBranchingWeights::SOSVariableBranchingWeights (  ) 

Default constructor.

Definition at line 648 of file OSOption.cpp.

SOSVariableBranchingWeights::~SOSVariableBranchingWeights (  ) 

Class destructor.

Definition at line 657 of file OSOption.cpp.


Member Function Documentation

bool SOSVariableBranchingWeights::IsEqual ( SOSVariableBranchingWeights that  ) 

A function to check for the equality of two objects.

Definition at line 10044 of file OSOption.cpp.

bool SOSVariableBranchingWeights::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 11635 of file OSOption.cpp.

bool SOSVariableBranchingWeights::setSOS ( int  numberOfSOS,
SOSWeights **  sos 
)

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

Parameters:
numberOfSOS,: number of <sos> elements to be set
sos,: the array of <sos> elements that are to be set

Definition at line 5433 of file OSOption.cpp.

bool SOSVariableBranchingWeights::addSOS ( int  sosIdx,
int  nvar,
double  weight,
int *  idx,
double *  value,
std::string *  name 
)

A function to add an <sos> element.

Parameters:
sosIdx,: the index of the SOS that is to be added (refer back to OSiL file)
nvar,: the number of variables in this SOS that are to be given weights
weight,: a selection weight for the entire group of variables
idx,: an array of variable indices
value,: the array of corresponding selection weights
sos,: the content of the <sos> element that is to be added

Definition at line 5484 of file OSOption.cpp.


Member Data Documentation

number of <sos> children

Definition at line 1639 of file OSOption.h.

branching weights for the SOS

Definition at line 1642 of file OSOption.h.


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

Generated on 22 May 2012 by  doxygen 1.6.1