Define a single integer class. More...

#include <CbcSimpleInteger.hpp>

Inheritance diagram for CbcSimpleInteger:

Collaboration diagram for CbcSimpleInteger:

Public Member Functions
	CbcSimpleInteger ()

	CbcSimpleInteger (CbcModel *model, int iColumn, double breakEven=0.5)

	CbcSimpleInteger (CbcModel model, const OsiSimpleInteger object)

	CbcSimpleInteger (const CbcSimpleInteger &)

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

CbcSimpleInteger &	operator= (const CbcSimpleInteger &rhs)

virtual	~CbcSimpleInteger ()

OsiSimpleInteger *	osiObject () const
	Construct an OsiSimpleInteger object. More...

virtual double	infeasibility (const OsiBranchingInformation *info, int &preferredWay) const
	Infeasibility - large is 0.5. More...

virtual double	feasibleRegion (OsiSolverInterface solver, const OsiBranchingInformation info) const
	Set bounds to fix the variable at the current (integer) value. More...

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

void	fillCreateBranch (CbcIntegerBranchingObject branching, const OsiBranchingInformation info, int way)
	Fills in a created branching object. More...

virtual OsiSolverBranch *	solverBranch (OsiSolverInterface solver, const OsiBranchingInformation info) const
	Create an OsiSolverBranch object. More...

virtual void	feasibleRegion ()
	Set bounds to fix the variable at the current (integer) value. More...

virtual int	columnNumber () const
	Column number if single column object -1 otherwise, so returns >= 0 Used by heuristics. More...

void	setColumnNumber (int value)
	Set column number. More...

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

virtual void	resetSequenceEtc (int numberColumns, const int *originalColumns)
	Change column numbers after preprocessing. More...

double	originalLowerBound () const
	Original bounds. More...

void	setOriginalLowerBound (double value)

double	originalUpperBound () const

void	setOriginalUpperBound (double value)

double	breakEven () const
	Breakeven e.g 0.7 -> >= 0.7 go up first. More...

void	setBreakEven (double value)
	Set breakeven e.g 0.7 -> >= 0.7 go up first. More...

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 OsiSolverBranch *	solverBranch () const
	Create an OsiSolverBranch object. More...

Public Member Functions inherited from CbcObject
	CbcObject ()

	CbcObject (CbcModel *model)

	CbcObject (const CbcObject &)

CbcObject &	operator= (const CbcObject &rhs)

virtual	~CbcObject ()
	Destructor. More...

virtual double	infeasibility (int &) const

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 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	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
double	originalLower_
	data More...

double	originalUpper_
	Original upper bound. More...

double	breakEven_
	Breakeven i.e. >= this preferred is up. More...

int	columnNumber_
	Column number in model. More...

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

Protected Attributes inherited from CbcObject
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

Define a single integer class.

Definition at line 173 of file CbcSimpleInteger.hpp.

Constructor & Destructor Documentation

◆ CbcSimpleInteger() [1/4]

CbcSimpleInteger::CbcSimpleInteger ( )

◆ CbcSimpleInteger() [2/4]

CbcSimpleInteger::CbcSimpleInteger	(	CbcModel *	model,
		int	iColumn,
		double	breakEven = `0.5`
	)

◆ CbcSimpleInteger() [3/4]

CbcSimpleInteger::CbcSimpleInteger	(	CbcModel *	model,
		const OsiSimpleInteger *	object
	)

◆ CbcSimpleInteger() [4/4]

CbcSimpleInteger::CbcSimpleInteger ( const CbcSimpleInteger & )

◆ ~CbcSimpleInteger()

virtual CbcSimpleInteger::~CbcSimpleInteger ( )

virtual

Member Function Documentation

◆ clone()

virtual CbcObject* CbcSimpleInteger::clone ( ) const

virtual

Clone.

Implements CbcObject.

Reimplemented in CbcSimpleIntegerFixed, CbcSimpleIntegerDynamicPseudoCost, and CbcSimpleIntegerPseudoCost.

◆ operator=()

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

◆ osiObject()

OsiSimpleInteger* CbcSimpleInteger::osiObject ( ) const

Construct an OsiSimpleInteger object.

◆ infeasibility()

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

virtual

Infeasibility - large is 0.5.

Reimplemented from CbcObject.

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSimpleIntegerPseudoCost.

◆ feasibleRegion() [1/5]

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

virtual

Set bounds to fix the variable at the current (integer) value.

Given an integer value, set the lower and upper bounds to fix the variable. Returns amount it had to move variable.

Reimplemented from CbcObject.

◆ createCbcBranch()

virtual CbcBranchingObject* CbcSimpleInteger::createCbcBranch	(	OsiSolverInterface *	solver,
		const OsiBranchingInformation *	info,
		int	way
	)

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

Reimplemented from CbcObject.

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSimpleIntegerPseudoCost.

◆ fillCreateBranch()

void CbcSimpleInteger::fillCreateBranch	(	CbcIntegerBranchingObject *	branching,
		const OsiBranchingInformation *	info,
		int	way
	)

Fills in a created branching object.

◆ solverBranch() [1/2]

virtual OsiSolverBranch* CbcSimpleInteger::solverBranch	(	OsiSolverInterface *	solver,
		const OsiBranchingInformation *	info
	)		const

virtual

Create an OsiSolverBranch object.

This returns NULL if branch not represented by bound changes

◆ feasibleRegion() [2/5]

virtual void CbcSimpleInteger::feasibleRegion ( )

virtual

Set bounds to fix the variable at the current (integer) value.

Given an integer value, set the lower and upper bounds to fix the variable. The algorithm takes a bit of care in order to compensate for minor numerical inaccuracy.

Implements CbcObject.

◆ columnNumber()

virtual int CbcSimpleInteger::columnNumber ( ) const

virtual

Column number if single column object -1 otherwise, so returns >= 0 Used by heuristics.

◆ setColumnNumber()

void CbcSimpleInteger::setColumnNumber ( int value )

inline

Set column number.

Definition at line 240 of file CbcSimpleInteger.hpp.

◆ resetBounds()

virtual void CbcSimpleInteger::resetBounds ( const OsiSolverInterface * solver )

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.

Reimplemented from CbcObject.

◆ resetSequenceEtc()

virtual void CbcSimpleInteger::resetSequenceEtc	(	int	numberColumns,
		const int *	originalColumns
	)

virtual

Change column numbers after preprocessing.

◆ originalLowerBound()

double CbcSimpleInteger::originalLowerBound ( ) const

inline

Original bounds.

Definition at line 255 of file CbcSimpleInteger.hpp.

◆ setOriginalLowerBound()

void CbcSimpleInteger::setOriginalLowerBound ( double value )

inline

Definition at line 259 of file CbcSimpleInteger.hpp.

◆ originalUpperBound()

double CbcSimpleInteger::originalUpperBound ( ) const

inline

Definition at line 263 of file CbcSimpleInteger.hpp.

◆ setOriginalUpperBound()

void CbcSimpleInteger::setOriginalUpperBound ( double value )

inline

Definition at line 267 of file CbcSimpleInteger.hpp.

◆ breakEven()

double CbcSimpleInteger::breakEven ( ) const

inline

Breakeven e.g 0.7 -> >= 0.7 go up first.

Definition at line 272 of file CbcSimpleInteger.hpp.

◆ setBreakEven()

void CbcSimpleInteger::setBreakEven ( double value )

inline

Set breakeven e.g 0.7 -> >= 0.7 go up first.

Definition at line 277 of file CbcSimpleInteger.hpp.

◆ feasibleRegion() [3/5]

virtual void CbcObject::feasibleRegion

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

◆ feasibleRegion() [4/5]

virtual double CbcObject::feasibleRegion

Dummy one for compatibility.

◆ feasibleRegion() [5/5]

virtual double CbcObject::feasibleRegion

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

◆ solverBranch() [2/2]

virtual OsiSolverBranch* CbcObject::solverBranch

Create an OsiSolverBranch object.

This returns NULL if branch not represented by bound changes

Member Data Documentation

◆ originalLower_

double CbcSimpleInteger::originalLower_

protected

data

Original lower bound

Definition at line 286 of file CbcSimpleInteger.hpp.

◆ originalUpper_

double CbcSimpleInteger::originalUpper_

protected

Original upper bound.

Definition at line 288 of file CbcSimpleInteger.hpp.

◆ breakEven_

double CbcSimpleInteger::breakEven_

protected

Breakeven i.e. >= this preferred is up.

Definition at line 290 of file CbcSimpleInteger.hpp.

◆ columnNumber_

int CbcSimpleInteger::columnNumber_

protected

Column number in model.

Definition at line 292 of file CbcSimpleInteger.hpp.

◆ preferredWay_

int CbcSimpleInteger::preferredWay_

protected

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

Definition at line 294 of file CbcSimpleInteger.hpp.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcSimpleInteger() [1/4]

◆ CbcSimpleInteger() [2/4]

◆ CbcSimpleInteger() [3/4]

◆ CbcSimpleInteger() [4/4]

◆ ~CbcSimpleInteger()

Member Function Documentation

◆ clone()

◆ operator=()

◆ osiObject()

◆ infeasibility()

◆ feasibleRegion() [1/5]

◆ createCbcBranch()

◆ fillCreateBranch()

◆ solverBranch() [1/2]

◆ feasibleRegion() [2/5]

◆ columnNumber()

◆ setColumnNumber()

◆ resetBounds()

◆ resetSequenceEtc()

◆ originalLowerBound()

◆ setOriginalLowerBound()

◆ originalUpperBound()

◆ setOriginalUpperBound()

◆ breakEven()

◆ setBreakEven()

◆ feasibleRegion() [3/5]

◆ feasibleRegion() [4/5]

◆ feasibleRegion() [5/5]

◆ solverBranch() [2/2]

Member Data Documentation

◆ originalLower_

◆ originalUpper_

◆ breakEven_

◆ columnNumber_

◆ preferredWay_