N way branching Object class. More...

#include <CbcNWay.hpp>

Inheritance diagram for CbcNWayBranchingObject:

Collaboration diagram for CbcNWayBranchingObject:

Public Member Functions
	CbcNWayBranchingObject ()

	CbcNWayBranchingObject (CbcModel model, const CbcNWay nway, int numberBranches, const int *order)
	Useful constructor - order had matrix indices way_ -1 corresponds to setting first, +1 to second, +3 etc. More...

	CbcNWayBranchingObject (const CbcNWayBranchingObject &)

CbcNWayBranchingObject &	operator= (const CbcNWayBranchingObject &rhs)

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

virtual	~CbcNWayBranchingObject ()

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

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

virtual int	numberBranches () const
	The number of branch arms created for this branching object. More...

virtual bool	twoWay () const
	Is this a two way object (-1 down, +1 up) 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...

Private Attributes
int *	order_
	order of branching - points back to CbcNWay More...

const CbcNWay *	object_
	Points back to object. More...

int	numberInSet_
	Number in set. 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

N way branching Object class.

Variable is number of set.

Definition at line 82 of file CbcNWay.hpp.

Constructor & Destructor Documentation

◆ CbcNWayBranchingObject() [1/3]

CbcNWayBranchingObject::CbcNWayBranchingObject ( )

◆ CbcNWayBranchingObject() [2/3]

CbcNWayBranchingObject::CbcNWayBranchingObject	(	CbcModel *	model,
		const CbcNWay *	nway,
		int	numberBranches,
		const int *	order
	)

Useful constructor - order had matrix indices way_ -1 corresponds to setting first, +1 to second, +3 etc.

this is so -1 and +1 have similarity to normal

◆ CbcNWayBranchingObject() [3/3]

CbcNWayBranchingObject::CbcNWayBranchingObject ( const CbcNWayBranchingObject & )

◆ ~CbcNWayBranchingObject()

virtual CbcNWayBranchingObject::~CbcNWayBranchingObject ( )

virtual

Member Function Documentation

◆ operator=()

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

◆ clone()

virtual CbcBranchingObject* CbcNWayBranchingObject::clone ( ) const

virtual

Clone.

Implements CbcBranchingObject.

◆ branch() [1/3]

virtual double CbcNWayBranchingObject::branch ( )

virtual

Does next branch and updates state.

Implements CbcBranchingObject.

◆ print() [1/2]

virtual void CbcNWayBranchingObject::print ( )

virtual

Print something about branch - only if log level high.

◆ numberBranches()

virtual int CbcNWayBranchingObject::numberBranches ( ) const

inlinevirtual

The number of branch arms created for this branching object.

Definition at line 125 of file CbcNWay.hpp.

◆ twoWay()

virtual bool CbcNWayBranchingObject::twoWay ( ) const

inlinevirtual

Is this a two way object (-1 down, +1 up)

Definition at line 130 of file CbcNWay.hpp.

◆ type()

virtual CbcBranchObjType CbcNWayBranchingObject::type ( ) const

inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 136 of file CbcNWay.hpp.

◆ compareOriginalObject()

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

◆ order_

int* CbcNWayBranchingObject::order_

private

order of branching - points back to CbcNWay

Definition at line 162 of file CbcNWay.hpp.

◆ object_

const CbcNWay* CbcNWayBranchingObject::object_

private

Points back to object.

Definition at line 164 of file CbcNWay.hpp.

◆ numberInSet_

int CbcNWayBranchingObject::numberInSet_

private

Number in set.

Definition at line 166 of file CbcNWay.hpp.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CbcNWayBranchingObject() [1/3]

◆ CbcNWayBranchingObject() [2/3]

◆ CbcNWayBranchingObject() [3/3]

◆ ~CbcNWayBranchingObject()

Member Function Documentation

◆ operator=()

◆ clone()

◆ branch() [1/3]

◆ print() [1/2]

◆ numberBranches()

◆ twoWay()

◆ type()

◆ compareOriginalObject()

◆ compareBranchingObject()

◆ branch() [2/3]

◆ branch() [3/3]

◆ print() [2/2]

Member Data Documentation

◆ order_

◆ object_

◆ numberInSet_