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]

List of all members.

Data.



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

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 56 of file AlpsDecompNodeDesc.h.


Constructor & Destructor Documentation

AlpsDecompNodeDesc::AlpsDecompNodeDesc (  )  [inline]

Default constructor.

Definition at line 91 of file AlpsDecompNodeDesc.h.

AlpsDecompNodeDesc::AlpsDecompNodeDesc ( AlpsModel m  )  [inline]

Useful constructor.

Definition at line 98 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 105 of file AlpsDecompNodeDesc.h.

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

virtual AlpsDecompNodeDesc::~AlpsDecompNodeDesc (  )  [inline, virtual]

Destructor.

Definition at line 121 of file AlpsDecompNodeDesc.h.

References basis_, lowerBounds_, and upperBounds_.


Member Function Documentation

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

Set basis.

Definition at line 136 of file AlpsDecompNodeDesc.h.

References basis_.

CoinWarmStartBasis* AlpsDecompNodeDesc::getBasis (  )  const [inline]

Get warm start basis.

Definition at line 146 of file AlpsDecompNodeDesc.h.

References basis_.

void AlpsDecompNodeDesc::setBranchedDir ( int  d  )  [inline]

Set branching direction.

Definition at line 151 of file AlpsDecompNodeDesc.h.

References branchedDir_.

int AlpsDecompNodeDesc::getBranchedDir (  )  const [inline]

Get branching direction.

Definition at line 156 of file AlpsDecompNodeDesc.h.

References branchedDir_.

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

Set branching set.

Definition at line 161 of file AlpsDecompNodeDesc.h.

References branched_.

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

Get branching set.

Definition at line 166 of file AlpsDecompNodeDesc.h.

References branched_.

AlpsReturnStatus AlpsDecompNodeDesc::encodeAlpsDecomp ( AlpsEncoded encoded  )  const [inline, protected]

Pack blis portion of node description into an encoded.

Definition at line 177 of file AlpsDecompNodeDesc.h.

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

Referenced by encode().

AlpsReturnStatus AlpsDecompNodeDesc::decodeAlpsDecomp ( AlpsEncoded encoded  )  [inline, protected]

Unpack blis portion of node description from an encoded.

Definition at line 197 of file AlpsDecompNodeDesc.h.

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

Referenced by decode().

virtual AlpsReturnStatus AlpsDecompNodeDesc::encode ( AlpsEncoded encoded  )  const [inline, virtual]

Pack node description into an encoded.

Reimplemented from AlpsNodeDesc.

Definition at line 220 of file AlpsDecompNodeDesc.h.

References AlpsReturnStatusOk, and encodeAlpsDecomp().

virtual AlpsReturnStatus AlpsDecompNodeDesc::decode ( AlpsEncoded encoded  )  [inline, virtual]

Unpack a node description from an encoded.

Fill member data.

Reimplemented from AlpsNodeDesc.

Definition at line 227 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 70 of file AlpsDecompNodeDesc.h.

lower bounds in original space

Definition at line 74 of file AlpsDecompNodeDesc.h.

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

upper bounds in original space

Definition at line 76 of file AlpsDecompNodeDesc.h.

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

number of columns in original space

Definition at line 78 of file AlpsDecompNodeDesc.h.

Referenced by AlpsDecompNodeDesc().

Branched direction to create it.

Definition at line 80 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 82 of file AlpsDecompNodeDesc.h.

Referenced by getBranched(), and setBranched().

Warm start.

Definition at line 86 of file AlpsDecompNodeDesc.h.

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


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

Generated on 12 Feb 2015 for Dip-All by  doxygen 1.6.1