CbcBranchDecision Class Reference

Abstract branching decision base class. More...

#include <CbcBranchBase.hpp>

Inheritance diagram for CbcBranchDecision:

[legend]

Collaboration diagram for CbcBranchDecision:

[legend]

List of all members.

Public Member Functions
	CbcBranchDecision ()
	Default Constructor.
	CbcBranchDecision (const CbcBranchDecision &)
virtual	~CbcBranchDecision ()
	Destructor.
virtual CbcBranchDecision *	clone () const =0
	Clone.
virtual void	initialize (CbcModel *model)=0
	Initialize e.g. before starting to choose a branch at a node.
virtual int	betterBranch (CbcBranchingObject thisOne, CbcBranchingObject bestSoFar, double changeUp, int numberInfeasibilitiesUp, double changeDown, int numberInfeasibilitiesDown)=0
	Compare two branching objects.
virtual int	bestBranch (CbcBranchingObject *objects, int numberObjects, int numberUnsatisfied, double changeUp, int numberInfeasibilitiesUp, double changeDown, int *numberInfeasibilitiesDown, double objectiveValue)
	Compare N branching objects.
virtual int	whichMethod ()
	Says whether this method can handle both methods - 1 better, 2 best, 3 both.
virtual void	saveBranchingObject (OsiBranchingObject *object)
	Saves a clone of current branching object.
virtual void	updateInformation (OsiSolverInterface solver, const CbcNode node)
	Pass in information on branch just done.
virtual void	setBestCriterion (double value)
	Sets or gets best criterion so far.
virtual double	getBestCriterion () const
virtual void	generateCpp (FILE *fp)
	Create C++ lines to get to current state.
CbcModel *	cbcModel () const
	Model.
OsiChooseVariable *	chooseMethod () const
void	setChooseMethod (const OsiChooseVariable &method)
	Set (clone) chooseMethod.
Protected Attributes
CbcBranchingObject *	object_
CbcModel *	model_
	Pointer to model.
OsiChooseVariable *	chooseMethod_
Private Member Functions
CbcBranchDecision &	operator= (const CbcBranchDecision &rhs)
	Assignment is illegal.

Detailed Description

Abstract branching decision base class.

In the abstract, an CbcBranchDecision object is expected to be able to compare two possible branching choices.

The betterBranch() method is the crucial routine. It is expected to be able to compare two CbcBranchingObjects .

See CbcObject for an overview of the three classes (CbcObject, CbcBranchingObject, and CbcBranchDecision) which make up cbc's branching model.

Definition at line 434 of file CbcBranchBase.hpp.

Constructor & Destructor Documentation

CbcBranchDecision::CbcBranchDecision ( )

Default Constructor.

CbcBranchDecision::CbcBranchDecision ( const CbcBranchDecision & )

virtual CbcBranchDecision::~CbcBranchDecision ( ) [virtual]

Destructor.

Member Function Documentation

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

Clone.

Implemented in CbcBranchUserDecision, CbcBranchDefaultDecision, and CbcBranchDynamicDecision.

virtual void CbcBranchDecision::initialize ( CbcModel * model ) [pure virtual]

Initialize e.g. before starting to choose a branch at a node.

Implemented in CbcBranchUserDecision, CbcBranchDefaultDecision, and CbcBranchDynamicDecision.

virtual int CbcBranchDecision::betterBranch	(	CbcBranchingObject *	thisOne,
		CbcBranchingObject *	bestSoFar,
		double	changeUp,
		int	numberInfeasibilitiesUp,
		double	changeDown,
		int	numberInfeasibilitiesDown
	)			`[pure virtual]`

Compare two branching objects.

Return nonzero if branching using thisOne is better than branching using bestSoFar.

If bestSoFar is NULL, the routine should return a nonzero value. This routine is used only after strong branching. Either this or bestBranch is used depending which user wants.

Implemented in CbcBranchUserDecision, CbcBranchDefaultDecision, and CbcBranchDynamicDecision.

virtual int CbcBranchDecision::bestBranch	(	CbcBranchingObject **	objects,
		int	numberObjects,
		int	numberUnsatisfied,
		double *	changeUp,
		int *	numberInfeasibilitiesUp,
		double *	changeDown,
		int *	numberInfeasibilitiesDown,
		double	objectiveValue
	)			`[virtual]`