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 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)
 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 1250 of file OSOption.h.


Constructor & Destructor Documentation

SOSVariableBranchingWeights::SOSVariableBranchingWeights (  ) 

Default constructor.

Definition at line 624 of file OSOption.cpp.

References sos.

SOSVariableBranchingWeights::~SOSVariableBranchingWeights (  ) 

Class destructor.

Definition at line 633 of file OSOption.cpp.

References numberOfSOS, and sos.


Member Function Documentation

bool SOSVariableBranchingWeights::IsEqual ( SOSVariableBranchingWeights that  ) 

A function to check for the equality of two objects.

Definition at line 7850 of file OSOption.cpp.

References numberOfSOS, and sos.

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 4375 of file OSOption.cpp.

References ErrorClass::errormsg, SOSWeights::groupWeight, SOSWeights::numberOfVar, sos, SOSWeights::sosIdx, and SOSWeights::var.

Referenced by OSOption::setSOSVariableBranchingWeights().

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

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

Definition at line 4420 of file OSOption.cpp.

References ErrorClass::errormsg, SOSWeights::groupWeight, BranchingWeight::idx, numberOfSOS, SOSWeights::numberOfVar, sos, SOSWeights::sosIdx, BranchingWeight::value, and SOSWeights::var.

Referenced by OSOption::setAnotherSOSVariableBranchingWeight().


Member Data Documentation

int SOSVariableBranchingWeights::numberOfSOS

number of <sos> children

Definition at line 1254 of file OSOption.h.

Referenced by addSOS(), OSOption::getNumberOfSOS(), OSOption::getNumberOfSOSVarBranchingWeights(), IsEqual(), OSOption::setSOSVariableBranchingWeights(), and ~SOSVariableBranchingWeights().

SOSWeights** SOSVariableBranchingWeights::sos

branching weights for the SOS

Definition at line 1257 of file OSOption.h.

Referenced by addSOS(), OSOption::getNumberOfSOSVarBranchingWeights(), OSOption::getSOSVariableBranchingWeightsSparse(), IsEqual(), setSOS(), SOSVariableBranchingWeights(), and ~SOSVariableBranchingWeights().


The documentation for this class was generated from the following files:
Generated on Mon Aug 3 03:08:03 2009 by  doxygen 1.4.7