Cbc  2.9.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
CbcNodeInfo Class Referenceabstract

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

#include <CbcNodeInfo.hpp>

+ Inheritance diagram for CbcNodeInfo:
+ Collaboration diagram for CbcNodeInfo:

Public Member Functions

virtual void applyToModel (CbcModel *model, CoinWarmStartBasis *&basis, CbcCountRowCut **addCuts, int &currentNumberCuts) const =0
 Modify model according to information at node. More...
 
virtual int applyBounds (int iColumn, double &lower, double &upper, int force)=0
 Just apply bounds to one variable - force means overwrite by lower,upper (1=>infeasible) More...
 
virtual CbcNodeInfobuildRowBasis (CoinWarmStartBasis &basis) const =0
 Builds up row basis backwards (until original model). More...
 
virtual CbcNodeInfoclone () const =0
 Clone. More...
 
virtual void allBranchesGone ()
 Called when number branches left down to zero. More...
 
void increment (int amount=1)
 Increment number of references. More...
 
int decrement (int amount=1)
 Decrement number of references and return number left. More...
 
void initializeInfo (int number)
 Initialize reference counts. More...
 
int numberBranchesLeft () const
 Return number of branches left in object. More...
 
void setNumberBranchesLeft (int value)
 Set number of branches left in object. More...
 
int numberPointingToThis () const
 Return number of objects pointing to this. More...
 
void setNumberPointingToThis (int number)
 Set number of objects pointing to this. More...
 
void incrementNumberPointingToThis ()
 Increment number of objects pointing to this. More...
 
int branchedOn ()
 Say one branch taken. More...
 
void throwAway ()
 Say thrown away. More...
 
CbcNodeInfoparent () const
 Parent of this. More...
 
void nullParent ()
 Set parent null. More...
 
void addCuts (OsiCuts &cuts, int numberToBranch, int numberPointingToThis)
 
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. More...
 
void deleteCuts (int numberToDelete, int *which)
 
void deleteCut (int whichOne)
 Really delete a cut. More...
 
void decrementCuts (int change=1)
 Decrement active cut counts. More...
 
void incrementCuts (int change=1)
 Increment active cut counts. More...
 
void decrementParentCuts (CbcModel *model, int change=1)
 Decrement all active cut counts in chain starting at parent. More...
 
void incrementParentCuts (CbcModel *model, int change=1)
 Increment all active cut counts in parent chain. More...
 
CbcCountRowCut ** cuts () const
 Array of pointers to cuts. More...
 
int numberCuts () const
 Number of row cuts (this node) More...
 
void setNumberCuts (int value)
 
void nullOwner ()
 Set owner null. More...
 
const CbcNodeowner () const
 
CbcNodemutableOwner () const
 
int nodeNumber () const
 The node number. More...
 
void setNodeNumber (int node)
 
void deactivate (int mode=3)
 Deactivate node information. More...
 
bool allActivated () const
 Say if normal. More...
 
bool marked () const
 Say if marked. More...
 
void mark ()
 Mark. More...
 
void unmark ()
 Unmark. More...
 
bool symmetryWorked () const
 Get symmetry value (true worked at this node) More...
 
void setSymmetryWorked ()
 Say symmetry worked at this node) More...
 
const OsiBranchingObjectparentBranch () const
 Branching object for the parent. More...
 
void unsetParentBasedData ()
 If we need to take off parent based data. More...
 
Constructors & destructors
 CbcNodeInfo ()
 Default Constructor. More...
 
 CbcNodeInfo (const CbcNodeInfo &)
 Copy constructor. More...
 
 CbcNodeInfo (CbcNodeInfo *parent, CbcNode *owner)
 Construct with parent and owner. More...
 
virtual ~CbcNodeInfo ()
 Destructor. More...
 

Protected Attributes

int numberPointingToThis_
 Number of other nodes pointing to this node. More...
 
CbcNodeInfoparent_
 parent More...
 
OsiBranchingObjectparentBranch_
 Copy of the branching object of the parent when the node is created. More...
 
CbcNodeowner_
 Owner. More...
 
int numberCuts_
 Number of row cuts (this node) More...
 
int nodeNumber_
 The node number. More...
 
CbcCountRowCut ** cuts_
 Array of pointers to cuts. More...
 
int numberRows_
 Number of rows in problem (before these cuts). More...
 
int numberBranchesLeft_
 Number of branch arms left to explore at this node. More...
 
int active_
 Active node information. More...
 

Private Member Functions

CbcNodeInfooperator= (const CbcNodeInfo &rhs)
 Illegal Assignment operator. More...
 
void setParentBasedData ()
 routine common to constructors More...
 

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 68 of file CbcNodeInfo.hpp.

Constructor & Destructor Documentation

CbcNodeInfo::CbcNodeInfo ( )

Default Constructor.

Creates an empty NodeInfo object.

CbcNodeInfo::CbcNodeInfo ( const CbcNodeInfo )

Copy constructor.

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 int CbcNodeInfo::applyBounds ( int  iColumn,
double &  lower,
double &  upper,
int  force 
)
pure virtual

Just apply bounds to one variable - force means overwrite by lower,upper (1=>infeasible)

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 ( )
inlinevirtual

Called when number branches left down to zero.

Definition at line 126 of file CbcNodeInfo.hpp.

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

Increment number of references.

Definition at line 129 of file CbcNodeInfo.hpp.

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

Decrement number of references and return number left.

Definition at line 134 of file CbcNodeInfo.hpp.

void CbcNodeInfo::initializeInfo ( int  number)
inline

Initialize reference counts.

Initialize the reference counts used for tree maintenance.

Definition at line 149 of file CbcNodeInfo.hpp.

int CbcNodeInfo::numberBranchesLeft ( ) const
inline

Return number of branches left in object.

Definition at line 155 of file CbcNodeInfo.hpp.

void CbcNodeInfo::setNumberBranchesLeft ( int  value)
inline

Set number of branches left in object.

Definition at line 160 of file CbcNodeInfo.hpp.

int CbcNodeInfo::numberPointingToThis ( ) const
inline

Return number of objects pointing to this.

Definition at line 165 of file CbcNodeInfo.hpp.

void CbcNodeInfo::setNumberPointingToThis ( int  number)
inline

Set number of objects pointing to this.

Definition at line 170 of file CbcNodeInfo.hpp.

void CbcNodeInfo::incrementNumberPointingToThis ( )
inline

Increment number of objects pointing to this.

Definition at line 175 of file CbcNodeInfo.hpp.

int CbcNodeInfo::branchedOn ( )
inline

Say one branch taken.

Definition at line 180 of file CbcNodeInfo.hpp.

void CbcNodeInfo::throwAway ( )
inline

Say thrown away.

Definition at line 187 of file CbcNodeInfo.hpp.

CbcNodeInfo* CbcNodeInfo::parent ( ) const
inline

Parent of this.

Definition at line 193 of file CbcNodeInfo.hpp.

void CbcNodeInfo::nullParent ( )
inline

Set parent null.

Definition at line 197 of file CbcNodeInfo.hpp.

void CbcNodeInfo::addCuts ( OsiCuts cuts,
int  numberToBranch,
int  numberPointingToThis 
)
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::incrementCuts ( int  change = 1)

Increment active cut counts.

void CbcNodeInfo::decrementParentCuts ( CbcModel model,
int  change = 1 
)

Decrement all active cut counts in chain starting at parent.

void CbcNodeInfo::incrementParentCuts ( CbcModel model,
int  change = 1 
)

Increment all active cut counts in parent chain.

CbcCountRowCut** CbcNodeInfo::cuts ( ) const
inline

Array of pointers to cuts.

Definition at line 226 of file CbcNodeInfo.hpp.

int CbcNodeInfo::numberCuts ( ) const
inline

Number of row cuts (this node)

Definition at line 231 of file CbcNodeInfo.hpp.

void CbcNodeInfo::setNumberCuts ( int  value)
inline

Definition at line 234 of file CbcNodeInfo.hpp.

void CbcNodeInfo::nullOwner ( )
inline

Set owner null.

Definition at line 239 of file CbcNodeInfo.hpp.

const CbcNode* CbcNodeInfo::owner ( ) const
inline

Definition at line 242 of file CbcNodeInfo.hpp.

CbcNode* CbcNodeInfo::mutableOwner ( ) const
inline

Definition at line 245 of file CbcNodeInfo.hpp.

int CbcNodeInfo::nodeNumber ( ) const
inline

The node number.

Definition at line 249 of file CbcNodeInfo.hpp.

void CbcNodeInfo::setNodeNumber ( int  node)
inline

Definition at line 252 of file CbcNodeInfo.hpp.

void CbcNodeInfo::deactivate ( int  mode = 3)

Deactivate node information.

1 - bounds 2 - cuts 4 - basis! 8 - just marked 16 - symmetry branching worked

bool CbcNodeInfo::allActivated ( ) const
inline

Say if normal.

Definition at line 264 of file CbcNodeInfo.hpp.

bool CbcNodeInfo::marked ( ) const
inline

Say if marked.

Definition at line 268 of file CbcNodeInfo.hpp.

void CbcNodeInfo::mark ( )
inline

Mark.

Definition at line 272 of file CbcNodeInfo.hpp.

void CbcNodeInfo::unmark ( )
inline

Unmark.

Definition at line 276 of file CbcNodeInfo.hpp.

bool CbcNodeInfo::symmetryWorked ( ) const
inline

Get symmetry value (true worked at this node)

Definition at line 280 of file CbcNodeInfo.hpp.

void CbcNodeInfo::setSymmetryWorked ( )
inline

Say symmetry worked at this node)

Definition at line 283 of file CbcNodeInfo.hpp.

const OsiBranchingObject* CbcNodeInfo::parentBranch ( ) const
inline

Branching object for the parent.

Definition at line 287 of file CbcNodeInfo.hpp.

void CbcNodeInfo::unsetParentBasedData ( )

If we need to take off parent based data.

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

Illegal Assignment operator.

void CbcNodeInfo::setParentBasedData ( )
private

routine common to constructors

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 301 of file CbcNodeInfo.hpp.

CbcNodeInfo* CbcNodeInfo::parent_
protected

parent

Definition at line 304 of file CbcNodeInfo.hpp.

OsiBranchingObject* CbcNodeInfo::parentBranch_
protected

Copy of the branching object of the parent when the node is created.

Definition at line 307 of file CbcNodeInfo.hpp.

CbcNode* CbcNodeInfo::owner_
protected

Owner.

Definition at line 310 of file CbcNodeInfo.hpp.

int CbcNodeInfo::numberCuts_
protected

Number of row cuts (this node)

Definition at line 313 of file CbcNodeInfo.hpp.

int CbcNodeInfo::nodeNumber_
protected

The node number.

Definition at line 316 of file CbcNodeInfo.hpp.

CbcCountRowCut** CbcNodeInfo::cuts_
protected

Array of pointers to cuts.

Definition at line 319 of file CbcNodeInfo.hpp.

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 323 of file CbcNodeInfo.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 331 of file CbcNodeInfo.hpp.

int CbcNodeInfo::active_
protected

Active node information.

1 - bounds 2 - cuts 4 - basis!

Definition at line 337 of file CbcNodeInfo.hpp.


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