Blis  0.94
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BlisBranchObjectBilevel Class Reference

#include <BlisBranchObjectBilevel.h>

+ Inheritance diagram for BlisBranchObjectBilevel:
+ Collaboration diagram for BlisBranchObjectBilevel:

Public Member Functions

 BlisBranchObjectBilevel ()
 Default constructor. More...
 
 BlisBranchObjectBilevel (BcpsModel *model)
 Another useful constructor. More...
 
 BlisBranchObjectBilevel (const BlisBranchObjectBilevel &rhs)
 Copy constructor. More...
 
BlisBranchObjectBileveloperator= (const BlisBranchObjectBilevel &rhs)
 Assignment operator. More...
 
virtual BcpsBranchObjectclone () const
 Clone. More...
 
virtual ~BlisBranchObjectBilevel ()
 Destructor. More...
 
std::deque< int > * getBranchingSet () const
 Get a pointer to the branching set. More...
 
void addToBranchingSet (int item)
 Get a pointer to the branching set. More...
 
virtual double branch (bool normalBranch=false)
 Set the bounds for the variable according to the current arm of the branch and advances the object state to the next arm. More...
 
virtual void print (bool normalBranch)
 Print something about branch - only if log level high. More...
 
virtual AlpsReturnStatus encode (AlpsEncoded *encoded) const
 Pack to an encoded object. More...
 
virtual AlpsReturnStatus decode (AlpsEncoded &encoded)
 Unpack a branching object from an encoded object. More...
 
- Public Member Functions inherited from BcpsBranchObject
 BcpsBranchObject ()
 
 BcpsBranchObject (BcpsModel *model)
 
 BcpsBranchObject (BcpsModel *model, int objectIndex, int direction, double value)
 
 BcpsBranchObject (BcpsModel *model, int objectIndex, double upScore, double downScore, int direction, double value)
 
 BcpsBranchObject (const BcpsBranchObject &)
 
virtual ~BcpsBranchObject ()
 
BcpsBranchObjectoperator= (const BcpsBranchObject &rhs)
 
int getType ()
 
void setType (int t)
 
virtual int numBranches () const
 
virtual int numBranchesLeft () const
 
virtual bool boundBranch () const
 
int getObjectIndex () const
 
void setObjectIndex (int ind)
 
double getUpScore () const
 
void setUpScore (double score)
 
double getDownScore () const
 
void setDownScore (double score)
 
int getDirection () const
 
void setDirection (int direction)
 
double getValue () const
 
BcpsModelmodel () const
 

Protected Member Functions

AlpsReturnStatus encodeBlis (AlpsEncoded *encoded) const
 Pack Blis portion to an encoded object. More...
 
AlpsReturnStatus decodeBlis (AlpsEncoded &encoded)
 Unpack Blis portion from an encoded object. More...
 
- Protected Member Functions inherited from BcpsBranchObject
AlpsReturnStatus encodeBcps (AlpsEncoded *encoded) const
 
AlpsReturnStatus decodeBcps (AlpsEncoded &encoded)
 

Protected Attributes

std::deque< int > * branchingSet_
 The indices of variables in the branching set. More...
 
- Protected Attributes inherited from BcpsBranchObject
int type_
 
BcpsModelmodel_
 
int objectIndex_
 
double upScore_
 
double downScore_
 
int direction_
 
double value_
 
int numBranchesLeft_
 

Detailed Description

Definition at line 38 of file BlisBranchObjectBilevel.h.

Constructor & Destructor Documentation

◆ BlisBranchObjectBilevel() [1/3]

BlisBranchObjectBilevel::BlisBranchObjectBilevel ( )
inline

Default constructor.

Definition at line 48 of file BlisBranchObjectBilevel.h.

◆ BlisBranchObjectBilevel() [2/3]

BlisBranchObjectBilevel::BlisBranchObjectBilevel ( BcpsModel model)
inline

Another useful constructor.

Definition at line 55 of file BlisBranchObjectBilevel.h.

◆ BlisBranchObjectBilevel() [3/3]

BlisBranchObjectBilevel::BlisBranchObjectBilevel ( const BlisBranchObjectBilevel rhs)
inline

Copy constructor.

Definition at line 62 of file BlisBranchObjectBilevel.h.

◆ ~BlisBranchObjectBilevel()

virtual BlisBranchObjectBilevel::~BlisBranchObjectBilevel ( )
inlinevirtual

Destructor.

Definition at line 75 of file BlisBranchObjectBilevel.h.

Member Function Documentation

◆ operator=()

BlisBranchObjectBilevel& BlisBranchObjectBilevel::operator= ( const BlisBranchObjectBilevel rhs)

Assignment operator.

◆ clone()

virtual BcpsBranchObject* BlisBranchObjectBilevel::clone ( ) const
inlinevirtual

Clone.

Implements BcpsBranchObject.

Definition at line 70 of file BlisBranchObjectBilevel.h.

◆ getBranchingSet()

std::deque<int>* BlisBranchObjectBilevel::getBranchingSet ( ) const
inline

Get a pointer to the branching set.

Definition at line 78 of file BlisBranchObjectBilevel.h.

◆ addToBranchingSet()

void BlisBranchObjectBilevel::addToBranchingSet ( int  item)
inline

Get a pointer to the branching set.

Definition at line 81 of file BlisBranchObjectBilevel.h.

◆ branch()

virtual double BlisBranchObjectBilevel::branch ( bool  normalBranch = false)
virtual

Set the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.

Returns change in guessed objective on next branch.

Implements BcpsBranchObject.

◆ print()

virtual void BlisBranchObjectBilevel::print ( bool  normalBranch)
virtual

Print something about branch - only if log level high.

Reimplemented from BcpsBranchObject.

◆ encodeBlis()

AlpsReturnStatus BlisBranchObjectBilevel::encodeBlis ( AlpsEncoded encoded) const
inlineprotected

Pack Blis portion to an encoded object.

Definition at line 94 of file BlisBranchObjectBilevel.h.

◆ decodeBlis()

AlpsReturnStatus BlisBranchObjectBilevel::decodeBlis ( AlpsEncoded encoded)
inlineprotected

Unpack Blis portion from an encoded object.

Definition at line 101 of file BlisBranchObjectBilevel.h.

◆ encode()

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

Pack to an encoded object.

Reimplemented from BcpsBranchObject.

Definition at line 109 of file BlisBranchObjectBilevel.h.

◆ decode()

virtual AlpsReturnStatus BlisBranchObjectBilevel::decode ( AlpsEncoded encoded)
inlinevirtual

Unpack a branching object from an encoded object.

Reimplemented from BcpsBranchObject.

Definition at line 119 of file BlisBranchObjectBilevel.h.

Member Data Documentation

◆ branchingSet_

std::deque<int>* BlisBranchObjectBilevel::branchingSet_
protected

The indices of variables in the branching set.

Definition at line 43 of file BlisBranchObjectBilevel.h.


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