#include <CbcObject.hpp>

Inheritance diagram for CbcObject:

Collaboration diagram for CbcObject:

Public Member Functions
	CbcObject ()

	CbcObject (CbcModel *model)

	CbcObject (const CbcObject &)

CbcObject &	operator= (const CbcObject &rhs)

virtual CbcObject *	clone () const =0
	Clone. More...

virtual	~CbcObject ()
	Destructor. More...

virtual double	infeasibility (const OsiBranchingInformation *, int &preferredWay) const
	Infeasibility of the object. More...

virtual double	infeasibility (int &) const

virtual void	feasibleRegion ()=0
	For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution. More...

virtual double	feasibleRegion (OsiSolverInterface solver, const OsiBranchingInformation info) const
	Dummy one for compatibility. More...

virtual double	feasibleRegion (OsiSolverInterface *solver) const
	For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution. More...

virtual CbcBranchingObject *	createCbcBranch (OsiSolverInterface , const OsiBranchingInformation , int)
	Create a branching object and indicate which way to branch first. More...

virtual OsiBranchingObject *	createBranch (OsiSolverInterface , const OsiBranchingInformation , int) const

virtual OsiBranchingObject *	createOsiBranch (OsiSolverInterface solver, const OsiBranchingInformation info, int way) const
	Create an Osibranching object and indicate which way to branch first. More...

virtual OsiSolverBranch *	solverBranch () const
	Create an OsiSolverBranch object. More...

virtual CbcBranchingObject *	preferredNewFeasible () const
	Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a good direction. More...

virtual CbcBranchingObject *	notPreferredNewFeasible () const
	Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a bad direction. More...

virtual void	resetBounds (const OsiSolverInterface *)
	Reset variable bounds to their original values. More...

virtual void	floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
	Returns floor and ceiling i.e. More...

virtual CbcObjectUpdateData	createUpdateInformation (const OsiSolverInterface solver, const CbcNode node, const CbcBranchingObject *branchingObject)
	Pass in information on branch just done and create CbcObjectUpdateData instance. More...

virtual void	updateInformation (const CbcObjectUpdateData &)
	Update object by CbcObjectUpdateData. More...

int	id () const
	Identifier (normally column number in matrix) More...

void	setId (int value)
	Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e. More...

bool	optionalObject () const
	Return true if optional branching object i.e. More...

int	position () const
	Get position in object_ list. More...

void	setPosition (int position)
	Set position in object_ list. More...

void	setModel (CbcModel *model)
	update model More...

CbcModel *	model () const
	Return model. More...

int	preferredWay () const
	If -1 down always chosen first, +1 up always, 0 normal. More...

void	setPreferredWay (int value)
	Set -1 down always chosen first, +1 up always, 0 normal. More...

virtual void	redoSequenceEtc (CbcModel , int, const int )
	Redoes data when sequence numbers change. More...

virtual void	initializeForBranching (CbcModel *)
	Initialize for branching. More...

Protected Attributes
CbcModel *	model_
	data More...

int	id_
	Identifier (normally column number in matrix) More...

int	position_
	Position in object list. More...

int	preferredWay_
	If -1 down always chosen first, +1 up always, 0 normal. More...

Detailed Description

Definition at line 67 of file CbcObject.hpp.

Constructor & Destructor Documentation

◆ CbcObject() [1/3]

CbcObject::CbcObject ( )

◆ CbcObject() [2/3]

CbcObject::CbcObject ( CbcModel * model )

◆ CbcObject() [3/3]

CbcObject::CbcObject ( const CbcObject & )

◆ ~CbcObject()

virtual CbcObject::~CbcObject ( )

virtual

Destructor.

Member Function Documentation

◆ operator=()

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

◆ clone()

virtual CbcObject* CbcObject::clone ( ) const

pure virtual

Clone.

Implemented in CbcGeneral, CbcSimpleInteger, CbcIdiotBranch, CbcSimpleIntegerFixed, CbcClique, CbcSimpleIntegerDynamicPseudoCost, CbcSOS, CbcLink, CbcBranchToFixLots, CbcFollowOn2, CbcFollowOn, CbcBranchAllDifferent, CbcSimpleIntegerPseudoCost, CbcBranchCut, CbcNWay, and CbcLotsize.

◆ infeasibility() [1/2]

virtual double CbcObject::infeasibility	(	const OsiBranchingInformation *	,
		int &	preferredWay
	)		const

inlinevirtual

Infeasibility of the object.

This is some measure of the infeasibility of the object. It should be scaled to be in the range [0.0, 0.5], with 0.0 indicating the object is satisfied.

The preferred branching direction is returned in preferredWay,

This is used to prepare for strong branching but should also think of case when no strong branching

The object may also compute an estimate of cost of going "up" or "down". This will probably be based on pseudo-cost ideas

Reimplemented in CbcSimpleInteger, CbcIdiotBranch, CbcClique, CbcSimpleIntegerDynamicPseudoCost, CbcSOS, CbcBranchToFixLots, CbcFollowOn, CbcNWay, CbcBranchAllDifferent, CbcSimpleIntegerPseudoCost, CbcGeneral, CbcBranchCut, and CbcLotsize.

Definition at line 106 of file CbcObject.hpp.

◆ infeasibility() [2/2]

virtual double CbcObject::infeasibility ( int & ) const

inlinevirtual

Reimplemented in CbcSimpleIntegerFixed, CbcLink, and CbcFollowOn2.

Definition at line 111 of file CbcObject.hpp.

◆ feasibleRegion() [1/3]

virtual void CbcObject::feasibleRegion ( )

pure virtual

For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution.

Implemented in CbcGeneral, CbcSimpleInteger, CbcIdiotBranch, CbcClique, CbcSOS, CbcLink, CbcFollowOn, CbcBranchCut, CbcFollowOn2, CbcNWay, and CbcLotsize.

◆ feasibleRegion() [2/3]

virtual double CbcObject::feasibleRegion	(	OsiSolverInterface *	solver,
		const OsiBranchingInformation *	info
	)		const

virtual

Dummy one for compatibility.

Reimplemented in CbcSimpleInteger.

◆ feasibleRegion() [3/3]

virtual double CbcObject::feasibleRegion ( OsiSolverInterface * solver ) const

virtual

For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution.

Returns measure of how much it had to move solution to make feasible

◆ createCbcBranch()

virtual CbcBranchingObject* CbcObject::createCbcBranch	(	OsiSolverInterface *	,
		const OsiBranchingInformation *	,
		int
	)

inlinevirtual

Create a branching object and indicate which way to branch first.

The branching object has to know how to create branches (fix variables, etc.)

Reimplemented in CbcSimpleInteger, CbcIdiotBranch, CbcClique, CbcSOS, CbcBranchToFixLots, CbcSimpleIntegerDynamicPseudoCost, CbcBranchCut, CbcLink, CbcFollowOn, CbcNWay, CbcLotsize, CbcBranchAllDifferent, CbcGeneral, and CbcSimpleIntegerPseudoCost.

Definition at line 138 of file CbcObject.hpp.

◆ createBranch()

virtual OsiBranchingObject* CbcObject::createBranch	(	OsiSolverInterface *	,
		const OsiBranchingInformation *	,
		int
	)		const

inlinevirtual

Definition at line 147 of file CbcObject.hpp.

◆ createOsiBranch()

virtual OsiBranchingObject* CbcObject::createOsiBranch	(	OsiSolverInterface *	solver,
		const OsiBranchingInformation *	info,
		int	way
	)		const

virtual

Create an Osibranching object and indicate which way to branch first.

The branching object has to know how to create branches (fix variables, etc.)

◆ solverBranch()

virtual OsiSolverBranch* CbcObject::solverBranch ( ) const

virtual

Create an OsiSolverBranch object.

This returns NULL if branch not represented by bound changes

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSOS.

◆ preferredNewFeasible()

virtual CbcBranchingObject* CbcObject::preferredNewFeasible ( ) const

inlinevirtual

Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a good direction.

If the method cannot generate a feasible point (because there aren't any, or because it isn't bright enough to find one), it should return null.

Reimplemented in CbcBranchCut, and CbcLotsize.

Definition at line 173 of file CbcObject.hpp.

◆ notPreferredNewFeasible()

virtual CbcBranchingObject* CbcObject::notPreferredNewFeasible ( ) const

inlinevirtual

Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a bad direction.

If the method cannot generate a feasible point (because there aren't any, or because it isn't bright enough to find one), it should return null.

Reimplemented in CbcBranchCut, and CbcLotsize.

Definition at line 186 of file CbcObject.hpp.

◆ resetBounds()

virtual void CbcObject::resetBounds ( const OsiSolverInterface * )

inlinevirtual

Reset variable bounds to their original values.

Bounds may be tightened, so it may be good to be able to set this info in object.

Reimplemented in CbcSimpleInteger, and CbcLotsize.

Definition at line 195 of file CbcObject.hpp.

◆ floorCeiling()

virtual void CbcObject::floorCeiling	(	double &	floorValue,
		double &	ceilingValue,
		double	value,
		double	tolerance
	)		const

virtual

Returns floor and ceiling i.e.

closest valid points

Reimplemented in CbcLotsize.

◆ createUpdateInformation()

virtual CbcObjectUpdateData CbcObject::createUpdateInformation	(	const OsiSolverInterface *	solver,
		const CbcNode *	node,
		const CbcBranchingObject *	branchingObject
	)

virtual

Pass in information on branch just done and create CbcObjectUpdateData instance.

If object does not need data then backward pointer will be NULL. Assumes can get information from solver

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSOS.

◆ updateInformation()

virtual void CbcObject::updateInformation ( const CbcObjectUpdateData & )

inlinevirtual

Update object by CbcObjectUpdateData.

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSOS.

Definition at line 210 of file CbcObject.hpp.

◆ id()

int CbcObject::id ( ) const

inline

Identifier (normally column number in matrix)

Definition at line 213 of file CbcObject.hpp.

◆ setId()

void CbcObject::setId ( int value )

inline

Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.

code would work without it

Definition at line 221 of file CbcObject.hpp.

◆ optionalObject()

bool CbcObject::optionalObject ( ) const

inline

Return true if optional branching object i.e.

code would work without it

Definition at line 228 of file CbcObject.hpp.

◆ position()

int CbcObject::position ( ) const

inline

Get position in object_ list.

Definition at line 234 of file CbcObject.hpp.

◆ setPosition()

void CbcObject::setPosition ( int position )

inline

Set position in object_ list.

Definition at line 240 of file CbcObject.hpp.

◆ setModel()

void CbcObject::setModel ( CbcModel * model )

inline

update model

Definition at line 246 of file CbcObject.hpp.

◆ model()

CbcModel* CbcObject::model ( ) const

inline

Return model.

Definition at line 252 of file CbcObject.hpp.

◆ preferredWay()

int CbcObject::preferredWay ( ) const

inline

If -1 down always chosen first, +1 up always, 0 normal.

Definition at line 258 of file CbcObject.hpp.

◆ setPreferredWay()

void CbcObject::setPreferredWay ( int value )

inline

Set -1 down always chosen first, +1 up always, 0 normal.

Definition at line 263 of file CbcObject.hpp.

◆ redoSequenceEtc()

virtual void CbcObject::redoSequenceEtc	(	CbcModel *	,
		int	,
		const int *
	)

inlinevirtual

Redoes data when sequence numbers change.

Reimplemented in CbcGeneral, CbcClique, CbcSOS, CbcBranchToFixLots, and CbcNWay.

Definition at line 268 of file CbcObject.hpp.

◆ initializeForBranching()

virtual void CbcObject::initializeForBranching ( CbcModel * )

inlinevirtual

Initialize for branching.

Reimplemented in CbcIdiotBranch.

Definition at line 270 of file CbcObject.hpp.

Member Data Documentation

◆ model_

CbcModel* CbcObject::model_

protected

data

Model

Definition at line 276 of file CbcObject.hpp.

◆ id_

int CbcObject::id_

protected

Identifier (normally column number in matrix)

Definition at line 278 of file CbcObject.hpp.

◆ position_

int CbcObject::position_

protected

Position in object list.

Definition at line 280 of file CbcObject.hpp.

◆ preferredWay_

int CbcObject::preferredWay_

protected

If -1 down always chosen first, +1 up always, 0 normal.

Definition at line 282 of file CbcObject.hpp.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcObject() [1/3]

◆ CbcObject() [2/3]

◆ CbcObject() [3/3]

◆ ~CbcObject()

Member Function Documentation

◆ operator=()

◆ clone()

◆ infeasibility() [1/2]

◆ infeasibility() [2/2]

◆ feasibleRegion() [1/3]

◆ feasibleRegion() [2/3]

◆ feasibleRegion() [3/3]

◆ createCbcBranch()

◆ createBranch()

◆ createOsiBranch()

◆ solverBranch()

◆ preferredNewFeasible()

◆ notPreferredNewFeasible()

◆ resetBounds()

◆ floorCeiling()

◆ createUpdateInformation()

◆ updateInformation()

◆ id()

◆ setId()

◆ optionalObject()

◆ position()

◆ setPosition()

◆ setModel()

◆ model()

◆ preferredWay()

◆ setPreferredWay()

◆ redoSequenceEtc()

◆ initializeForBranching()

Member Data Documentation

◆ model_

◆ id_

◆ position_

◆ preferredWay_