CbcCliqueBranchingObject Class Reference

Branching object for unordered cliques. More...

#include <CbcClique.hpp>

Inheritance diagram for CbcCliqueBranchingObject:

Collaboration diagram for CbcCliqueBranchingObject:

Public Member Functions
	CbcCliqueBranchingObject ()
	CbcCliqueBranchingObject (CbcModel *model, const CbcClique *clique, int way, int numberOnDownSide, const int *down, int numberOnUpSide, const int *up)
	CbcCliqueBranchingObject (const CbcCliqueBranchingObject &)
CbcCliqueBranchingObject &	operator= (const CbcCliqueBranchingObject &rhs)
virtual CbcBranchingObject *	clone () const
	Clone. More...
virtual	~CbcCliqueBranchingObject ()
virtual double	branch ()
	Does next branch and updates state. 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 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
const CbcClique *	clique_
	data More...
unsigned int	downMask_ [2]
	downMask - bit set to fix to weak bounds, not set to leave unfixed More...
unsigned int	upMask_ [2]
	upMask - bit set to fix to weak bounds, not set to leave unfixed 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 unordered cliques.

Intended for cliques which are long enough to make it worthwhile but <= 64 members. There will also be ones for long cliques.

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

Definition at line 168 of file CbcClique.hpp.

Constructor & Destructor Documentation

CbcCliqueBranchingObject() [1/3]

CbcCliqueBranchingObject::CbcCliqueBranchingObject

(

)

CbcCliqueBranchingObject() [2/3]

CbcCliqueBranchingObject::CbcCliqueBranchingObject	(	CbcModel *	model,
		const CbcClique *	clique,
		int	way,
		int	numberOnDownSide,
		const int *	down,
		int	numberOnUpSide,
		const int *	up
	)

CbcCliqueBranchingObject() [3/3]

CbcCliqueBranchingObject::CbcCliqueBranchingObject

(

const CbcCliqueBranchingObject &

)

~CbcCliqueBranchingObject()

virtual CbcCliqueBranchingObject::~CbcCliqueBranchingObject ( )

virtual

Member Function Documentation

operator=()

CbcCliqueBranchingObject& CbcCliqueBranchingObject::operator=

(

const CbcCliqueBranchingObject &

rhs

)

clone()

virtual CbcBranchingObject* CbcCliqueBranchingObject::clone ( ) const

virtual

Clone.

Implements CbcBranchingObject.

branch() [1/3]

virtual double CbcCliqueBranchingObject::branch ( )

virtual

Does next branch and updates state.

Implements CbcBranchingObject.

print() [1/2]

virtual void CbcCliqueBranchingObject::print ( )

virtual

Print something about branch - only if log level high.

type()

virtual CbcBranchObjType CbcCliqueBranchingObject::type ( ) const

inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 202 of file CbcClique.hpp.

compareOriginalObject()

virtual int CbcCliqueBranchingObject::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 CbcCliqueBranchingObject::compareBranchingObject ( const CbcBranchingObject *  brObj, const bool  replaceIfOverlap = false  )

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.

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

clique_

const CbcClique* CbcCliqueBranchingObject::clique_

private

data

Definition at line 228 of file CbcClique.hpp.

downMask_

unsigned int CbcCliqueBranchingObject::downMask_[2]

private

downMask - bit set to fix to weak bounds, not set to leave unfixed

Definition at line 230 of file CbcClique.hpp.

upMask_

unsigned int CbcCliqueBranchingObject::upMask_[2]

private

upMask - bit set to fix to weak bounds, not set to leave unfixed

Definition at line 232 of file CbcClique.hpp.

---

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

• /home/ted/Projects/Cbc/Cbc/src/CbcClique.hpp