CbcNodeInfo Class Reference

Information required to recreate the subproblem at this node. More...

#include <CbcNode.hpp>

Inheritance diagram for CbcNodeInfo:

Inheritance graph
[legend]
Collaboration diagram for CbcNodeInfo:

Collaboration graph
[legend]
List of all members.

Public Member Functions

virtual void applyToModel (CbcModel *model, CoinWarmStartBasis *&basis, CbcCountRowCut **addCuts, int &currentNumberCuts) const =0
 Modify model according to information at node.
virtual CbcNodeInfobuildRowBasis (CoinWarmStartBasis &basis) const =0
 Builds up row basis backwards (until original model).
virtual CbcNodeInfoclone () const =0
 Clone.
virtual void allBranchesGone ()
 Called when number branches left down to zero.
void increment (int amount=1)
 Increment number of references.
int decrement (int amount=1)
 Decrement number of references and return number left.
void initializeInfo (int number)
 Initialize reference counts.
int numberBranchesLeft () const
 Return number of branches left in object.
int numberPointingToThis () const
 Return number of objects pointing to this.
int branchedOn ()
 Say one branch taken.
void throwAway ()
 Say thrown away.
CbcNodeInfoparent () const
 Parent of this.
void nullParent ()
 Set parent null.
void addCuts (OsiCuts &cuts, int numberToBranch, int *whichGenerator)
void addCuts (int numberCuts, CbcCountRowCut **cuts, int numberToBranch)
void deleteCuts (int numberToDelete, CbcCountRowCut **cuts)
 Delete cuts (decrements counts) Slow unless cuts in same order as saved.
void deleteCuts (int numberToDelete, int *which)
void deleteCut (int whichOne)
 Really delete a cut.
void decrementCuts (int change=1)
 Decrement active cut counts.
void decrementParentCuts (int change=1)
 Decrement all active cut counts in chain starting at parent.
void incrementParentCuts (int change=1)
 Increment all active cut counts in parent chain.
CbcCountRowCut ** cuts () const
 Array of pointers to cuts.
int numberCuts () const
 Number of row cuts (this node).
void setNumberCuts (int value)
void nullOwner ()
 Set owner null.
const CbcNodeowner () const
int nodeNumber () const
 The node number.
void setNodeNumber (int node)
Constructors & destructors
 CbcNodeInfo ()
 Default Constructor.
 CbcNodeInfo (const CbcNodeInfo &)
 Copy constructor.
 CbcNodeInfo (CbcNodeInfo *parent)
 Construct with parent.
 CbcNodeInfo (CbcNodeInfo *parent, CbcNode *owner)
 Construct with parent and owner.
virtual ~CbcNodeInfo ()
 Destructor.

Protected Attributes

int numberPointingToThis_
 Number of other nodes pointing to this node.
CbcNodeInfoparent_
 parent
CbcNodeowner_
 Owner.
int numberCuts_
 Number of row cuts (this node).
int nodeNumber_
 The node number.
CbcCountRowCut ** cuts_
 Array of pointers to cuts.
int numberRows_
 Number of rows in problem (before these cuts).
int numberBranchesLeft_
 Number of branch arms left to explore at this node.

Private Member Functions

CbcNodeInfooperator= (const CbcNodeInfo &rhs)
 Illegal Assignment operator.

Detailed Description

Information required to recreate the subproblem at this node.

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

The CbcNode contains information needed while the subproblem remains live. The CbcNode is deleted when the last branch arm has been evaluated.

The CbcNodeInfo contains information required to maintain the branch-and-cut search tree structure (links and reference counts) and to recreate the subproblem for this node (basis, variable bounds, cutting planes). A CbcNodeInfo object remains in existence until all nodes have been pruned from the subtree rooted at this node.

The principle used to maintain the reference count is that the reference count is always the sum of all potential and actual children of the node. Specifically,

Notice that the active subproblem lives in a sort of limbo, neither a potential or an actual node in the branch-and-cut tree.

CbcNodeInfo objects come in two flavours. A CbcFullNodeInfo object contains a full record of the information required to recreate a subproblem. A CbcPartialNodeInfo object expresses this information in terms of differences from the parent.

Definition at line 60 of file CbcNode.hpp.


Constructor & Destructor Documentation

CbcNodeInfo::CbcNodeInfo (  ) 

Default Constructor.

Creates an empty NodeInfo object.

CbcNodeInfo::CbcNodeInfo ( const CbcNodeInfo  ) 

Copy constructor.

CbcNodeInfo::CbcNodeInfo ( CbcNodeInfo parent  ) 

Construct with parent.

Creates a NodeInfo object which knows its parent and assumes it will in turn have two children.

CbcNodeInfo::CbcNodeInfo ( CbcNodeInfo parent,
CbcNode owner 
)

Construct with parent and owner.

As for `construct with parent', and attached to owner.

virtual CbcNodeInfo::~CbcNodeInfo (  )  [virtual]

Destructor.

Note that the destructor will recursively delete the parent if this nodeInfo is the last child.


Member Function Documentation

virtual void CbcNodeInfo::applyToModel ( CbcModel model,
CoinWarmStartBasis *&  basis,
CbcCountRowCut **  addCuts,
int &  currentNumberCuts 
) const [pure virtual]

Modify model according to information at node.

The routine modifies the model according to bound and basis information at node and adds any cuts to the addCuts array.

Implemented in CbcFullNodeInfo, and CbcPartialNodeInfo.

virtual CbcNodeInfo* CbcNodeInfo::buildRowBasis ( CoinWarmStartBasis basis  )  const [pure virtual]

Builds up row basis backwards (until original model).

Returns NULL or previous one to apply . Depends on Free being 0 and impossible for cuts

Implemented in CbcFullNodeInfo, and CbcPartialNodeInfo.

virtual CbcNodeInfo* CbcNodeInfo::clone (  )  const [pure virtual]

Clone.

Implemented in CbcFullNodeInfo, and CbcPartialNodeInfo.

virtual void CbcNodeInfo::allBranchesGone (  )  [inline, virtual]

Called when number branches left down to zero.

Definition at line 115 of file CbcNode.hpp.

void CbcNodeInfo::increment ( int  amount = 1  )  [inline]

Increment number of references.

Definition at line 118 of file CbcNode.hpp.

References numberPointingToThis_.

int CbcNodeInfo::decrement ( int  amount = 1  )  [inline]

Decrement number of references and return number left.

Definition at line 122 of file CbcNode.hpp.

References numberPointingToThis_.

void CbcNodeInfo::initializeInfo ( int  number  )  [inline]

Initialize reference counts.

Initialize the reference counts used for tree maintenance.

Definition at line 130 of file CbcNode.hpp.

References numberBranchesLeft_, and numberPointingToThis_.

int CbcNodeInfo::numberBranchesLeft (  )  const [inline]

Return number of branches left in object.

Definition at line 134 of file CbcNode.hpp.

References numberBranchesLeft_.

int CbcNodeInfo::numberPointingToThis (  )  const [inline]

Return number of objects pointing to this.

Definition at line 138 of file CbcNode.hpp.

References numberPointingToThis_.

int CbcNodeInfo::branchedOn (  )  [inline]

Say one branch taken.

Definition at line 142 of file CbcNode.hpp.

References numberBranchesLeft_, and numberPointingToThis_.

void CbcNodeInfo::throwAway (  )  [inline]

Say thrown away.

Definition at line 146 of file CbcNode.hpp.

References numberBranchesLeft_, and numberPointingToThis_.

CbcNodeInfo* CbcNodeInfo::parent (  )  const [inline]

Parent of this.

Definition at line 150 of file CbcNode.hpp.

References parent_.

void CbcNodeInfo::nullParent (  )  [inline]

Set parent null.

Definition at line 153 of file CbcNode.hpp.

References parent_.

void CbcNodeInfo::addCuts ( OsiCuts cuts,
int  numberToBranch,
int *  whichGenerator 
)

void CbcNodeInfo::addCuts ( int  numberCuts,
CbcCountRowCut **  cuts,
int  numberToBranch 
)

void CbcNodeInfo::deleteCuts ( int  numberToDelete,
CbcCountRowCut **  cuts 
)

Delete cuts (decrements counts) Slow unless cuts in same order as saved.

void CbcNodeInfo::deleteCuts ( int  numberToDelete,
int *  which 
)

void CbcNodeInfo::deleteCut ( int  whichOne  ) 

Really delete a cut.

void CbcNodeInfo::decrementCuts ( int  change = 1  ) 

Decrement active cut counts.

void CbcNodeInfo::decrementParentCuts ( int  change = 1  ) 

Decrement all active cut counts in chain starting at parent.

void CbcNodeInfo::incrementParentCuts ( int  change = 1  ) 

Increment all active cut counts in parent chain.

CbcCountRowCut** CbcNodeInfo::cuts (  )  const [inline]

Array of pointers to cuts.

Definition at line 177 of file CbcNode.hpp.

References cuts_.

int CbcNodeInfo::numberCuts (  )  const [inline]

Number of row cuts (this node).

Definition at line 181 of file CbcNode.hpp.

References numberCuts_.

void CbcNodeInfo::setNumberCuts ( int  value  )  [inline]

Definition at line 183 of file CbcNode.hpp.

References numberCuts_.

void CbcNodeInfo::nullOwner (  )  [inline]

Set owner null.

Definition at line 187 of file CbcNode.hpp.

References owner_.

const CbcNode* CbcNodeInfo::owner (  )  const [inline]

Definition at line 189 of file CbcNode.hpp.

References owner_.

int CbcNodeInfo::nodeNumber (  )  const [inline]

The node number.

Definition at line 192 of file CbcNode.hpp.

References nodeNumber_.

void CbcNodeInfo::setNodeNumber ( int  node  )  [inline]

Definition at line 194 of file CbcNode.hpp.

CbcNodeInfo& CbcNodeInfo::operator= ( const CbcNodeInfo rhs  )  [private]

Illegal Assignment operator.


Member Data Documentation

int CbcNodeInfo::numberPointingToThis_ [protected]

Number of other nodes pointing to this node.

Number of existing and potential search tree nodes pointing to this node. `Existing' means referenced by parent_ of some other CbcNodeInfo. `Potential' means children still to be created (numberBranchesLeft_ of this CbcNodeInfo).

Definition at line 195 of file CbcNode.hpp.

Referenced by branchedOn(), decrement(), increment(), initializeInfo(), numberPointingToThis(), and throwAway().

CbcNodeInfo* CbcNodeInfo::parent_ [protected]

parent

Definition at line 208 of file CbcNode.hpp.

Referenced by nullParent(), and parent().

CbcNode* CbcNodeInfo::owner_ [protected]

Owner.

Definition at line 211 of file CbcNode.hpp.

Referenced by nullOwner(), and owner().

int CbcNodeInfo::numberCuts_ [protected]

Number of row cuts (this node).

Definition at line 214 of file CbcNode.hpp.

Referenced by numberCuts(), and setNumberCuts().

int CbcNodeInfo::nodeNumber_ [protected]

The node number.

Definition at line 217 of file CbcNode.hpp.

Referenced by nodeNumber().

CbcCountRowCut** CbcNodeInfo::cuts_ [protected]

Array of pointers to cuts.

Definition at line 220 of file CbcNode.hpp.

Referenced by cuts().

int CbcNodeInfo::numberRows_ [protected]

Number of rows in problem (before these cuts).

This means that for top of chain it must be rows at continuous

Definition at line 224 of file CbcNode.hpp.

int CbcNodeInfo::numberBranchesLeft_ [protected]

Number of branch arms left to explore at this node.

Todo:
There seems to be redundancy between this field and CbcBranchingObject::numberBranchesLeft_. It'd be good to sort out if both are necessary.

Definition at line 232 of file CbcNode.hpp.

Referenced by branchedOn(), initializeInfo(), numberBranchesLeft(), and throwAway().


The documentation for this class was generated from the following file:
Generated on Thu May 15 22:00:04 2008 by  doxygen 1.4.7