Define a single integer class. More...

#include <OsiBranchingObject.hpp>

Inheritance diagram for OsiSimpleInteger:

Collaboration diagram for OsiSimpleInteger:

Public Member Functions
	OsiSimpleInteger ()
	Default Constructor.
	OsiSimpleInteger (const OsiSolverInterface *solver, int iColumn)
	Useful constructor - passed solver index.
	OsiSimpleInteger (int iColumn, double lower, double upper)
	Useful constructor - passed solver index and original bounds.
	OsiSimpleInteger (const OsiSimpleInteger &)
	Copy constructor.
virtual OsiObject *	clone () const
	Clone.
OsiSimpleInteger &	operator= (const OsiSimpleInteger &rhs)
	Assignment operator.
virtual	~OsiSimpleInteger ()
	Destructor.
virtual double	infeasibility (const OsiBranchingInformation *info, int &whichWay) const
	Infeasibility - large is 0.5.
virtual double	feasibleRegion (OsiSolverInterface solver, const OsiBranchingInformation info) const
	Set bounds to fix the variable at the current (integer) value.
virtual OsiBranchingObject *	createBranch (OsiSolverInterface solver, const OsiBranchingInformation info, int way) const
	Creates a branching object.
void	setColumnNumber (int value)
	Set solver column number.
virtual int	columnNumber () const
	Column number if single column object -1 otherwise, so returns >= 0 Used by heuristics.
double	originalLowerBound () const
	Original bounds.
void	setOriginalLowerBound (double value)
double	originalUpperBound () const
void	setOriginalUpperBound (double value)
virtual void	resetBounds (const OsiSolverInterface *solver)
	Reset variable bounds to their original values.
virtual void	resetSequenceEtc (int numberColumns, const int *originalColumns)
	Change column numbers after preprocessing.
virtual double	upEstimate () const
	Return "up" estimate (default 1.0e-5).
virtual double	downEstimate () const
	Return "down" estimate (default 1.0e-5).
virtual bool	canHandleShadowPrices () const
	Return true if knows how to deal with Pseudo Shadow Prices.
Public Member Functions inherited from OsiObject2
	OsiObject2 ()
	Default Constructor.
	OsiObject2 (const OsiObject2 &)
	Copy constructor.
OsiObject2 &	operator= (const OsiObject2 &rhs)
	Assignment operator.
virtual	~OsiObject2 ()
	Destructor.
void	setPreferredWay (int value)
	Set preferred way of branching - -1 off, 0 down, 1 up (for 2-way).
virtual int	preferredWay () const
	Get preferred way of branching - -1 off, 0 down, 1 up (for 2-way).

Protected Attributes
double	originalLower_
	data Original lower bound
double	originalUpper_
	Original upper bound.
int	columnNumber_
	Column number in solver.
Protected Attributes inherited from OsiObject2
int	preferredWay_
	Preferred way of branching - -1 off, 0 down, 1 up (for 2-way).
double	otherInfeasibility_
	"Infeasibility" on other way

Detailed Description

Define a single integer class.

Definition at line 558 of file OsiBranchingObject.hpp.

Constructor & Destructor Documentation

◆ OsiSimpleInteger() [1/4]

OsiSimpleInteger::OsiSimpleInteger ( )

Default Constructor.

◆ OsiSimpleInteger() [2/4]

OsiSimpleInteger::OsiSimpleInteger	(	const OsiSolverInterface *	solver,
		int	iColumn )

Useful constructor - passed solver index.

◆ OsiSimpleInteger() [3/4]

OsiSimpleInteger::OsiSimpleInteger	(	int	iColumn,
		double	lower,
		double	upper )

Useful constructor - passed solver index and original bounds.

◆ OsiSimpleInteger() [4/4]

OsiSimpleInteger::OsiSimpleInteger ( const OsiSimpleInteger & )

Copy constructor.

◆ ~OsiSimpleInteger()

virtual OsiSimpleInteger::~OsiSimpleInteger ( )

virtual

Destructor.

Member Function Documentation

◆ clone()

virtual OsiObject * OsiSimpleInteger::clone ( ) const

virtual

Clone.

◆ operator=()

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

Assignment operator.

◆ infeasibility()

virtual double OsiSimpleInteger::infeasibility	(	const OsiBranchingInformation *	info,
		int &	whichWay ) const

virtual

Infeasibility - large is 0.5.

◆ feasibleRegion()

virtual double OsiSimpleInteger::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.

◆ createBranch()

virtual OsiBranchingObject * OsiSimpleInteger::createBranch	(	OsiSolverInterface *	solver,
		const OsiBranchingInformation *	info,
		int	way ) const

virtual

Creates a branching object.

The preferred direction is set by way, 0 for down, 1 for up.

◆ setColumnNumber()

void OsiSimpleInteger::setColumnNumber ( int value )

inline

Set solver column number.

Definition at line 601 of file OsiBranchingObject.hpp.

◆ columnNumber()

virtual int OsiSimpleInteger::columnNumber ( ) const

virtual

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

◆ originalLowerBound()

double OsiSimpleInteger::originalLowerBound ( ) const

inline

Original bounds.

Definition at line 613 of file OsiBranchingObject.hpp.

◆ setOriginalLowerBound()

void OsiSimpleInteger::setOriginalLowerBound ( double value )

inline

Definition at line 617 of file OsiBranchingObject.hpp.

◆ originalUpperBound()

double OsiSimpleInteger::originalUpperBound ( ) const

inline

Definition at line 621 of file OsiBranchingObject.hpp.

◆ setOriginalUpperBound()

void OsiSimpleInteger::setOriginalUpperBound ( double value )

inline

Definition at line 625 of file OsiBranchingObject.hpp.

◆ resetBounds()

virtual void OsiSimpleInteger::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 reset them to their original values.

◆ resetSequenceEtc()

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

virtual

Change column numbers after preprocessing.

◆ upEstimate()

virtual double OsiSimpleInteger::upEstimate ( ) const

virtual

Return "up" estimate (default 1.0e-5).

◆ downEstimate()

virtual double OsiSimpleInteger::downEstimate ( ) const

virtual

Return "down" estimate (default 1.0e-5).

◆ canHandleShadowPrices()

virtual bool OsiSimpleInteger::canHandleShadowPrices ( ) const

inlinevirtual

Return true if knows how to deal with Pseudo Shadow Prices.

Definition at line 643 of file OsiBranchingObject.hpp.

Member Data Documentation

◆ originalLower_

double OsiSimpleInteger::originalLower_

protected

data Original lower bound

Definition at line 651 of file OsiBranchingObject.hpp.

◆ originalUpper_

double OsiSimpleInteger::originalUpper_

protected

Original upper bound.

Definition at line 653 of file OsiBranchingObject.hpp.

◆ columnNumber_

int OsiSimpleInteger::columnNumber_

protected

Column number in solver.

Definition at line 655 of file OsiBranchingObject.hpp.

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

/builddir/build/BUILD/coin-or-Osi-0.108.12-build/Osi-releases-0.108.12/Osi/src/Osi/OsiBranchingObject.hpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OsiSimpleInteger() [1/4]

◆ OsiSimpleInteger() [2/4]

◆ OsiSimpleInteger() [3/4]

◆ OsiSimpleInteger() [4/4]

◆ ~OsiSimpleInteger()

Member Function Documentation

◆ clone()

◆ operator=()

◆ infeasibility()

◆ feasibleRegion()

◆ createBranch()

◆ setColumnNumber()

◆ columnNumber()

◆ originalLowerBound()

◆ setOriginalLowerBound()

◆ originalUpperBound()

◆ setOriginalUpperBound()

◆ resetBounds()

◆ resetSequenceEtc()

◆ upEstimate()

◆ downEstimate()

◆ canHandleShadowPrices()

Member Data Documentation

◆ originalLower_

◆ originalUpper_

◆ columnNumber_