Alps  2.0.2
Public Member Functions | Private Attributes | List of all members
AbcNodeDesc Class Reference

#include <AbcNodeDesc.h>

+ Inheritance diagram for AbcNodeDesc:
+ Collaboration diagram for AbcNodeDesc:

Public Member Functions

 AbcNodeDesc ()
 
virtual ~AbcNodeDesc ()
 
double * lowerBounds ()
 
void setLowerBounds (const double *lb, const int size)
 
void setLowerBound (const int index, const double lb)
 
double * upperBounds ()
 
void setUpperBounds (const double *ub, const int size)
 
void setUpperBound (const int index, const double ub)
 
void setBranchedOn (int b)
 
void setBranchedDir (int d)
 
void setBranchedOnValue (double b)
 
int getBranchedOn () const
 
int getBranchedDir () const
 
double getBranchedOnValue () const
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded) const
 Pack this node description into the given AlpsEncoded object. More...
 
virtual AlpsReturnStatus decodeToSelf (AlpsEncoded &encoded)
 Unpack fields from the given AlpsEncoded object. More...
 
virtual AlpsNodeDesc * decode (AlpsEncoded &encoded) const
 Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it. More...
 
 AbcNodeDesc ()
 
virtual ~AbcNodeDesc ()
 
double * lowerBounds ()
 
void setLowerBounds (const double *lb, const int size)
 
void setLowerBound (const int index, const double lb)
 
double * upperBounds ()
 
void setUpperBounds (const double *ub, const int size)
 
void setUpperBound (const int index, const double ub)
 
void setBranchedOn (int b)
 
void setBranchedDir (int d)
 
void setBranchedOnValue (double b)
 
int getBranchedOn () const
 
int getBranchedDir () const
 
double getBranchedOnValue () const
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded) const
 Pack this node description into the given AlpsEncoded object. More...
 
virtual AlpsReturnStatus decodeToSelf (AlpsEncoded &encoded)
 Unpack fields from the given AlpsEncoded object. More...
 
virtual AlpsNodeDesc * decode (AlpsEncoded &encoded) const
 Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it. More...
 
 AbcNodeDesc ()
 
virtual ~AbcNodeDesc ()
 
double * lowerBounds ()
 
void setLowerBounds (const double *lb, const int size)
 
void setLowerBound (const int index, const double lb)
 
double * upperBounds ()
 
void setUpperBounds (const double *ub, const int size)
 
void setUpperBound (const int index, const double ub)
 
void setBranchedOn (int b)
 
void setBranchedDir (int d)
 
void setBranchedOnValue (double b)
 
int getBranchedOn () const
 
int getBranchedDir () const
 
double getBranchedOnValue () const
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded) const
 Pack this node description into the given AlpsEncoded object. More...
 
virtual AlpsReturnStatus decodeToSelf (AlpsEncoded &encoded)
 Unpack fields from the given AlpsEncoded object. More...
 
virtual AlpsNodeDesc * decode (AlpsEncoded &encoded) const
 Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it. More...
 
- Public Member Functions inherited from AlpsNodeDesc
 AlpsNodeDesc ()
 Default constructor. More...
 
 AlpsNodeDesc (AlpsKnowledgeBroker *broker)
 
virtual ~AlpsNodeDesc ()
 Destructor. More...
 
AlpsEncoded * encode () const
 Pack this into an AlpsEncoded object and return a pointer to it. More...
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded) const
 Pack this into an AlpsEncoded object and return a pointer to it. More...
 
- Public Member Functions inherited from AlpsKnowledge
 AlpsKnowledge ()
 Default constructor. More...
 
 AlpsKnowledge (AlpsKnowledgeType type)
 
 AlpsKnowledge (AlpsKnowledgeType type, AlpsKnowledgeBroker *broker)
 
virtual ~AlpsKnowledge ()
 Destructor. More...
 
AlpsKnowledgeType getType () const
 Get knowledge type. More...
 
void setType (AlpsKnowledgeType t)
 Set knowledge type. More...
 
AlpsKnowledgeBroker * broker ()
 Get pointer to the knowledge broker. More...
 
const AlpsKnowledgeBroker * broker () const
 Get pointer to the knowledge broker. More...
 
void setBroker (AlpsKnowledgeBroker *broker)
 Set knowledge broker. More...
 
AlpsEncoded * encode () const
 Encode the content of this into an AlpsEncoded object and return a pointer to it. More...
 

Private Attributes

double * lowerBounds_
 
double * upperBounds_
 
int numberRows_
 Number of rows in problem (before these cuts). More...
 
int numberCols_
 
int branchedOn_
 The index of the branching variable. More...
 
double branchedOnVal_
 The solution value (non-integral) of the branching variable. More...
 
int branchedDir_
 Branching direction. More...
 

Additional Inherited Members

- Public Attributes inherited from AlpsKnowledge
AlpsKnowledgeBroker * broker_
 

Detailed Description

Definition at line 52 of file AbcNodeDesc.h.

Constructor & Destructor Documentation

◆ AbcNodeDesc() [1/3]

AbcNodeDesc::AbcNodeDesc ( )
inline

Definition at line 82 of file AbcNodeDesc.h.

◆ ~AbcNodeDesc() [1/3]

virtual AbcNodeDesc::~AbcNodeDesc ( )
inlinevirtual

Definition at line 95 of file AbcNodeDesc.h.

◆ AbcNodeDesc() [2/3]

AbcNodeDesc::AbcNodeDesc ( )
inline

Definition at line 82 of file AbcNodeDesc.h.

◆ ~AbcNodeDesc() [2/3]

virtual AbcNodeDesc::~AbcNodeDesc ( )
inlinevirtual

Definition at line 95 of file AbcNodeDesc.h.

◆ AbcNodeDesc() [3/3]

AbcNodeDesc::AbcNodeDesc ( )
inline

Definition at line 82 of file AbcNodeDesc.h.

◆ ~AbcNodeDesc() [3/3]

virtual AbcNodeDesc::~AbcNodeDesc ( )
inlinevirtual

Definition at line 95 of file AbcNodeDesc.h.

Member Function Documentation

◆ lowerBounds() [1/3]

double* AbcNodeDesc::lowerBounds ( )
inline

Definition at line 106 of file AbcNodeDesc.h.

◆ setLowerBounds() [1/3]

void AbcNodeDesc::setLowerBounds ( const double *  lb,
const int  size 
)
inline

Definition at line 120 of file AbcNodeDesc.h.

◆ setLowerBound() [1/3]

void AbcNodeDesc::setLowerBound ( const int  index,
const double  lb 
)
inline

Definition at line 128 of file AbcNodeDesc.h.

◆ upperBounds() [1/3]

double* AbcNodeDesc::upperBounds ( )
inline

Definition at line 140 of file AbcNodeDesc.h.

◆ setUpperBounds() [1/3]

void AbcNodeDesc::setUpperBounds ( const double *  ub,
const int  size 
)
inline

Definition at line 152 of file AbcNodeDesc.h.

◆ setUpperBound() [1/3]

void AbcNodeDesc::setUpperBound ( const int  index,
const double  ub 
)
inline

Definition at line 160 of file AbcNodeDesc.h.

◆ setBranchedOn() [1/3]

void AbcNodeDesc::setBranchedOn ( int  b)
inline

Definition at line 172 of file AbcNodeDesc.h.

◆ setBranchedDir() [1/3]

void AbcNodeDesc::setBranchedDir ( int  d)
inline

Definition at line 174 of file AbcNodeDesc.h.

◆ setBranchedOnValue() [1/3]

void AbcNodeDesc::setBranchedOnValue ( double  b)
inline

Definition at line 176 of file AbcNodeDesc.h.

◆ getBranchedOn() [1/3]

int AbcNodeDesc::getBranchedOn ( ) const
inline

Definition at line 178 of file AbcNodeDesc.h.

◆ getBranchedDir() [1/3]

int AbcNodeDesc::getBranchedDir ( ) const
inline

Definition at line 180 of file AbcNodeDesc.h.

◆ getBranchedOnValue() [1/3]

double AbcNodeDesc::getBranchedOnValue ( ) const
inline

Definition at line 182 of file AbcNodeDesc.h.

◆ encode() [1/3]

virtual AlpsReturnStatus AbcNodeDesc::encode ( AlpsEncoded *  encoded) const
inlinevirtual

Pack this node description into the given AlpsEncoded object.

Reimplemented from AlpsNodeDesc.

Definition at line 184 of file AbcNodeDesc.h.

◆ decodeToSelf() [1/3]

virtual AlpsReturnStatus AbcNodeDesc::decodeToSelf ( AlpsEncoded &  encoded)
inlinevirtual

Unpack fields from the given AlpsEncoded object.

Reimplemented from AlpsNodeDesc.

Definition at line 189 of file AbcNodeDesc.h.

◆ decode() [1/3]

virtual AlpsNodeDesc* AbcNodeDesc::decode ( AlpsEncoded &  encoded) const
inlinevirtual

Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it.

User application sub-classes should implement this since the returned pointer will point to user sub-class instances.

Implements AlpsKnowledge.

Definition at line 194 of file AbcNodeDesc.h.

◆ lowerBounds() [2/3]

double* AbcNodeDesc::lowerBounds ( )
inline

Definition at line 106 of file AbcNodeDesc.h.

◆ setLowerBounds() [2/3]

void AbcNodeDesc::setLowerBounds ( const double *  lb,
const int  size 
)
inline

Definition at line 120 of file AbcNodeDesc.h.

◆ setLowerBound() [2/3]

void AbcNodeDesc::setLowerBound ( const int  index,
const double  lb 
)
inline

Definition at line 128 of file AbcNodeDesc.h.

◆ upperBounds() [2/3]

double* AbcNodeDesc::upperBounds ( )
inline

Definition at line 140 of file AbcNodeDesc.h.

◆ setUpperBounds() [2/3]

void AbcNodeDesc::setUpperBounds ( const double *  ub,
const int  size 
)
inline

Definition at line 152 of file AbcNodeDesc.h.

◆ setUpperBound() [2/3]

void AbcNodeDesc::setUpperBound ( const int  index,
const double  ub 
)
inline

Definition at line 160 of file AbcNodeDesc.h.

◆ setBranchedOn() [2/3]

void AbcNodeDesc::setBranchedOn ( int  b)
inline

Definition at line 172 of file AbcNodeDesc.h.

◆ setBranchedDir() [2/3]

void AbcNodeDesc::setBranchedDir ( int  d)
inline

Definition at line 174 of file AbcNodeDesc.h.

◆ setBranchedOnValue() [2/3]

void AbcNodeDesc::setBranchedOnValue ( double  b)
inline

Definition at line 176 of file AbcNodeDesc.h.

◆ getBranchedOn() [2/3]

int AbcNodeDesc::getBranchedOn ( ) const
inline

Definition at line 178 of file AbcNodeDesc.h.

◆ getBranchedDir() [2/3]

int AbcNodeDesc::getBranchedDir ( ) const
inline

Definition at line 180 of file AbcNodeDesc.h.

◆ getBranchedOnValue() [2/3]

double AbcNodeDesc::getBranchedOnValue ( ) const
inline

Definition at line 182 of file AbcNodeDesc.h.

◆ encode() [2/3]

virtual AlpsReturnStatus AbcNodeDesc::encode ( AlpsEncoded *  encoded) const
inlinevirtual

Pack this node description into the given AlpsEncoded object.

Reimplemented from AlpsNodeDesc.

Definition at line 184 of file AbcNodeDesc.h.

◆ decodeToSelf() [2/3]

virtual AlpsReturnStatus AbcNodeDesc::decodeToSelf ( AlpsEncoded &  encoded)
inlinevirtual

Unpack fields from the given AlpsEncoded object.

Reimplemented from AlpsNodeDesc.

Definition at line 189 of file AbcNodeDesc.h.

◆ decode() [2/3]

virtual AlpsNodeDesc* AbcNodeDesc::decode ( AlpsEncoded &  encoded) const
inlinevirtual

Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it.

User application sub-classes should implement this since the returned pointer will point to user sub-class instances.

Implements AlpsKnowledge.

Definition at line 194 of file AbcNodeDesc.h.

◆ lowerBounds() [3/3]

double* AbcNodeDesc::lowerBounds ( )
inline

Definition at line 106 of file AbcNodeDesc.h.

◆ setLowerBounds() [3/3]

void AbcNodeDesc::setLowerBounds ( const double *  lb,
const int  size 
)
inline

Definition at line 120 of file AbcNodeDesc.h.

◆ setLowerBound() [3/3]

void AbcNodeDesc::setLowerBound ( const int  index,
const double  lb 
)
inline

Definition at line 128 of file AbcNodeDesc.h.

◆ upperBounds() [3/3]

double* AbcNodeDesc::upperBounds ( )
inline

Definition at line 140 of file AbcNodeDesc.h.

◆ setUpperBounds() [3/3]

void AbcNodeDesc::setUpperBounds ( const double *  ub,
const int  size 
)
inline

Definition at line 152 of file AbcNodeDesc.h.

◆ setUpperBound() [3/3]

void AbcNodeDesc::setUpperBound ( const int  index,
const double  ub 
)
inline

Definition at line 160 of file AbcNodeDesc.h.

◆ setBranchedOn() [3/3]

void AbcNodeDesc::setBranchedOn ( int  b)
inline

Definition at line 172 of file AbcNodeDesc.h.

◆ setBranchedDir() [3/3]

void AbcNodeDesc::setBranchedDir ( int  d)
inline

Definition at line 174 of file AbcNodeDesc.h.

◆ setBranchedOnValue() [3/3]

void AbcNodeDesc::setBranchedOnValue ( double  b)
inline

Definition at line 176 of file AbcNodeDesc.h.

◆ getBranchedOn() [3/3]

int AbcNodeDesc::getBranchedOn ( ) const
inline

Definition at line 178 of file AbcNodeDesc.h.

◆ getBranchedDir() [3/3]

int AbcNodeDesc::getBranchedDir ( ) const
inline

Definition at line 180 of file AbcNodeDesc.h.

◆ getBranchedOnValue() [3/3]

double AbcNodeDesc::getBranchedOnValue ( ) const
inline

Definition at line 182 of file AbcNodeDesc.h.

◆ encode() [3/3]

virtual AlpsReturnStatus AbcNodeDesc::encode ( AlpsEncoded *  encoded) const
inlinevirtual

Pack this node description into the given AlpsEncoded object.

Reimplemented from AlpsNodeDesc.

Definition at line 184 of file AbcNodeDesc.h.

◆ decodeToSelf() [3/3]

virtual AlpsReturnStatus AbcNodeDesc::decodeToSelf ( AlpsEncoded &  encoded)
inlinevirtual

Unpack fields from the given AlpsEncoded object.

Reimplemented from AlpsNodeDesc.

Definition at line 189 of file AbcNodeDesc.h.

◆ decode() [3/3]

virtual AlpsNodeDesc* AbcNodeDesc::decode ( AlpsEncoded &  encoded) const
inlinevirtual

Decode the given AlpsEncoded object into a new AlpsKnowledge object and return a pointer to it.

User application sub-classes should implement this since the returned pointer will point to user sub-class instances.

Implements AlpsKnowledge.

Definition at line 194 of file AbcNodeDesc.h.

Member Data Documentation

◆ lowerBounds_

double * AbcNodeDesc::lowerBounds_
private

Definition at line 63 of file AbcNodeDesc.h.

◆ upperBounds_

double * AbcNodeDesc::upperBounds_
private

Definition at line 65 of file AbcNodeDesc.h.

◆ numberRows_

int AbcNodeDesc::numberRows_
private

Number of rows in problem (before these cuts).

This means that for top of chain it must be rows at continuous

Definition at line 69 of file AbcNodeDesc.h.

◆ numberCols_

int AbcNodeDesc::numberCols_
private

Definition at line 71 of file AbcNodeDesc.h.

◆ branchedOn_

int AbcNodeDesc::branchedOn_
private

The index of the branching variable.

Definition at line 74 of file AbcNodeDesc.h.

◆ branchedOnVal_

double AbcNodeDesc::branchedOnVal_
private

The solution value (non-integral) of the branching variable.

Definition at line 77 of file AbcNodeDesc.h.

◆ branchedDir_

int AbcNodeDesc::branchedDir_
private

Branching direction.

Definition at line 80 of file AbcNodeDesc.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17