#include <string>
#include <vector>
#include "OsiBranchingObject.hpp"

Include dependency graph for CbcObject.hpp:

This graph shows which files directly or indirectly include this file:

Functions
virtual double	infeasibility (const OsiBranchingInformation *, int &preferredWay) const
	Abstract base class for `objects'.
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.
virtual double	feasibleRegion (OsiSolverInterface solver, const OsiBranchingInformation info) const
	Dummy one for compatibility.
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.
virtual CbcBranchingObject *	createCbcBranch (OsiSolverInterface , const OsiBranchingInformation , int)
	Create a branching object and indicate which way to branch first.
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.
virtual OsiSolverBranch *	solverBranch () const
	Create an OsiSolverBranch object.
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.
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.
virtual void	resetBounds (const OsiSolverInterface *)
	Reset variable bounds to their original values.
virtual void	floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
	Returns floor and ceiling i.e.
virtual CbcObjectUpdateData	createUpdateInformation (const OsiSolverInterface solver, const CbcNode node, const CbcBranchingObject *branchingObject)
	Pass in information on branch just done and create CbcObjectUpdateData instance.
virtual void	updateInformation (const CbcObjectUpdateData &)
	Update object by CbcObjectUpdateData.
int	id () const
	Identifier (normally column number in matrix).
void	setId (int value)
	Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.
bool	optionalObject () const
	Return true if optional branching object i.e.
int	position () const
	Get position in object_ list.
void	setPosition (int position)
	Set position in object_ list.
void	setModel (CbcModel *model)
	update model
CbcModel *	model () const
	Return model.
int	preferredWay () const
	If -1 down always chosen first, +1 up always, 0 normal.
void	setPreferredWay (int value)
	Set -1 down always chosen first, +1 up always, 0 normal.
virtual void	redoSequenceEtc (CbcModel , int, const int )
	Redoes data when sequence numbers change.
virtual void	initializeForBranching (CbcModel *)
	Initialize for branching.

Variables
CbcModel *	model_
	data
int	id_
	Identifier (normally column number in matrix).
int	position_
	Position in object list.
int	preferredWay_
	If -1 down always chosen first, +1 up always, 0 normal.

Function Documentation

◆ infeasibility() [1/2]

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

virtual

Abstract base class for `objects'.

It now just has stuff that OsiObject does not have

The branching model used in Cbc is based on the idea of an object. In the abstract, an object is something that has a feasible region, can be evaluated for infeasibility, can be branched on (i.e., there's some constructive action to be taken to move toward feasibility), and allows comparison of the effect of branching.

This class (CbcObject) is the base class for an object. To round out the branching model, the class CbcBranchingObject describes how to perform a branch, and the class CbcBranchDecision describes how to compare two CbcBranchingObjects.

To create a new type of object you need to provide three methods: infeasibility(), feasibleRegion(), and createCbcBranch(), described below.

This base class is primarily virtual to allow for any form of structure. Any form of discontinuity is allowed.

Todo: The notion that all branches are binary (two arms) is wired into the implementation of CbcObject, CbcBranchingObject, and CbcBranchDecision. Changing this will require a moderate amount of recoding. */ This can be used if object wants to skip strong branching typedef struct { CbcBranchingObject *possibleBranch; // what a branch would do double upMovement; // cost going up (and initial away from feasible) double downMovement; // cost going down int numIntInfeasUp; // without odd ones int numObjInfeasUp; // just odd ones bool finishedUp; // true if solver finished int numItersUp; // number of iterations in solver int numIntInfeasDown; // without odd ones int numObjInfeasDown; // just odd ones bool finishedDown; // true if solver finished int numItersDown; // number of iterations in solver int objectNumber; // Which object it is int fix; // 0 if no fix, 1 if we can fix up, -1 if we can fix down } CbcStrongInfo;

class CbcObject : public OsiObject {

public: Default Constructor CbcObject();

Useful constructor CbcObject(CbcModel *model);

Copy constructor CbcObject(const CbcObject &);

Assignment operator CbcObject &operator=(const CbcObject &rhs);

/ Clone virtual CbcObject *clone() const = 0;

/ Destructor virtual ~CbcObject();

/** 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

Definition at line 106 of file CbcObject.hpp.

◆ infeasibility() [2/2]

virtual double infeasibility ( int & ) const

virtual

Definition at line 111 of file CbcObject.hpp.

◆ feasibleRegion() [1/3]

virtual void feasibleRegion ( )

pure virtual

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

◆ feasibleRegion() [2/3]

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

virtual

Dummy one for compatibility.

◆ feasibleRegion() [3/3]

virtual double 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 * createCbcBranch	(	OsiSolverInterface *	,
		const OsiBranchingInformation *	,
		int	)

virtual

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

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

Definition at line 138 of file CbcObject.hpp.

◆ createBranch()

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

virtual

Definition at line 147 of file CbcObject.hpp.

◆ createOsiBranch()

virtual OsiBranchingObject * 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 * solverBranch ( ) const

virtual

Create an OsiSolverBranch object.

This returns NULL if branch not represented by bound changes

◆ preferredNewFeasible()

virtual CbcBranchingObject * preferredNewFeasible ( ) const

virtual

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.

Definition at line 173 of file CbcObject.hpp.

◆ notPreferredNewFeasible()

virtual CbcBranchingObject * notPreferredNewFeasible ( ) const

virtual

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.

Definition at line 186 of file CbcObject.hpp.

◆ resetBounds()

virtual void resetBounds ( const OsiSolverInterface * )

virtual

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.

Definition at line 195 of file CbcObject.hpp.

◆ floorCeiling()

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

virtual

Returns floor and ceiling i.e.

closest valid points

◆ createUpdateInformation()

virtual CbcObjectUpdateData 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

◆ updateInformation()

virtual void updateInformation ( const CbcObjectUpdateData & )

virtual

Update object by CbcObjectUpdateData.

Definition at line 210 of file CbcObject.hpp.

◆ id()

int id ( ) const

inline

Identifier (normally column number in matrix).

Definition at line 213 of file CbcObject.hpp.

◆ setId()

void 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 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 position ( ) const

inline

Get position in object_ list.

Definition at line 234 of file CbcObject.hpp.

◆ setPosition()

void setPosition ( int position )

inline

Set position in object_ list.

Definition at line 240 of file CbcObject.hpp.

◆ setModel()

void setModel ( CbcModel * model )

inline

update model

Definition at line 246 of file CbcObject.hpp.

◆ model()

CbcModel * model ( ) const

inline

Return model.

Definition at line 252 of file CbcObject.hpp.

◆ preferredWay()

int preferredWay ( ) const

inline

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

Definition at line 258 of file CbcObject.hpp.

◆ setPreferredWay()

void 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 redoSequenceEtc	(	CbcModel *	,
		int	,
		const int *	)

virtual

Redoes data when sequence numbers change.

Definition at line 268 of file CbcObject.hpp.

◆ initializeForBranching()

virtual void initializeForBranching ( CbcModel * )

virtual

Initialize for branching.

Definition at line 270 of file CbcObject.hpp.

Variable Documentation

◆ model_

CbcModel* model_

protected

data

Model

Definition at line 276 of file CbcObject.hpp.

◆ id_

int id_

protected

Identifier (normally column number in matrix).

Definition at line 278 of file CbcObject.hpp.

◆ position_

int position_

protected

Position in object list.

Definition at line 280 of file CbcObject.hpp.

◆ preferredWay_

int preferredWay_

protected

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

Definition at line 282 of file CbcObject.hpp.

Functions

Variables

Function Documentation

◆ 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()

Variable Documentation

◆ model_

◆ id_

◆ position_

◆ preferredWay_