Branching object for Special ordered sets. More...

#include <CbcSOS.hpp>

Inheritance diagram for CbcSOSBranchingObject:

Collaboration diagram for CbcSOSBranchingObject:

Public Member Functions
	CbcSOSBranchingObject ()

	CbcSOSBranchingObject (CbcModel model, const CbcSOS clique, int way, double separator)

	CbcSOSBranchingObject (const CbcSOSBranchingObject &)

CbcSOSBranchingObject &	operator= (const CbcSOSBranchingObject &rhs)

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

virtual	~CbcSOSBranchingObject ()

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

void	computeNonzeroRange ()
	Fill out the `firstNonzero_` and `lastNonzero_` data members. 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...

Protected Attributes
const CbcSOS *	set_
	data More...

double	separator_
	separator More...

int	firstNonzero_
	The following two members describe the range in the members_ of the original object that whose upper bound is not fixed to 0. More...

int	lastNonzero_

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 Special ordered sets.

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

Definition at line 200 of file CbcSOS.hpp.

Constructor & Destructor Documentation

◆ CbcSOSBranchingObject() [1/3]

CbcSOSBranchingObject::CbcSOSBranchingObject ( )

◆ CbcSOSBranchingObject() [2/3]

CbcSOSBranchingObject::CbcSOSBranchingObject	(	CbcModel *	model,
		const CbcSOS *	clique,
		int	way,
		double	separator
	)

◆ CbcSOSBranchingObject() [3/3]

CbcSOSBranchingObject::CbcSOSBranchingObject ( const CbcSOSBranchingObject & )

◆ ~CbcSOSBranchingObject()

virtual CbcSOSBranchingObject::~CbcSOSBranchingObject ( )

virtual

Member Function Documentation

◆ operator=()

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

◆ clone()

virtual CbcBranchingObject* CbcSOSBranchingObject::clone ( ) const

virtual

Clone.

Implements CbcBranchingObject.

◆ branch() [1/3]

virtual double CbcSOSBranchingObject::branch ( )

virtual

Does next branch and updates state.

Implements CbcBranchingObject.

◆ fix()

virtual void CbcSOSBranchingObject::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 CbcSOSBranchingObject::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 235 of file CbcSOS.hpp.

◆ print() [1/2]

virtual void CbcSOSBranchingObject::print ( )

virtual

Print something about branch - only if log level high.

◆ type()

virtual CbcBranchObjType CbcSOSBranchingObject::type ( ) const

inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 247 of file CbcSOS.hpp.

◆ compareOriginalObject()

virtual int CbcSOSBranchingObject::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 CbcSOSBranchingObject::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.

◆ computeNonzeroRange()

void CbcSOSBranchingObject::computeNonzeroRange ( )

Fill out the firstNonzero_ and lastNonzero_ data members.

◆ 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

◆ set_

const CbcSOS* CbcSOSBranchingObject::set_

protected

data

Definition at line 276 of file CbcSOS.hpp.

◆ separator_

double CbcSOSBranchingObject::separator_

protected

separator

Definition at line 278 of file CbcSOS.hpp.

◆ firstNonzero_

int CbcSOSBranchingObject::firstNonzero_

protected

The following two members describe the range in the members_ of the original object that whose upper bound is not fixed to 0.

This is not necessary for Cbc to function correctly, this is there for heuristics so that separate branching decisions on the same object can be pooled into one branching object.

Definition at line 284 of file CbcSOS.hpp.

◆ lastNonzero_

int CbcSOSBranchingObject::lastNonzero_

protected

Definition at line 285 of file CbcSOS.hpp.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcSOSBranchingObject() [1/3]

◆ CbcSOSBranchingObject() [2/3]

◆ CbcSOSBranchingObject() [3/3]

◆ ~CbcSOSBranchingObject()

Member Function Documentation

◆ operator=()

◆ clone()

◆ branch() [1/3]

◆ fix()

◆ previousBranch()

◆ print() [1/2]

◆ type()

◆ compareOriginalObject()

◆ compareBranchingObject()

◆ computeNonzeroRange()

◆ branch() [2/3]

◆ branch() [3/3]

◆ print() [2/2]

Member Data Documentation

◆ set_

◆ separator_

◆ firstNonzero_

◆ lastNonzero_