Information required while the node is live. More...

#include <CbcNode.hpp>

Inheritance diagram for CbcNode:

Collaboration diagram for CbcNode:

Public Member Functions
	CbcNode ()
	Default Constructor. More...

	CbcNode (CbcModel model, CbcNode lastNode)
	Construct and increment parent reference count. More...

	CbcNode (const CbcNode &)
	Copy constructor. More...

CbcNode &	operator= (const CbcNode &rhs)
	Assignment operator. More...

	~CbcNode ()
	Destructor. More...

void	createInfo (CbcModel model, CbcNode lastNode, const CoinWarmStartBasis lastws, const double lastLower, const double *lastUpper, int numberOldActiveCuts, int numberNewCuts)
	Create a description of the subproblem at this node. More...

int	chooseBranch (CbcModel model, CbcNode lastNode, int numberPassesLeft)
	Create a branching object for the node. More...

int	chooseDynamicBranch (CbcModel model, CbcNode lastNode, OsiSolverBranch *&branches, int numberPassesLeft)
	Create a branching object for the node - when dynamic pseudo costs. More...

int	chooseOsiBranch (CbcModel model, CbcNode lastNode, OsiBranchingInformation *usefulInfo, int branchState)
	Create a branching object for the node. More...

int	chooseClpBranch (CbcModel model, CbcNode lastNode)
	Create a branching object for the node. More...

int	analyze (CbcModel model, double results)

void	decrementCuts (int change=1)
	Decrement active cut counts. More...

void	decrementParentCuts (CbcModel *model, int change=1)
	Decrement all active cut counts in chain starting at parent. More...

void	nullNodeInfo ()
	Nulls out node info. More...

void	initializeInfo ()
	Initialize reference counts in attached CbcNodeInfo. More...

int	branch (OsiSolverInterface *solver)
	Does next branch and updates state. More...

double	checkIsCutoff (double cutoff)
	Double checks in case node can change its mind! Returns objective value Can change objective etc. More...

CbcNodeInfo *	nodeInfo () const

double	objectiveValue () const

void	setObjectiveValue (double value)

int	numberBranches () const
	Number of arms defined for the attached OsiBranchingObject. More...

int	way () const

int	depth () const
	Depth in branch-and-cut search tree. More...

void	setDepth (int value)
	Set depth in branch-and-cut search tree. More...

int	numberUnsatisfied () const
	Get the number of objects unsatisfied at this node. More...

void	setNumberUnsatisfied (int value)
	Set the number of objects unsatisfied at this node. More...

double	sumInfeasibilities () const
	Get sum of "infeasibilities" reported by each object. More...

void	setSumInfeasibilities (double value)
	Set sum of "infeasibilities" reported by each object. More...

double	guessedObjectiveValue () const

void	setGuessedObjectiveValue (double value)

const OsiBranchingObject *	branchingObject () const
	Branching object for this node. More...

OsiBranchingObject *	modifiableBranchingObject () const
	Modifiable branching object for this node. More...

void	setBranchingObject (OsiBranchingObject *branchingObject)
	Set branching object for this node (takes ownership) More...

int	nodeNumber () const
	The node number. More...

void	setNodeNumber (int node)

bool	onTree () const
	Returns true if on tree. More...

void	setOnTree (bool yesNo)
	Sets true if on tree. More...

bool	active () const
	Returns true if active. More...

void	setActive (bool yesNo)
	Sets true if active. More...

int	getState () const
	Get state (really for debug) More...

void	setState (int value)
	Set state (really for debug) More...

void	print () const
	Print. More...

void	checkInfo () const
	Debug. More...

Private Attributes
CbcNodeInfo *	nodeInfo_
	Information to make basis and bounds. More...

double	objectiveValue_
	Objective value. More...

double	guessedObjectiveValue_
	Guessed satisfied Objective value. More...

double	sumInfeasibilities_
	Sum of "infeasibilities" reported by each object. More...

OsiBranchingObject *	branch_
	Branching object for this node. More...

int	depth_
	Depth of the node in the search tree. More...

int	numberUnsatisfied_
	The number of objects unsatisfied at this node. More...

int	nodeNumber_
	The node number. More...

int	state_
	State 1 - on tree 2 - active. More...

Detailed Description

Information required while the node is live.

When a subproblem is initially created, it is represented by an CbcNode object and an attached CbcNodeInfo object.

The CbcNode contains information (depth, branching instructions), that's needed while the subproblem remains ‘live’, i.e., while the subproblem is not fathomed and there are branch arms still be be evaluated. The CbcNode is deleted when the last branch arm has been evaluated.

The CbcNodeInfo object contains the information needed to maintain the search tree and recreate the subproblem for the node. It remains in existence until there are no nodes remaining in the subtree rooted at this node.

Definition at line 49 of file CbcNode.hpp.

Constructor & Destructor Documentation

◆ CbcNode() [1/3]

CbcNode::CbcNode ( )

Default Constructor.

◆ CbcNode() [2/3]

CbcNode::CbcNode	(	CbcModel *	model,
		CbcNode *	lastNode
	)

Construct and increment parent reference count.

◆ CbcNode() [3/3]

CbcNode::CbcNode ( const CbcNode & )

Copy constructor.

◆ ~CbcNode()

CbcNode::~CbcNode ( )

Destructor.

Member Function Documentation

◆ operator=()

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

Assignment operator.

◆ createInfo()

void CbcNode::createInfo	(	CbcModel *	model,
		CbcNode *	lastNode,
		const CoinWarmStartBasis *	lastws,
		const double *	lastLower,
		const double *	lastUpper,
		int	numberOldActiveCuts,
		int	numberNewCuts
	)

Create a description of the subproblem at this node.

The CbcNodeInfo structure holds the information (basis & variable bounds) required to recreate the subproblem for this node. It also links the node to its parent (via the parent's CbcNodeInfo object).

If lastNode == NULL, a CbcFullNodeInfo object will be created. All parameters except model are unused.

If lastNode != NULL, a CbcPartialNodeInfo object will be created. Basis and bounds information will be stored in the form of differences between the parent subproblem and this subproblem. (More precisely, lastws, lastUpper, lastLower, numberOldActiveCuts, and numberNewCuts are used.)

◆ chooseBranch()

int CbcNode::chooseBranch	(	CbcModel *	model,
		CbcNode *	lastNode,
		int	numberPassesLeft
	)

Create a branching object for the node.

The routine scans the object list of the model and selects a set of unsatisfied objects as candidates for branching. The candidates are evaluated, and an appropriate branch object is installed.

The numberPassesLeft is decremented to stop fixing one variable each time and going on and on (e.g. for stock cutting, air crew scheduling)

If evaluation determines that an object is monotone or infeasible, the routine returns immediately. In the case of a monotone object, the branch object has already been called to modify the model.

Return value:

0: A branching object has been installed
-1: A monotone object was discovered
-2: An infeasible object was discovered

◆ chooseDynamicBranch()

int CbcNode::chooseDynamicBranch	(	CbcModel *	model,
		CbcNode *	lastNode,
		OsiSolverBranch *&	branches,
		int	numberPassesLeft
	)

Create a branching object for the node - when dynamic pseudo costs.

The routine scans the object list of the model and selects a set of unsatisfied objects as candidates for branching. The candidates are evaluated, and an appropriate branch object is installed. This version gives preference in evaluation to variables which have not been evaluated many times. It also uses numberStrong to say give up if last few tries have not changed incumbent. See Achterberg, Koch and Martin.

The numberPassesLeft is decremented to stop fixing one variable each time and going on and on (e.g. for stock cutting, air crew scheduling)

If evaluation determines that an object is monotone or infeasible, the routine returns immediately. In the case of a monotone object, the branch object has already been called to modify the model.

Return value:

0: A branching object has been installed
-1: A monotone object was discovered
-2: An infeasible object was discovered
>0: Number of quich branching objects (and branches will be non NULL)

◆ chooseOsiBranch()

int CbcNode::chooseOsiBranch	(	CbcModel *	model,
		CbcNode *	lastNode,
		OsiBranchingInformation *	usefulInfo,
		int	branchState
	)

Create a branching object for the node.

The routine scans the object list of the model and selects a set of unsatisfied objects as candidates for branching. The candidates are evaluated, and an appropriate branch object is installed.

The numberPassesLeft is decremented to stop fixing one variable each time and going on and on (e.g. for stock cutting, air crew scheduling)

If evaluation determines that an object is monotone or infeasible, the routine returns immediately. In the case of a monotone object, the branch object has already been called to modify the model.

Return value:

0: A branching object has been installed
-1: A monotone object was discovered
-2: An infeasible object was discovered

Branch state:

-1: start
-1: A monotone object was discovered
-2: An infeasible object was discovered

◆ chooseClpBranch()

int CbcNode::chooseClpBranch	(	CbcModel *	model,
		CbcNode *	lastNode
	)

Create a branching object for the node.

The routine scans the object list of the model and selects a set of unsatisfied objects as candidates for branching. It then solves a series of problems and a CbcGeneral branch object is installed.

If evaluation determines that an object is infeasible, the routine returns immediately.

Return value:

0: A branching object has been installed
-2: An infeasible object was discovered

◆ analyze()

int CbcNode::analyze	(	CbcModel *	model,
		double *	results
	)

◆ decrementCuts()

void CbcNode::decrementCuts ( int change = 1 )

Decrement active cut counts.

◆ decrementParentCuts()

void CbcNode::decrementParentCuts	(	CbcModel *	model,
		int	change = `1`
	)

Decrement all active cut counts in chain starting at parent.

◆ nullNodeInfo()

void CbcNode::nullNodeInfo ( )

Nulls out node info.

◆ initializeInfo()

void CbcNode::initializeInfo ( )

Initialize reference counts in attached CbcNodeInfo.

This is a convenience routine, which will initialize the reference counts in the attached CbcNodeInfo object based on the attached OsiBranchingObject.

See also: CbcNodeInfo::initializeInfo(int).

◆ branch()

int CbcNode::branch ( OsiSolverInterface * solver )

Does next branch and updates state.

◆ checkIsCutoff()

double CbcNode::checkIsCutoff ( double cutoff )

Double checks in case node can change its mind! Returns objective value Can change objective etc.

◆ nodeInfo()

CbcNodeInfo* CbcNode::nodeInfo ( ) const

inline

Definition at line 215 of file CbcNode.hpp.

◆ objectiveValue()

double CbcNode::objectiveValue ( ) const

inline

Definition at line 221 of file CbcNode.hpp.

◆ setObjectiveValue()

void CbcNode::setObjectiveValue ( double value )

inline

Definition at line 225 of file CbcNode.hpp.

◆ numberBranches()

int CbcNode::numberBranches ( ) const

inline

Number of arms defined for the attached OsiBranchingObject.

Definition at line 230 of file CbcNode.hpp.

◆ way()

int CbcNode::way ( ) const

◆ depth()

int CbcNode::depth ( ) const

inline

Depth in branch-and-cut search tree.

Definition at line 246 of file CbcNode.hpp.

◆ setDepth()

void CbcNode::setDepth ( int value )

inline

Set depth in branch-and-cut search tree.

Definition at line 251 of file CbcNode.hpp.

◆ numberUnsatisfied()

int CbcNode::numberUnsatisfied ( ) const

inline

Get the number of objects unsatisfied at this node.

Definition at line 256 of file CbcNode.hpp.

◆ setNumberUnsatisfied()

void CbcNode::setNumberUnsatisfied ( int value )

inline

Set the number of objects unsatisfied at this node.

Definition at line 261 of file CbcNode.hpp.

◆ sumInfeasibilities()

double CbcNode::sumInfeasibilities ( ) const

inline

Get sum of "infeasibilities" reported by each object.

Definition at line 266 of file CbcNode.hpp.

◆ setSumInfeasibilities()

void CbcNode::setSumInfeasibilities ( double value )

inline

Set sum of "infeasibilities" reported by each object.

Definition at line 271 of file CbcNode.hpp.

◆ guessedObjectiveValue()

double CbcNode::guessedObjectiveValue ( ) const

inline

Definition at line 276 of file CbcNode.hpp.

◆ setGuessedObjectiveValue()

void CbcNode::setGuessedObjectiveValue ( double value )

inline

Definition at line 280 of file CbcNode.hpp.

◆ branchingObject()

const OsiBranchingObject* CbcNode::branchingObject ( ) const

inline

Branching object for this node.

Definition at line 285 of file CbcNode.hpp.

◆ modifiableBranchingObject()

OsiBranchingObject* CbcNode::modifiableBranchingObject ( ) const

inline

Modifiable branching object for this node.

Definition at line 290 of file CbcNode.hpp.

◆ setBranchingObject()

void CbcNode::setBranchingObject ( OsiBranchingObject * branchingObject )

inline

Set branching object for this node (takes ownership)

Definition at line 295 of file CbcNode.hpp.

◆ nodeNumber()

int CbcNode::nodeNumber ( ) const

inline

The node number.

Definition at line 300 of file CbcNode.hpp.

◆ setNodeNumber()

void CbcNode::setNodeNumber ( int node )

inline

Definition at line 304 of file CbcNode.hpp.

◆ onTree()

bool CbcNode::onTree ( ) const

inline

Returns true if on tree.

Definition at line 309 of file CbcNode.hpp.

◆ setOnTree()

void CbcNode::setOnTree ( bool yesNo )

inline

Sets true if on tree.

Definition at line 314 of file CbcNode.hpp.

◆ active()

bool CbcNode::active ( ) const

inline

Returns true if active.

Definition at line 322 of file CbcNode.hpp.

◆ setActive()

void CbcNode::setActive ( bool yesNo )

inline

Sets true if active.

Definition at line 327 of file CbcNode.hpp.

◆ getState()

int CbcNode::getState ( ) const

inline

Get state (really for debug)

Definition at line 335 of file CbcNode.hpp.

◆ setState()

void CbcNode::setState ( int value )

inline

Set state (really for debug)

Definition at line 340 of file CbcNode.hpp.

◆ print()

void CbcNode::print ( ) const

Print.

◆ checkInfo()

void CbcNode::checkInfo ( ) const

inline

Debug.

Definition at line 347 of file CbcNode.hpp.

Member Data Documentation

◆ nodeInfo_

CbcNodeInfo* CbcNode::nodeInfo_

private

Information to make basis and bounds.

Definition at line 355 of file CbcNode.hpp.

◆ objectiveValue_

double CbcNode::objectiveValue_

private

Objective value.

Definition at line 357 of file CbcNode.hpp.

◆ guessedObjectiveValue_

double CbcNode::guessedObjectiveValue_

private

Guessed satisfied Objective value.

Definition at line 359 of file CbcNode.hpp.

◆ sumInfeasibilities_

double CbcNode::sumInfeasibilities_

private

Sum of "infeasibilities" reported by each object.

Definition at line 361 of file CbcNode.hpp.

◆ branch_

OsiBranchingObject* CbcNode::branch_

private

Branching object for this node.

Definition at line 363 of file CbcNode.hpp.

◆ depth_

int CbcNode::depth_

private

Depth of the node in the search tree.

Definition at line 365 of file CbcNode.hpp.

◆ numberUnsatisfied_

int CbcNode::numberUnsatisfied_

private

The number of objects unsatisfied at this node.

Definition at line 367 of file CbcNode.hpp.

◆ nodeNumber_

int CbcNode::nodeNumber_

private

The node number.

Definition at line 369 of file CbcNode.hpp.

◆ state_

int CbcNode::state_

private

State 1 - on tree 2 - active.

Definition at line 374 of file CbcNode.hpp.

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbcNode() [1/3]

◆ CbcNode() [2/3]

◆ CbcNode() [3/3]

◆ ~CbcNode()

Member Function Documentation

◆ operator=()

◆ createInfo()

◆ chooseBranch()

◆ chooseDynamicBranch()

◆ chooseOsiBranch()

◆ chooseClpBranch()

◆ analyze()

◆ decrementCuts()

◆ decrementParentCuts()

◆ nullNodeInfo()

◆ initializeInfo()

◆ branch()

◆ checkIsCutoff()

◆ nodeInfo()

◆ objectiveValue()

◆ setObjectiveValue()

◆ numberBranches()

◆ way()

◆ depth()

◆ setDepth()

◆ numberUnsatisfied()

◆ setNumberUnsatisfied()

◆ sumInfeasibilities()

◆ setSumInfeasibilities()

◆ guessedObjectiveValue()

◆ setGuessedObjectiveValue()

◆ branchingObject()

◆ modifiableBranchingObject()

◆ setBranchingObject()

◆ nodeNumber()

◆ setNodeNumber()

◆ onTree()

◆ setOnTree()

◆ active()

◆ setActive()

◆ getState()

◆ setState()

◆ print()

◆ checkInfo()

Member Data Documentation

◆ nodeInfo_

◆ objectiveValue_

◆ guessedObjectiveValue_

◆ sumInfeasibilities_

◆ branch_

◆ depth_

◆ numberUnsatisfied_

◆ nodeNumber_

◆ state_