Lotsize class. More...

#include <CbcBranchLotsize.hpp>

Inheritance diagram for CbcLotsize:

Collaboration diagram for CbcLotsize:

Public Member Functions
	CbcLotsize ()

	CbcLotsize (CbcModel model, int iColumn, int numberPoints, const double points, bool range=false)

	CbcLotsize (const CbcLotsize &)

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

CbcLotsize &	operator= (const CbcLotsize &rhs)

	~CbcLotsize ()

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

virtual void	feasibleRegion ()
	Set bounds to contain the current solution. More...

virtual CbcBranchingObject *	createCbcBranch (OsiSolverInterface solver, const OsiBranchingInformation info, int way)
	Creates a branching 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 the 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 *solver)
	Reset original upper and lower bound values from the solver. More...

bool	findRange (double value) const
	Finds range of interest so value is feasible in range range_ or infeasible between hi[range_] and lo[range_+1]. More...

virtual void	floorCeiling (double &floorLotsize, double &ceilingLotsize, double value, double tolerance) const
	Returns floor and ceiling. More...

int	modelSequence () const
	Model column number. More...

void	setModelSequence (int value)
	Set model column number. More...

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

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

double	originalUpperBound () const

int	rangeType () const
	Type - 1 points, 2 ranges. More...

int	numberRanges () const
	Number of points. More...

double *	bound () const
	Ranges. More...

virtual bool	canDoHeuristics () const
	Return true if object can take part in normal heuristics. 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...

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 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 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 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
int	columnNumber_
	data More...

int	rangeType_
	Type - 1 points, 2 ranges. More...

int	numberRanges_
	Number of points. More...

double	largestGap_

double *	bound_
	Ranges. More...

int	range_
	Current range. 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...

Private Member Functions
void	printLotsize (double value, bool condition, int type) const
	Just for debug (CBC_PRINT defined in CbcBranchLotsize.cpp) More...

Detailed Description

Lotsize class.

Definition at line 12 of file CbcBranchLotsize.hpp.

Constructor & Destructor Documentation

◆ CbcLotsize() [1/3]

CbcLotsize::CbcLotsize ( )

◆ CbcLotsize() [2/3]

CbcLotsize::CbcLotsize	(	CbcModel *	model,
		int	iColumn,
		int	numberPoints,
		const double *	points,
		bool	range = `false`
	)

◆ CbcLotsize() [3/3]

CbcLotsize::CbcLotsize ( const CbcLotsize & )

◆ ~CbcLotsize()

CbcLotsize::~CbcLotsize ( )

Member Function Documentation

◆ clone()

virtual CbcObject* CbcLotsize::clone ( ) const

virtual

Clone.

Implements CbcObject.

◆ operator=()

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

◆ infeasibility()

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

virtual

Infeasibility - large is 0.5.

Reimplemented from CbcObject.

◆ feasibleRegion() [1/4]

virtual void CbcLotsize::feasibleRegion ( )

virtual

Set bounds to contain the current solution.

More precisely, for the variable associated with this object, take the value given in the current solution, force it within the current bounds if required, then set the bounds to fix the variable at the integer nearest the solution value.

Implements CbcObject.

◆ createCbcBranch()

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

virtual

Creates a branching object.

Reimplemented from CbcObject.

◆ preferredNewFeasible()

virtual CbcBranchingObject* CbcLotsize::preferredNewFeasible ( ) const

virtual

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

The preferred branching object will force the variable to be +/-1 from its current value, depending on the reduced cost and objective sense. If movement in the direction which improves the objective is impossible due to bounds on the variable, the branching object will move in the other direction. If no movement is possible, the method returns NULL.

Only the bounds on this variable are considered when determining if the new point is feasible.

Reimplemented from CbcObject.

◆ notPreferredNewFeasible()

virtual CbcBranchingObject* CbcLotsize::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.

As for preferredNewFeasible(), but the preferred branching object will force movement in a direction that degrades the objective.

Reimplemented from CbcObject.

◆ resetBounds()

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

virtual

Reset original upper and lower bound values from the solver.

Handy for updating bounds held in this object after bounds held in the solver have been tightened.

Reimplemented from CbcObject.

◆ findRange()

bool CbcLotsize::findRange ( double value ) const

Finds range of interest so value is feasible in range range_ or infeasible between hi[range_] and lo[range_+1].

Returns true if feasible.

◆ floorCeiling()

virtual void CbcLotsize::floorCeiling	(	double &	floorLotsize,
		double &	ceilingLotsize,
		double	value,
		double	tolerance
	)		const

virtual

Returns floor and ceiling.

Reimplemented from CbcObject.

◆ modelSequence()

int CbcLotsize::modelSequence ( ) const

inline

Model column number.

Definition at line 95 of file CbcBranchLotsize.hpp.

◆ setModelSequence()

void CbcLotsize::setModelSequence ( int value )

inline

Set model column number.

Definition at line 100 of file CbcBranchLotsize.hpp.

◆ columnNumber()

virtual int CbcLotsize::columnNumber ( ) const

virtual

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

◆ originalLowerBound()

double CbcLotsize::originalLowerBound ( ) const

inline

Original variable bounds.

Definition at line 111 of file CbcBranchLotsize.hpp.

◆ originalUpperBound()

double CbcLotsize::originalUpperBound ( ) const

inline

Definition at line 115 of file CbcBranchLotsize.hpp.

◆ rangeType()

int CbcLotsize::rangeType ( ) const

inline

Type - 1 points, 2 ranges.

Definition at line 120 of file CbcBranchLotsize.hpp.

◆ numberRanges()

int CbcLotsize::numberRanges ( ) const

inline

Number of points.

Definition at line 125 of file CbcBranchLotsize.hpp.

◆ bound()

double* CbcLotsize::bound ( ) const

inline

Ranges.

Definition at line 130 of file CbcBranchLotsize.hpp.

◆ canDoHeuristics()

virtual bool CbcLotsize::canDoHeuristics ( ) const

inlinevirtual

Return true if object can take part in normal heuristics.

Definition at line 136 of file CbcBranchLotsize.hpp.

◆ printLotsize()

void CbcLotsize::printLotsize	(	double	value,
		bool	condition,
		int	type
	)		const

private

Just for debug (CBC_PRINT defined in CbcBranchLotsize.cpp)

◆ feasibleRegion() [2/4]

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() [3/4]

virtual double CbcObject::feasibleRegion

Dummy one for compatibility.

◆ feasibleRegion() [4/4]

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

Member Data Documentation

◆ columnNumber_

int CbcLotsize::columnNumber_

protected

data

Column number in model

Definition at line 149 of file CbcBranchLotsize.hpp.

◆ rangeType_

int CbcLotsize::rangeType_

protected

Type - 1 points, 2 ranges.

Definition at line 151 of file CbcBranchLotsize.hpp.

◆ numberRanges_

int CbcLotsize::numberRanges_

protected

Number of points.

Definition at line 153 of file CbcBranchLotsize.hpp.

◆ largestGap_

double CbcLotsize::largestGap_

protected

Definition at line 155 of file CbcBranchLotsize.hpp.

◆ bound_

double* CbcLotsize::bound_

protected

Ranges.

Definition at line 157 of file CbcBranchLotsize.hpp.

◆ range_

int CbcLotsize::range_

mutableprotected

Current range.

Definition at line 159 of file CbcBranchLotsize.hpp.

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

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CbcLotsize() [1/3]

◆ CbcLotsize() [2/3]

◆ CbcLotsize() [3/3]

◆ ~CbcLotsize()

Member Function Documentation

◆ clone()

◆ operator=()

◆ infeasibility()

◆ feasibleRegion() [1/4]

◆ createCbcBranch()

◆ preferredNewFeasible()

◆ notPreferredNewFeasible()

◆ resetBounds()

◆ findRange()

◆ floorCeiling()

◆ modelSequence()

◆ setModelSequence()

◆ columnNumber()

◆ originalLowerBound()

◆ originalUpperBound()

◆ rangeType()

◆ numberRanges()

◆ bound()

◆ canDoHeuristics()

◆ printLotsize()

◆ feasibleRegion() [2/4]

◆ feasibleRegion() [3/4]

◆ feasibleRegion() [4/4]

Member Data Documentation

◆ columnNumber_

◆ rangeType_

◆ numberRanges_

◆ largestGap_

◆ bound_

◆ range_