CbcTree Class Reference

#include <CbcTree.hpp>

Inheritance diagram for CbcTree:

Inheritance graph
[legend]
Collaboration diagram for CbcTree:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CbcTree ()
 CbcTree (const CbcTree &rhs)
CbcTreeoperator= (const CbcTree &rhs)
virtual ~CbcTree ()
virtual CbcTreeclone () const
 Clone.
Heap access and maintenance methods
void setComparison (CbcCompareBase &compare)
 Set comparison function and resort heap.
virtual CbcNodetop ()
 Return the top node of the heap.
virtual void push (CbcNode *x)
 Add a node to the heap.
virtual void pop ()
 Remove the top node from the heap.
virtual CbcNodebestNode (double cutoff)
 Gets best node and takes off heap.
vector methods
virtual bool empty ()
 Test if empty *** note may be overridden.
int size () const
 Return size.
CbcNodeoperator[] (int i) const
 [] operator
CbcNodenodePointer (int i) const
 Return a node pointer.
Search tree maintenance
void cleanTree (CbcModel *model, double cutoff, double &bestPossibleObjective)
 Prune the tree using an objective function cutoff.
CbcNodebestAlternate ()
 Get best on list using alternate method.
virtual void endSearch ()
 We may have got an intelligent tree so give it one more chance.

Protected Attributes

std::vector< CbcNode * > nodes_
CbcCompare comparison_

Detailed Description

Definition at line 16 of file CbcTree.hpp.


Constructor & Destructor Documentation

CbcTree::CbcTree (  ) 

CbcTree::CbcTree ( const CbcTree rhs  ) 

virtual CbcTree::~CbcTree (  )  [virtual]


Member Function Documentation

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

virtual CbcTree* CbcTree::clone (  )  const [virtual]

Clone.

Reimplemented in CbcTreeLocal.

void CbcTree::setComparison ( CbcCompareBase compare  ) 

Set comparison function and resort heap.

virtual CbcNode* CbcTree::top (  )  [virtual]

Return the top node of the heap.

Reimplemented in CbcTreeLocal.

virtual void CbcTree::push ( CbcNode x  )  [virtual]

Add a node to the heap.

Reimplemented in CbcTreeLocal.

virtual void CbcTree::pop (  )  [virtual]

Remove the top node from the heap.

Reimplemented in CbcTreeLocal.

virtual CbcNode* CbcTree::bestNode ( double  cutoff  )  [virtual]

Gets best node and takes off heap.

virtual bool CbcTree::empty (  )  [virtual]

Test if empty *** note may be overridden.

Reimplemented in CbcTreeLocal.

int CbcTree::size (  )  const [inline]

Return size.

Definition at line 58 of file CbcTree.hpp.

References nodes_.

CbcNode* CbcTree::operator[] ( int  i  )  const [inline]

[] operator

Definition at line 62 of file CbcTree.hpp.

References nodes_.

CbcNode* CbcTree::nodePointer ( int  i  )  const [inline]

Return a node pointer.

Definition at line 66 of file CbcTree.hpp.

References nodes_.

void CbcTree::cleanTree ( CbcModel model,
double  cutoff,
double &  bestPossibleObjective 
)

Prune the tree using an objective function cutoff.

This routine removes all nodes with objective worst than the specified cutoff value. It also sets bestPossibleObjective to best of all on tree before deleting.

CbcNode* CbcTree::bestAlternate (  ) 

Get best on list using alternate method.

virtual void CbcTree::endSearch (  )  [inline, virtual]

We may have got an intelligent tree so give it one more chance.

Reimplemented in CbcTreeLocal.

Definition at line 88 of file CbcTree.hpp.


Member Data Documentation

std::vector<CbcNode *> CbcTree::nodes_ [protected]

Definition at line 91 of file CbcTree.hpp.

Referenced by nodePointer(), operator[](), and size().

CbcCompare CbcTree::comparison_ [protected]

Definition at line 92 of file CbcTree.hpp.


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