Branching object for Orbital branching. More...

#include <CbcSymmetry.hpp>

Inheritance diagram for CbcOrbitalBranchingObject:

Collaboration diagram for CbcOrbitalBranchingObject:

Public Member Functions
	CbcOrbitalBranchingObject ()

	CbcOrbitalBranchingObject (CbcModel model, int column, int way, int numberExtra, const int extraToZero)

	CbcOrbitalBranchingObject (CbcModel *model, int column, int nFixed)

	CbcOrbitalBranchingObject (const CbcOrbitalBranchingObject &)

CbcOrbitalBranchingObject &	operator= (const CbcOrbitalBranchingObject &rhs)

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

virtual	~CbcOrbitalBranchingObject ()

virtual double	branch ()
	Does next branch and updates state. More...

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

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

virtual void	print ()
	Print something about branch - only if log level high. 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 bool	tighten (OsiSolverInterface *)
	Change (tighten) bounds in object to reflect bounds in solver. 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...

Private Attributes
int	column_
	Column to go to 1. More...

int	numberOther_
	Number (without column) going to zero on down branch. More...

int	numberExtra_
	Number extra. More...

int *	fixToZero_
	Fix to zero. More...

Additional Inherited Members
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

Branching object for Orbital branching.

Variable_ is the set id number (redundant, as the object also holds a pointer to the set.

Definition at line 357 of file CbcSymmetry.hpp.

Constructor & Destructor Documentation

◆ CbcOrbitalBranchingObject() [1/4]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject ( )

◆ CbcOrbitalBranchingObject() [2/4]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject	(	CbcModel *	model,
		int	column,
		int	way,
		int	numberExtra,
		const int *	extraToZero
	)

◆ CbcOrbitalBranchingObject() [3/4]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject	(	CbcModel *	model,
		int	column,
		int	nFixed
	)

◆ CbcOrbitalBranchingObject() [4/4]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject ( const CbcOrbitalBranchingObject & )

◆ ~CbcOrbitalBranchingObject()

virtual CbcOrbitalBranchingObject::~CbcOrbitalBranchingObject ( )

virtual

Member Function Documentation

◆ operator=()

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

◆ clone()

virtual CbcBranchingObject* CbcOrbitalBranchingObject::clone ( ) const

virtual

Clone.

Implements CbcBranchingObject.

◆ branch() [1/3]

virtual double CbcOrbitalBranchingObject::branch ( )

virtual

Does next branch and updates state.

Implements CbcBranchingObject.

◆ fix()

virtual void CbcOrbitalBranchingObject::fix	(	OsiSolverInterface *	solver,
		double *	lower,
		double *	upper,
		int	branchState
	)		const

virtual

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

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

Reimplemented from CbcBranchingObject.

◆ previousBranch()

virtual void CbcOrbitalBranchingObject::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 from CbcBranchingObject.

Definition at line 394 of file CbcSymmetry.hpp.

◆ print() [1/2]

virtual void CbcOrbitalBranchingObject::print ( )

virtual

Print something about branch - only if log level high.

◆ type()

virtual CbcBranchObjType CbcOrbitalBranchingObject::type ( ) const

inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 405 of file CbcSymmetry.hpp.

◆ compareOriginalObject()

virtual int CbcOrbitalBranchingObject::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 CbcOrbitalBranchingObject::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

◆ column_

int CbcOrbitalBranchingObject::column_

private

Column to go to 1.

Definition at line 431 of file CbcSymmetry.hpp.

◆ numberOther_

int CbcOrbitalBranchingObject::numberOther_

private

Number (without column) going to zero on down branch.

Definition at line 433 of file CbcSymmetry.hpp.

◆ numberExtra_

int CbcOrbitalBranchingObject::numberExtra_

private

Number extra.

Definition at line 435 of file CbcSymmetry.hpp.

◆ fixToZero_

int* CbcOrbitalBranchingObject::fixToZero_

private

Fix to zero.

Definition at line 437 of file CbcSymmetry.hpp.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CbcOrbitalBranchingObject() [1/4]

◆ CbcOrbitalBranchingObject() [2/4]

◆ CbcOrbitalBranchingObject() [3/4]

◆ CbcOrbitalBranchingObject() [4/4]

◆ ~CbcOrbitalBranchingObject()

Member Function Documentation

◆ operator=()

◆ clone()

◆ branch() [1/3]

◆ fix()

◆ previousBranch()

◆ print() [1/2]

◆ type()

◆ compareOriginalObject()

◆ compareBranchingObject()

◆ branch() [2/3]

◆ branch() [3/3]

◆ print() [2/2]

Member Data Documentation

◆ column_

◆ numberOther_

◆ numberExtra_

◆ fixToZero_