BcpsBranchStrategy Class Reference

Branching strategy specifies: (1) how to select a candidate set of branching objects (2) how to compare two branching objects. More...

#include <BcpsBranchStrategy.h>

Inheritance diagram for BcpsBranchStrategy:

[legend]Collaboration diagram for BcpsBranchStrategy:

[legend]List of all members.


Public Member Functions
	BcpsBranchStrategy ()
	Default Constructor.
	BcpsBranchStrategy (BcpsModel *m)
	Useful Constructor.
virtual	~BcpsBranchStrategy ()
	Destructor.
virtual BcpsBranchStrategy *	clone () const =0
	Clone a branch strategy.
void	setModel (BcpsModel *m)
	Set model.
virtual void	clearBest (BcpsModel *model)
	Clear branching strategy environment before starting a new round of selecting the best branch object.
virtual int	createCandBranchObjects (int numPassesLeft)
	Create a set of candidate branching objects.
virtual int	betterBranchObject (BcpsBranchObject b, BcpsBranchObject bestSoFar)=0
	Compare branching object thisOne to bestSoFar.
virtual int	bestBranchObject ()
	Compare branching objects in branchObjects_.

int	getNumBranchObjects ()
	Set/get branching objects.
void	getNumBranchObjects (int num)
	Set/get branching objects.
BcpsBranchObject **	getBranchObjects ()
	Set/get branching objects.
void	setBranchObjects (BcpsBranchObject **obj)
	Set/get branching objects.
BcpsBranchObject *	getBestBranchObject ()
	Set/get branching objects.
void	setBestBranchObject (BcpsBranchObject *ob)
	Set/get branching objects.
Protected Attributes
BcpsModel *	model_
	Pointer to model.

int	numBranchObjects_
	Number of candidate branching objects.
BcpsBranchObject **	branchObjects_
	The set of candiate branching objects.

BcpsBranchObject *	bestBranchObject_
	Best branching object found so far.
double	bestChangeUp_
	Change up for best.
int	bestNumberUp_
	Number of infeasibilities for up.
double	bestChangeDown_
	Change down for best.
int	bestNumberDown_
	Number of infeasibilities for down.
Private Member Functions
BcpsBranchStrategy &	operator= (const BcpsBranchStrategy &rhs)
	Disable assignment operator.

Detailed Description

Branching strategy specifies: (1) how to select a candidate set of branching objects (2) how to compare two branching objects.

Definition at line 39 of file BcpsBranchStrategy.h.

Constructor & Destructor Documentation

BcpsBranchStrategy::BcpsBranchStrategy ( ) [inline]

Default Constructor.

Definition at line 80 of file BcpsBranchStrategy.h.

BcpsBranchStrategy::BcpsBranchStrategy ( BcpsModel * m ) [inline]

Useful Constructor.

Definition at line 92 of file BcpsBranchStrategy.h.

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

Destructor.

Definition at line 104 of file BcpsBranchStrategy.h.

References branchObjects_, and numBranchObjects_.

Member Function Documentation

BcpsBranchStrategy& BcpsBranchStrategy::operator= ( const BcpsBranchStrategy & rhs ) [private]

Disable assignment operator.

virtual BcpsBranchStrategy* BcpsBranchStrategy::clone ( ) const [pure virtual]

Clone a branch strategy.

Implemented in BlisBranchStrategyPseudo, BlisBranchStrategyRel, BlisBranchStrategyStrong, BlisBranchStrategyMaxInf, BlisBranchStrategyPseudo, BlisBranchStrategyRel, and BlisBranchStrategyStrong.

void BcpsBranchStrategy::setModel ( BcpsModel * m ) [inline]

Set model.

Definition at line 115 of file BcpsBranchStrategy.h.

References model_.

int BcpsBranchStrategy::getNumBranchObjects ( ) [inline]

Set/get branching objects.

Definition at line 119 of file BcpsBranchStrategy.h.

References numBranchObjects_.

void BcpsBranchStrategy::getNumBranchObjects ( int num ) [inline]

Set/get branching objects.

Definition at line 120 of file BcpsBranchStrategy.h.

References numBranchObjects_.

BcpsBranchObject** BcpsBranchStrategy::getBranchObjects ( ) [inline]

Set/get branching objects.

Definition at line 121 of file BcpsBranchStrategy.h.

References branchObjects_.

void BcpsBranchStrategy::setBranchObjects ( BcpsBranchObject ** obj ) [inline]

Set/get branching objects.

Definition at line 122 of file BcpsBranchStrategy.h.

References branchObjects_.

BcpsBranchObject* BcpsBranchStrategy::getBestBranchObject ( ) [inline]

Set/get branching objects.

Definition at line 123 of file BcpsBranchStrategy.h.

References bestBranchObject_.

void BcpsBranchStrategy::setBestBranchObject ( BcpsBranchObject * ob ) [inline]

Set/get branching objects.

Definition at line 124 of file BcpsBranchStrategy.h.

References bestBranchObject_.

virtual void BcpsBranchStrategy::clearBest ( BcpsModel * model ) [inline, virtual]

Clear branching strategy environment before starting a new round of selecting the best branch object.

Definition at line 129 of file BcpsBranchStrategy.h.

References bestBranchObject_, bestChangeDown_, bestChangeUp_, bestNumberDown_, and bestNumberUp_.

virtual int BcpsBranchStrategy::createCandBranchObjects ( int numPassesLeft ) [inline, virtual]

Create a set of candidate branching objects.

Reimplemented in BlisBranchStrategyPseudo, BlisBranchStrategyRel, BlisBranchStrategyStrong, BlisBranchStrategyMaxInf, BlisBranchStrategyPseudo, BlisBranchStrategyRel, and BlisBranchStrategyStrong.

Definition at line 138 of file BcpsBranchStrategy.h.

virtual int BcpsBranchStrategy::betterBranchObject	(	BcpsBranchObject *	b,
		BcpsBranchObject *	bestSoFar
	)			`[pure virtual]`

Compare branching object thisOne to bestSoFar.

If thisOne is better than bestObject, return branching direction(1 or -1), otherwise return 0. If bestSorFar is NULL, then always return branching direction(1 or -1).

Implemented in BlisBranchStrategyPseudo, BlisBranchStrategyRel, BlisBranchStrategyStrong, BlisBranchStrategyMaxInf, BlisBranchStrategyPseudo, BlisBranchStrategyRel, and BlisBranchStrategyStrong.

virtual int BcpsBranchStrategy::bestBranchObject ( ) [virtual]

Compare branching objects in branchObjects_.

Return the index of the best branching object. Also, set branch direction in the best object.