Dip  0.92.4
List of all members
AlpsDecompNodeDesc Class Reference

Derivation of AlpsNodeDesc for DECOMP. More...

#include <AlpsDecompNodeDesc.h>

Inheritance diagram for AlpsDecompNodeDesc:
Inheritance graph
[legend]
Collaboration diagram for AlpsDecompNodeDesc:
Collaboration graph
[legend]

Data.

std::string m_classTag
 Store the name of the class (for logging/debugging) - "who am I?". More...
 
double * lowerBounds_
 lower bounds in original space More...
 
double * upperBounds_
 upper bounds in original space More...
 
int numberCols_
 number of columns in original space More...
 
int branchedDir_
 Branched direction to create it. More...
 
std::vector< std::pair< int,
double > > 
branched_
 Branched set of indices/values to create it. More...
 
CoinWarmStartBasisbasis_
 Warm start. More...
 
 AlpsDecompNodeDesc ()
 Default constructor. More...
 
 AlpsDecompNodeDesc (AlpsModel *m)
 Useful constructor. More...
 
 AlpsDecompNodeDesc (AlpsDecompModel *m, const double *lb, const double *ub)
 Store the name of the class (for logging/debugging) - "who am I?". More...
 
virtual ~AlpsDecompNodeDesc ()
 Destructor. More...
 
void setBasis (CoinWarmStartBasis *&ws)
 Set basis. More...
 
CoinWarmStartBasisgetBasis () const
 Get warm start basis. More...
 
void setBranchedDir (int d)
 Set branching direction. More...
 
int getBranchedDir () const
 Get branching direction. More...
 
void setBranched (std::vector< std::pair< int, double > > b)
 Set branching set. More...
 
std::vector< std::pair< int,
double > > 
getBranched () const
 Get branching set. More...
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded) const
 Pack node description into an encoded. More...
 
virtual AlpsReturnStatus decode (AlpsEncoded &encoded)
 Unpack a node description from an encoded. More...
 
AlpsReturnStatus encodeAlpsDecomp (AlpsEncoded *encoded) const
 Pack blis portion of node description into an encoded. More...
 
AlpsReturnStatus decodeAlpsDecomp (AlpsEncoded &encoded)
 Unpack blis portion of node description from an encoded. More...
 

Additional Inherited Members

- Public Member Functions inherited from AlpsNodeDesc
 AlpsNodeDesc ()
 
 AlpsNodeDesc (AlpsModel *m)
 
virtual ~AlpsNodeDesc ()
 
AlpsModelgetModel () const
 
void setModel (AlpsModel *m)
 
- Protected Attributes inherited from AlpsNodeDesc
AlpsModelmodel_
 A pointer to model. More...
 

Detailed Description

Derivation of AlpsNodeDesc for DECOMP.

An object derived from AlpsNodeDesc. This stores the description of a search tree node. For DECOMP, we are not using differencing, so, we only need to store the bounds set during branching.

AlpsDecompNodeDesc is derived from AlpsNodeDesc AlpsModel has no pure virtual functions

Virtual methods that should are derived here: encode decode

See Also
AlpsNodeDesc
Todo:
Invent a way to lose weight on a donut diet. Use differencing scheme.

Definition at line 55 of file AlpsDecompNodeDesc.h.

Constructor & Destructor Documentation

AlpsDecompNodeDesc::AlpsDecompNodeDesc ( )
inline

Default constructor.

Definition at line 90 of file AlpsDecompNodeDesc.h.

AlpsDecompNodeDesc::AlpsDecompNodeDesc ( AlpsModel m)
inline

Useful constructor.

Definition at line 97 of file AlpsDecompNodeDesc.h.

AlpsDecompNodeDesc::AlpsDecompNodeDesc ( AlpsDecompModel m,
const double *  lb,
const double *  ub 
)
inline

Store the name of the class (for logging/debugging) - "who am I?".

Definition at line 104 of file AlpsDecompNodeDesc.h.

References AlpsDecompModel::getNumCoreCols(), lowerBounds_, numberCols_, and upperBounds_.

virtual AlpsDecompNodeDesc::~AlpsDecompNodeDesc ( )
inlinevirtual

Destructor.

Definition at line 120 of file AlpsDecompNodeDesc.h.

References basis_, lowerBounds_, and upperBounds_.

Member Function Documentation

void AlpsDecompNodeDesc::setBasis ( CoinWarmStartBasis *&  ws)
inline

Set basis.

Definition at line 135 of file AlpsDecompNodeDesc.h.

References basis_.

CoinWarmStartBasis* AlpsDecompNodeDesc::getBasis ( ) const
inline

Get warm start basis.

Definition at line 145 of file AlpsDecompNodeDesc.h.

References basis_.

void AlpsDecompNodeDesc::setBranchedDir ( int  d)
inline

Set branching direction.

Definition at line 150 of file AlpsDecompNodeDesc.h.

References branchedDir_.

int AlpsDecompNodeDesc::getBranchedDir ( ) const
inline

Get branching direction.

Definition at line 155 of file AlpsDecompNodeDesc.h.

References branchedDir_.

void AlpsDecompNodeDesc::setBranched ( std::vector< std::pair< int, double > >  b)
inline

Set branching set.

Definition at line 160 of file AlpsDecompNodeDesc.h.

References branched_.

std::vector< std::pair<int, double> > AlpsDecompNodeDesc::getBranched ( ) const
inline

Get branching set.

Definition at line 165 of file AlpsDecompNodeDesc.h.

References branched_.

AlpsReturnStatus AlpsDecompNodeDesc::encodeAlpsDecomp ( AlpsEncoded encoded) const
inlineprotected

Pack blis portion of node description into an encoded.

Definition at line 176 of file AlpsDecompNodeDesc.h.

References AlpsReturnStatusOk, basis_, branchedDir_, UtilAlpsEncodeWarmStart(), and AlpsEncoded::writeRep().

Referenced by encode().

AlpsReturnStatus AlpsDecompNodeDesc::decodeAlpsDecomp ( AlpsEncoded encoded)
inlineprotected

Unpack blis portion of node description from an encoded.

Definition at line 196 of file AlpsDecompNodeDesc.h.

References AlpsReturnStatusOk, basis_, branchedDir_, AlpsEncoded::readRep(), and UtilAlpsDecodeWarmStart().

Referenced by decode().

virtual AlpsReturnStatus AlpsDecompNodeDesc::encode ( AlpsEncoded encoded) const
inlinevirtual

Pack node description into an encoded.

Reimplemented from AlpsNodeDesc.

Definition at line 219 of file AlpsDecompNodeDesc.h.

References AlpsReturnStatusOk, and encodeAlpsDecomp().

virtual AlpsReturnStatus AlpsDecompNodeDesc::decode ( AlpsEncoded encoded)
inlinevirtual

Unpack a node description from an encoded.

Fill member data.

Reimplemented from AlpsNodeDesc.

Definition at line 226 of file AlpsDecompNodeDesc.h.

References AlpsReturnStatusOk, and decodeAlpsDecomp().

Member Data Documentation

std::string AlpsDecompNodeDesc::m_classTag
private

Store the name of the class (for logging/debugging) - "who am I?".

Definition at line 69 of file AlpsDecompNodeDesc.h.

double* AlpsDecompNodeDesc::lowerBounds_

lower bounds in original space

Definition at line 73 of file AlpsDecompNodeDesc.h.

Referenced by AlpsDecompNodeDesc(), and ~AlpsDecompNodeDesc().

double* AlpsDecompNodeDesc::upperBounds_

upper bounds in original space

Definition at line 75 of file AlpsDecompNodeDesc.h.

Referenced by AlpsDecompNodeDesc(), and ~AlpsDecompNodeDesc().

int AlpsDecompNodeDesc::numberCols_

number of columns in original space

Definition at line 77 of file AlpsDecompNodeDesc.h.

Referenced by AlpsDecompNodeDesc().

int AlpsDecompNodeDesc::branchedDir_

Branched direction to create it.

Definition at line 79 of file AlpsDecompNodeDesc.h.

Referenced by decodeAlpsDecomp(), encodeAlpsDecomp(), getBranchedDir(), and setBranchedDir().

std::vector< std::pair<int, double> > AlpsDecompNodeDesc::branched_

Branched set of indices/values to create it.

Definition at line 81 of file AlpsDecompNodeDesc.h.

Referenced by getBranched(), and setBranched().

CoinWarmStartBasis* AlpsDecompNodeDesc::basis_

Warm start.

Definition at line 85 of file AlpsDecompNodeDesc.h.

Referenced by decodeAlpsDecomp(), encodeAlpsDecomp(), getBasis(), setBasis(), and ~AlpsDecompNodeDesc().


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