Abstract branching object base class Now just difference with OsiBranchingObject. More...

#include <CbcBranchingObject.hpp>

Inheritance diagram for CbcBranchingObject:

Collaboration diagram for CbcBranchingObject:

Public Member Functions
	CbcBranchingObject ()
	Default Constructor. More...

	CbcBranchingObject (CbcModel *model, int variable, int way, double value)
	Constructor. More...

	CbcBranchingObject (const CbcBranchingObject &)
	Copy constructor. More...

CbcBranchingObject &	operator= (const CbcBranchingObject &rhs)
	Assignment operator. More...

virtual CbcBranchingObject *	clone () const =0
	Clone. More...

virtual	~CbcBranchingObject ()
	Destructor. More...

virtual int	fillStrongInfo (CbcStrongInfo &)
	Some branchingObjects may claim to be able to skip strong branching. More...

void	resetNumberBranchesLeft ()
	Reset number of branches left to original. More...

void	setNumberBranches (int value)
	Set number of branches to do. More...

virtual double	branch ()=0
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...

virtual double	branch (OsiSolverInterface *)
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...

virtual void	fix (OsiSolverInterface , double , double *, int) const
	Update bounds in solver as in 'branch' and update given bounds. More...

virtual bool	tighten (OsiSolverInterface *)
	Change (tighten) bounds in object to reflect bounds in solver. More...

virtual void	previousBranch ()
	Reset every information so that the branching object appears to point to the previous child. More...

virtual void	print () const
	Print something about branch - only if log level high. More...

int	variable () const
	Index identifying the associated CbcObject within its class. More...

int	way () const
	Get the state of the branching object. More...

void	way (int way)
	Set the state of the branching object. More...

void	setModel (CbcModel *model)
	update model More...

CbcModel *	model () const
	Return model. More...

CbcObject *	object () const
	Return pointer back to object which created. More...

void	setOriginalObject (CbcObject *object)
	Set pointer back to object which created. More...

virtual CbcBranchObjType	type () const =0
	Return the type (an integer identifier) of `this`. More...

virtual int	compareOriginalObject (const CbcBranchingObject *brObj) const
	Compare the original object of `this` with the original object of `brObj`. More...

virtual CbcRangeCompare	compareBranchingObject (const CbcBranchingObject *brObj, const bool replaceIfOverlap=false)=0
	Compare the `this` with `brObj`. More...

Protected Attributes
CbcModel *	model_
	The model that owns this branching object. More...

CbcObject *	originalCbcObject_
	Pointer back to object which created. More...

int	variable_
	Branching variable (0 is first integer) More...

int	way_
	The state of the branching object. More...

Detailed Description

Abstract branching object base class Now just difference with OsiBranchingObject.

In the abstract, an CbcBranchingObject contains instructions for how to branch. We want an abstract class so that we can describe how to branch on simple objects (e.g., integers) and more exotic objects (e.g., cliques or hyperplanes).

The branch() method is the crucial routine: it is expected to be able to step through a set of branch arms, executing the actions required to create each subproblem in turn. The base class is primarily virtual to allow for a wide range of problem modifications.

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

Definition at line 51 of file CbcBranchingObject.hpp.

Constructor & Destructor Documentation

◆ CbcBranchingObject() [1/3]

CbcBranchingObject::CbcBranchingObject ( )

Default Constructor.

◆ CbcBranchingObject() [2/3]

CbcBranchingObject::CbcBranchingObject	(	CbcModel *	model,
		int	variable,
		int	way,
		double	value
	)

Constructor.

◆ CbcBranchingObject() [3/3]

CbcBranchingObject::CbcBranchingObject ( const CbcBranchingObject & )

Copy constructor.

◆ ~CbcBranchingObject()

virtual CbcBranchingObject::~CbcBranchingObject ( )

virtual

Destructor.

Member Function Documentation

◆ operator=()

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

Assignment operator.

◆ clone()

virtual CbcBranchingObject* CbcBranchingObject::clone ( ) const

pure virtual

Clone.

Implemented in CbcIntegerPseudoCostBranchingObject, CbcOrbitalBranchingObject, CbcLongCliqueBranchingObject, CbcSOSBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcDynamicPseudoCostBranchingObject, CbcCutBranchingObject, CbcLinkBranchingObject, CbcNWayBranchingObject, CbcFixingBranchingObject, CbcIntegerBranchingObject, and CbcDummyBranchingObject.

◆ fillStrongInfo()

virtual int CbcBranchingObject::fillStrongInfo ( CbcStrongInfo & )

inlinevirtual

Some branchingObjects may claim to be able to skip strong branching.

If so they have to fill in CbcStrongInfo. The object mention in incoming CbcStrongInfo must match. Returns nonzero if skip is wanted

Reimplemented in CbcDynamicPseudoCostBranchingObject.

Definition at line 76 of file CbcBranchingObject.hpp.

◆ resetNumberBranchesLeft()

void CbcBranchingObject::resetNumberBranchesLeft ( )

inline

Reset number of branches left to original.

Definition at line 81 of file CbcBranchingObject.hpp.

◆ setNumberBranches()

void CbcBranchingObject::setNumberBranches ( int value )

inline

Set number of branches to do.

Definition at line 86 of file CbcBranchingObject.hpp.

◆ branch() [1/2]

virtual double CbcBranchingObject::branch ( )

pure virtual

Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state.

Mainly for diagnostics, whether it is true branch or strong branching is also passed. Returns change in guessed objective on next branch

Implemented in CbcIntegerPseudoCostBranchingObject, CbcOrbitalBranchingObject, CbcLongCliqueBranchingObject, CbcSOSBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcDynamicPseudoCostBranchingObject, CbcCutBranchingObject, CbcLinkBranchingObject, CbcNWayBranchingObject, CbcFixingBranchingObject, CbcIntegerBranchingObject, and CbcDummyBranchingObject.

◆ branch() [2/2]

virtual double CbcBranchingObject::branch ( OsiSolverInterface * )

inlinevirtual

Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state.

Mainly for diagnostics, whether it is true branch or strong branching is also passed. Returns change in guessed objective on next branch

Definition at line 105 of file CbcBranchingObject.hpp.

◆ fix()

virtual void CbcBranchingObject::fix	(	OsiSolverInterface *	,
		double *	,
		double *	,
		int
	)		const

inlinevirtual

Update bounds in solver as in 'branch' and update given bounds.

branchState is -1 for 'down' +1 for 'up'

Reimplemented in CbcOrbitalBranchingObject, CbcSOSBranchingObject, and CbcIntegerBranchingObject.

Definition at line 111 of file CbcBranchingObject.hpp.

◆ tighten()

virtual bool CbcBranchingObject::tighten ( OsiSolverInterface * )

inlinevirtual

Change (tighten) bounds in object to reflect bounds in solver.

Return true if now fixed

Reimplemented in CbcIntegerBranchingObject.

Definition at line 117 of file CbcBranchingObject.hpp.

◆ previousBranch()

virtual void CbcBranchingObject::previousBranch ( )

inlinevirtual

Reset every information so that the branching object appears to point to the previous child.

This method does not need to modify anything in any solver.

Reimplemented in CbcOrbitalBranchingObject, and CbcSOSBranchingObject.

Definition at line 122 of file CbcBranchingObject.hpp.

◆ print()

virtual void CbcBranchingObject::print ( ) const

inlinevirtual

Print something about branch - only if log level high.

Definition at line 132 of file CbcBranchingObject.hpp.

◆ variable()

int CbcBranchingObject::variable ( ) const

inline

Index identifying the associated CbcObject within its class.

The name is misleading, and typically the index will not refer directly to a variable. Rather, it identifies an CbcObject within the class of similar CbcObjects

E.g., for an CbcSimpleInteger, variable() is the index of the integer variable in the set of integer variables (not the index of the variable in the set of all variables).

Definition at line 145 of file CbcBranchingObject.hpp.

◆ way() [1/2]

int CbcBranchingObject::way ( ) const

inline

Get the state of the branching object.

Returns a code indicating the active arm of the branching object. The precise meaning is defined in the derived class.

See also: way_

Definition at line 157 of file CbcBranchingObject.hpp.

◆ way() [2/2]

void CbcBranchingObject::way ( int way )

inline

Set the state of the branching object.

See way()

Definition at line 166 of file CbcBranchingObject.hpp.

◆ setModel()

void CbcBranchingObject::setModel ( CbcModel * model )

inline

update model

Definition at line 172 of file CbcBranchingObject.hpp.

◆ model()

CbcModel* CbcBranchingObject::model ( ) const

inline

Return model.

Definition at line 177 of file CbcBranchingObject.hpp.

◆ object()

CbcObject* CbcBranchingObject::object ( ) const

inline

Return pointer back to object which created.

Definition at line 183 of file CbcBranchingObject.hpp.

◆ setOriginalObject()

void CbcBranchingObject::setOriginalObject ( CbcObject * object )

inline

Set pointer back to object which created.

Definition at line 188 of file CbcBranchingObject.hpp.

◆ type()

virtual CbcBranchObjType CbcBranchingObject::type ( ) const

pure virtual

Return the type (an integer identifier) of this.

See definition of CbcBranchObjType above for possibilities

Implemented in CbcIntegerPseudoCostBranchingObject, CbcOrbitalBranchingObject, CbcLongCliqueBranchingObject, CbcSOSBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcDynamicPseudoCostBranchingObject, CbcCutBranchingObject, CbcIntegerBranchingObject, CbcNWayBranchingObject, CbcLinkBranchingObject, CbcFixingBranchingObject, and CbcDummyBranchingObject.

◆ compareOriginalObject()

virtual int CbcBranchingObject::compareOriginalObject ( const CbcBranchingObject * brObj ) const

inlinevirtual

Compare the original object of this with the original object of brObj.

Assumes that there is an ordering of the original objects. This method should be invoked only if this and brObj are of the same type. Return negative/0/positive depending on whether this is smaller/same/larger than the argument.

Reimplemented in CbcOrbitalBranchingObject, CbcLongCliqueBranchingObject, CbcSOSBranchingObject, CbcCliqueBranchingObject, CbcCutBranchingObject, CbcNWayBranchingObject, CbcFixingBranchingObject, and CbcDummyBranchingObject.

Definition at line 208 of file CbcBranchingObject.hpp.

◆ compareBranchingObject()

virtual CbcRangeCompare CbcBranchingObject::compareBranchingObject	(	const CbcBranchingObject *	brObj,
		const bool	replaceIfOverlap = `false`
	)

pure virtual

Compare the this with brObj.

this and brObj must be of the same type and must have the same original object, but they may have different feasible regions. Return the appropriate CbcRangeCompare value (first argument being the sub/superset if that's the case). In case of overlap (and if replaceIfOverlap is true) replace the current branching object with one whose feasible region is the overlap.

Implemented in CbcIntegerPseudoCostBranchingObject, CbcOrbitalBranchingObject, CbcLongCliqueBranchingObject, CbcSOSBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcCutBranchingObject, CbcNWayBranchingObject, CbcIntegerBranchingObject, CbcLinkBranchingObject, CbcFixingBranchingObject, and CbcDummyBranchingObject.

Member Data Documentation

◆ model_

CbcModel* CbcBranchingObject::model_

protected

The model that owns this branching object.

Definition at line 226 of file CbcBranchingObject.hpp.

◆ originalCbcObject_

CbcObject* CbcBranchingObject::originalCbcObject_

protected

Pointer back to object which created.

Definition at line 228 of file CbcBranchingObject.hpp.

◆ variable_

int CbcBranchingObject::variable_

protected

Branching variable (0 is first integer)

Definition at line 231 of file CbcBranchingObject.hpp.

◆ way_

int CbcBranchingObject::way_

protected

The state of the branching object.

Specifies the active arm of the branching object. Coded as -1 to take the ‘down’ arm, +1 for the ‘up’ arm. ‘Down’ and ‘up’ are defined based on the natural meaning (floor and ceiling, respectively) for a simple integer. The precise meaning is defined in the derived class.

Definition at line 240 of file CbcBranchingObject.hpp.

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

/home/ted/Projects/Cbc/Cbc/src/CbcBranchingObject.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcBranchingObject() [1/3]

◆ CbcBranchingObject() [2/3]

◆ CbcBranchingObject() [3/3]

◆ ~CbcBranchingObject()

Member Function Documentation

◆ operator=()

◆ clone()

◆ fillStrongInfo()

◆ resetNumberBranchesLeft()

◆ setNumberBranches()

◆ branch() [1/2]

◆ branch() [2/2]

◆ fix()

◆ tighten()

◆ previousBranch()

◆ print()

◆ variable()

◆ way() [1/2]

◆ way() [2/2]

◆ setModel()

◆ model()

◆ object()

◆ setOriginalObject()

◆ type()

◆ compareOriginalObject()

◆ compareBranchingObject()

Member Data Documentation

◆ model_

◆ originalCbcObject_

◆ variable_

◆ way_