Cut branching object. More...

#include <CbcBranchCut.hpp>

Inheritance diagram for CbcCutBranchingObject:

Collaboration diagram for CbcCutBranchingObject:

Public Member Functions
	CbcCutBranchingObject ()
	Default constructor. More...

	CbcCutBranchingObject (CbcModel *model, OsiRowCut &down, OsiRowCut &up, bool canFix)
	Create a cut branching object. More...

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

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

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

virtual	~CbcCutBranchingObject ()
	Destructor. More...

virtual double	branch ()
	Sets the bounds for variables or adds a cut depending on the current arm of the branch and advances the object state to the next arm. More...

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

virtual bool	boundBranch () const
	Return true if branch should fix variables. More...

virtual CbcBranchObjType	type () const
	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)
	Compare the `this` with `brObj`. 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	print () const
	Print something about branch - only if log level high. More...

Public Member Functions inherited from CbcBranchingObject
	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 ()
	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 (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...

Protected Attributes
OsiRowCut	down_
	Cut for the down arm (way_ = -1) More...

OsiRowCut	up_
	Cut for the up arm (way_ = 1) More...

bool	canFix_
	True if one way can fix variables. More...

Protected Attributes inherited from CbcBranchingObject
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

Cut branching object.

This object can specify a two-way branch in terms of two cuts

Definition at line 105 of file CbcBranchCut.hpp.

Constructor & Destructor Documentation

◆ CbcCutBranchingObject() [1/3]

CbcCutBranchingObject::CbcCutBranchingObject ( )

Default constructor.

◆ CbcCutBranchingObject() [2/3]

CbcCutBranchingObject::CbcCutBranchingObject	(	CbcModel *	model,
		OsiRowCut &	down,
		OsiRowCut &	up,
		bool	canFix
	)

Create a cut branching object.

Cut down will applied on way=-1, up on way==1 Assumed down will be first so way_ set to -1

◆ CbcCutBranchingObject() [3/3]

CbcCutBranchingObject::CbcCutBranchingObject ( const CbcCutBranchingObject & )

Copy constructor.

◆ ~CbcCutBranchingObject()

virtual CbcCutBranchingObject::~CbcCutBranchingObject ( )

virtual

Destructor.

Member Function Documentation

◆ operator=()

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

Assignment operator.

◆ clone()

virtual CbcBranchingObject* CbcCutBranchingObject::clone ( ) const

virtual

Clone.

Implements CbcBranchingObject.

◆ branch() [1/3]

virtual double CbcCutBranchingObject::branch ( )

virtual

Sets the bounds for variables or adds a cut depending on the current arm of the branch and advances the object state to the next arm.

Returns change in guessed objective on next branch

Implements CbcBranchingObject.

◆ print() [1/2]

virtual void CbcCutBranchingObject::print ( )

virtual

Print something about branch - only if log level high.

◆ boundBranch()

virtual bool CbcCutBranchingObject::boundBranch ( ) const

virtual

Return true if branch should fix variables.

◆ type()

virtual CbcBranchObjType CbcCutBranchingObject::type ( ) const

inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 147 of file CbcBranchCut.hpp.

◆ compareOriginalObject()

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

virtual

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 from CbcBranchingObject.

◆ compareBranchingObject()

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

virtual

Compare the this with brObj.

this and brObj must be os 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.

Implements CbcBranchingObject.

◆ branch() [2/3]

virtual double CbcBranchingObject::branch

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

◆ branch() [3/3]

virtual double CbcBranchingObject::branch

inline

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.

◆ print() [2/2]

virtual void CbcBranchingObject::print

inline

Print something about branch - only if log level high.

Definition at line 132 of file CbcBranchingObject.hpp.

Member Data Documentation

◆ down_

OsiRowCut CbcCutBranchingObject::down_

protected

Cut for the down arm (way_ = -1)

Definition at line 173 of file CbcBranchCut.hpp.

◆ up_

OsiRowCut CbcCutBranchingObject::up_

protected

Cut for the up arm (way_ = 1)

Definition at line 175 of file CbcBranchCut.hpp.

◆ canFix_

bool CbcCutBranchingObject::canFix_

protected

True if one way can fix variables.

Definition at line 177 of file CbcBranchCut.hpp.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcCutBranchingObject() [1/3]

◆ CbcCutBranchingObject() [2/3]

◆ CbcCutBranchingObject() [3/3]

◆ ~CbcCutBranchingObject()

Member Function Documentation

◆ operator=()

◆ clone()

◆ branch() [1/3]

◆ print() [1/2]

◆ boundBranch()

◆ type()

◆ compareOriginalObject()

◆ compareBranchingObject()

◆ branch() [2/3]

◆ branch() [3/3]

◆ print() [2/2]

Member Data Documentation

◆ down_

◆ up_

◆ canFix_