CbcDynamicPseudoCostBranchingObject Class Reference

Simple branching object for an integer variable with pseudo costs. More...

#include <CbcBranchDynamic.hpp>

Inheritance diagram for CbcDynamicPseudoCostBranchingObject:

Collaboration diagram for CbcDynamicPseudoCostBranchingObject:

Public Member Functions
	CbcDynamicPseudoCostBranchingObject ()
	Default constructor. More...
	CbcDynamicPseudoCostBranchingObject (CbcModel *model, int variable, int way, double value, CbcSimpleIntegerDynamicPseudoCost *object)
	Create a standard floor/ceiling branch object. More...
	CbcDynamicPseudoCostBranchingObject (CbcModel *model, int variable, int way, double lowerValue, double upperValue)
	Create a degenerate branch object. More...
	CbcDynamicPseudoCostBranchingObject (const CbcDynamicPseudoCostBranchingObject &)
	Copy constructor. More...
CbcDynamicPseudoCostBranchingObject &	operator= (const CbcDynamicPseudoCostBranchingObject &rhs)
	Assignment operator. More...
virtual CbcBranchingObject *	clone () const
	Clone. More...
virtual	~CbcDynamicPseudoCostBranchingObject ()
	Destructor. More...
void	fillPart (int variable, int way, double value, CbcSimpleIntegerDynamicPseudoCost *object)
	Does part of constructor. More...
virtual double	branch ()
	Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm. More...
virtual int	fillStrongInfo (CbcStrongInfo &info)
	Some branchingObjects may claim to be able to skip strong branching. More...
double	changeInGuessed () const
	Change in guessed. More...
void	setChangeInGuessed (double value)
	Set change in guessed. More...
CbcSimpleIntegerDynamicPseudoCost *	object () const
	Return object. More...
void	setObject (CbcSimpleIntegerDynamicPseudoCost *object)
	Set object. More...
virtual CbcBranchObjType	type () const
	Return the type (an integer identifier) of this. More...
virtual double	branch ()=0
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
virtual double	branch (OsiSolverInterface *)
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
Public Member Functions inherited from CbcIntegerBranchingObject
	CbcIntegerBranchingObject ()
	Default constructor. More...
	CbcIntegerBranchingObject (CbcModel *model, int variable, int way, double value)
	Create a standard floor/ceiling branch object. More...
	CbcIntegerBranchingObject (CbcModel *model, int variable, int way, double lowerValue, double upperValue)
	Create a degenerate branch object. More...
	CbcIntegerBranchingObject (const CbcIntegerBranchingObject &)
	Copy constructor. More...
CbcIntegerBranchingObject &	operator= (const CbcIntegerBranchingObject &rhs)
	Assignment operator. More...
virtual	~CbcIntegerBranchingObject ()
	Destructor. More...
void	fillPart (int variable, int way, double value)
	Does part of constructor. More...
virtual void	fix (OsiSolverInterface *solver, double *lower, double *upper, int branchState) const
	Update bounds in solver as in 'branch' and update given bounds. More...
virtual bool	tighten (OsiSolverInterface *)
	Change (tighten) bounds in object to reflect bounds in solver. More...
virtual void	print ()
	Print something about branch - only if log level high. More...
const double *	downBounds () const
	Lower and upper bounds for down branch. More...
const double *	upBounds () const
	Lower and upper bounds for up branch. More...
void	setDownBounds (const double bounds[2])
	Set lower and upper bounds for down branch. More...
void	setUpBounds (const double bounds[2])
	Set lower and upper bounds for up branch. More...
virtual CbcRangeCompare	compareBranchingObject (const CbcBranchingObject *brObj, const bool replaceIfOverlap=false)
	Compare the this with brObj. More...
virtual double	branch ()=0
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
virtual double	branch (OsiSolverInterface *)
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
virtual void	print () const
	Print something about branch - only if log level high. More...
Public Member Functions inherited from CbcBranchingObject
	CbcBranchingObject ()
	Default Constructor. More...
	CbcBranchingObject (CbcModel *model, int variable, int way, double value)
	Constructor. More...
	CbcBranchingObject (const CbcBranchingObject &)
	Copy constructor. More...
CbcBranchingObject &	operator= (const CbcBranchingObject &rhs)
	Assignment operator. More...
virtual	~CbcBranchingObject ()
	Destructor. More...
void	resetNumberBranchesLeft ()
	Reset number of branches left to original. More...
void	setNumberBranches (int value)
	Set number of branches to do. More...
virtual double	branch (OsiSolverInterface *)
	Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
virtual void	previousBranch ()
	Reset every information so that the branching object appears to point to the previous child. More...
virtual void	print () const
	Print something about branch - only if log level high. More...
int	variable () const
	Index identifying the associated CbcObject within its class. More...
int	way () const
	Get the state of the branching object. More...
void	way (int way)
	Set the state of the branching object. More...
void	setModel (CbcModel *model)
	update model More...
CbcModel *	model () const
	Return model. More...
CbcObject *	object () const
	Return pointer back to object which created. More...
void	setOriginalObject (CbcObject *object)
	Set pointer back to object which created. More...
virtual int	compareOriginalObject (const CbcBranchingObject *brObj) const
	Compare the original object of this with the original object of brObj. More...

Protected Attributes
double	changeInGuessed_
	Change in guessed objective value for next branch. More...
CbcSimpleIntegerDynamicPseudoCost *	object_
	Pointer back to object. More...
Protected Attributes inherited from CbcIntegerBranchingObject
double	down_ [2]
	Lower [0] and upper [1] bounds for the down arm (way_ = -1) More...
double	up_ [2]
	Lower [0] and upper [1] bounds for the up arm (way_ = 1) More...
Protected Attributes inherited from CbcBranchingObject
CbcModel *	model_
	The model that owns this branching object. More...
CbcObject *	originalCbcObject_
	Pointer back to object which created. More...
int	variable_
	Branching variable (0 is first integer) More...
int	way_
	The state of the branching object. More...

Detailed Description

Simple branching object for an integer variable with pseudo costs.

This object can specify a two-way branch on an integer variable. For each arm of the branch, the upper and lower bounds on the variable can be independently specified.

Variable_ holds the index of the integer variable in the integerVariable_ array of the model.

Definition at line 110 of file CbcBranchDynamic.hpp.

Constructor & Destructor Documentation

CbcDynamicPseudoCostBranchingObject() [1/4]

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject

(

)

Default constructor.

CbcDynamicPseudoCostBranchingObject() [2/4]

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject	(	CbcModel *	model,
		int	variable,
		int	way,
		double	value,
		CbcSimpleIntegerDynamicPseudoCost *	object
	)

Create a standard floor/ceiling branch object.

Specifies a simple two-way branch. Let value = x*. One arm of the branch will be is lb <= x <= floor(x*), the other ceil(x*) <= x <= ub. Specify way = -1 to set the object state to perform the down arm first, way = 1 for the up arm.

CbcDynamicPseudoCostBranchingObject() [3/4]

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject	(	CbcModel *	model,
		int	variable,
		int	way,
		double	lowerValue,
		double	upperValue
	)

Create a degenerate branch object.

Specifies a ‘one-way branch’. Calling branch() for this object will always result in lowerValue <= x <= upperValue. Used to fix a variable when lowerValue = upperValue.

CbcDynamicPseudoCostBranchingObject() [4/4]

CbcDynamicPseudoCostBranchingObject::CbcDynamicPseudoCostBranchingObject

(

const CbcDynamicPseudoCostBranchingObject &

)

Copy constructor.

~CbcDynamicPseudoCostBranchingObject()

virtual CbcDynamicPseudoCostBranchingObject::~CbcDynamicPseudoCostBranchingObject ( )

virtual

Destructor.

Member Function Documentation

operator=()

CbcDynamicPseudoCostBranchingObject& CbcDynamicPseudoCostBranchingObject::operator=

(

const CbcDynamicPseudoCostBranchingObject &

rhs

)

Assignment operator.

clone()

virtual CbcBranchingObject* CbcDynamicPseudoCostBranchingObject::clone ( ) const

virtual

Clone.

Reimplemented from CbcIntegerBranchingObject.

fillPart()

void CbcDynamicPseudoCostBranchingObject::fillPart	(	int	variable,
		int	way,
		double	value,
		CbcSimpleIntegerDynamicPseudoCost *	object
	)

Does part of constructor.

branch() [1/3]

virtual double CbcDynamicPseudoCostBranchingObject::branch ( )

virtual

Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.

This version also changes guessed objective value

Reimplemented from CbcIntegerBranchingObject.

fillStrongInfo()

virtual int CbcDynamicPseudoCostBranchingObject::fillStrongInfo ( CbcStrongInfo &  info )

virtual

Some branchingObjects may claim to be able to skip strong branching.

If so they have to fill in CbcStrongInfo. The object mention in incoming CbcStrongInfo must match. Returns nonzero if skip is wanted

Reimplemented from CbcBranchingObject.

changeInGuessed()

double CbcDynamicPseudoCostBranchingObject::changeInGuessed ( ) const

inline

Change in guessed.

Definition at line 168 of file CbcBranchDynamic.hpp.

setChangeInGuessed()

void CbcDynamicPseudoCostBranchingObject::setChangeInGuessed ( double  value )

inline

Set change in guessed.

Definition at line 173 of file CbcBranchDynamic.hpp.

object()

CbcSimpleIntegerDynamicPseudoCost* CbcDynamicPseudoCostBranchingObject::object ( ) const

inline

Return object.

Definition at line 178 of file CbcBranchDynamic.hpp.

setObject()

void CbcDynamicPseudoCostBranchingObject::setObject ( CbcSimpleIntegerDynamicPseudoCost *  object )

inline

Set object.

Definition at line 183 of file CbcBranchDynamic.hpp.

type()

virtual CbcBranchObjType CbcDynamicPseudoCostBranchingObject::type ( ) const

inlinevirtual

Return the type (an integer identifier) of this.

Reimplemented from CbcIntegerBranchingObject.

Definition at line 189 of file CbcBranchDynamic.hpp.

branch() [2/3]

virtual double CbcBranchingObject::branch

Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state.

Mainly for diagnostics, whether it is true branch or strong branching is also passed. Returns change in guessed objective on next branch

branch() [3/3]

virtual double CbcBranchingObject::branch

inline

Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state.

Mainly for diagnostics, whether it is true branch or strong branching is also passed. Returns change in guessed objective on next branch

Definition at line 105 of file CbcBranchingObject.hpp.

Member Data Documentation

changeInGuessed_

double CbcDynamicPseudoCostBranchingObject::changeInGuessed_

protected

Change in guessed objective value for next branch.

Definition at line 202 of file CbcBranchDynamic.hpp.

object_

CbcSimpleIntegerDynamicPseudoCost* CbcDynamicPseudoCostBranchingObject::object_

protected

Pointer back to object.

Definition at line 204 of file CbcBranchDynamic.hpp.

---

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

• /home/ted/Projects/Cbc/Cbc/src/CbcBranchDynamic.hpp