Public Member Functions | Private Attributes
CbcTreeLocal Class Reference

#include <CbcTreeLocal.hpp>

Inheritance diagram for CbcTreeLocal:
CbcTree CbcTree

List of all members.

Public Member Functions

 CbcTreeLocal ()
 CbcTreeLocal (CbcModel *model, const double *solution, int range=10, int typeCuts=0, int maxDiversification=0, int timeLimit=1000000, int nodeLimit=1000000, bool refine=true)
 CbcTreeLocal (const CbcTreeLocal &rhs)
CbcTreeLocaloperator= (const CbcTreeLocal &rhs)
virtual ~CbcTreeLocal ()
virtual CbcTreeclone () const
 Clone.
virtual void generateCpp (FILE *fp)
 Create C++ lines to get to current state.
 CbcTreeLocal ()
 CbcTreeLocal (CbcModel *model, const double *solution, int range=10, int typeCuts=0, int maxDiversification=0, int timeLimit=1000000, int nodeLimit=1000000, bool refine=true)
 CbcTreeLocal (const CbcTreeLocal &rhs)
CbcTreeLocaloperator= (const CbcTreeLocal &rhs)
virtual ~CbcTreeLocal ()
virtual CbcTreeclone () const
 Clone.
virtual void generateCpp (FILE *fp)
 Create C++ lines to get to current state.
Heap access and maintenance methods
virtual CbcNodetop () const
 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 CbcNodetop () const
 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.
Other stuff
int createCut (const double *solution, OsiRowCut &cut)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
virtual bool empty ()
 Test if empty *** note may be overridden.
virtual void endSearch ()
 We may have got an intelligent tree so give it one more chance.
void reverseCut (int state, double bias=0.0)
 Other side of last cut branch (if bias==rhs_ will be weakest possible)
void deleteCut (OsiRowCut &cut)
 Delete last cut branch.
void passInSolution (const double *solution, double solutionValue)
 Pass in solution (so can be used after heuristic)
int range () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setRange (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int typeCuts () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setTypeCuts (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int maxDiversification () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setMaxDiversification (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int timeLimit () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setTimeLimit (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int nodeLimit () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setNodeLimit (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
bool refine () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setRefine (bool yesNo)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int createCut (const double *solution, OsiRowCut &cut)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
virtual bool empty ()
 Test if empty *** note may be overridden.
virtual void endSearch ()
 We may have got an intelligent tree so give it one more chance.
void reverseCut (int state, double bias=0.0)
 Other side of last cut branch (if bias==rhs_ will be weakest possible)
void deleteCut (OsiRowCut &cut)
 Delete last cut branch.
void passInSolution (const double *solution, double solutionValue)
 Pass in solution (so can be used after heuristic)
int range () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setRange (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int typeCuts () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setTypeCuts (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int maxDiversification () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setMaxDiversification (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int timeLimit () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setTimeLimit (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
int nodeLimit () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setNodeLimit (int value)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
bool refine () const
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
void setRefine (bool yesNo)
 Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.
- Public Member Functions inherited from CbcTree
 CbcTree ()
 CbcTree (const CbcTree &rhs)
CbcTreeoperator= (const CbcTree &rhs)
virtual ~CbcTree ()
 CbcTree ()
 CbcTree (const CbcTree &rhs)
CbcTreeoperator= (const CbcTree &rhs)
virtual ~CbcTree ()
void setComparison (CbcCompareBase &compare)
 Set comparison function and resort heap.
virtual CbcNodebestNode (double cutoff)
 Gets best node and takes off heap.
void setComparison (CbcCompareBase &compare)
 Set comparison function and resort heap.
virtual CbcNodebestNode (double cutoff)
 Gets best node and takes off heap.
virtual int size () const
 Return size.
CbcNodeoperator[] (int i) const
 [] operator
CbcNodenodePointer (int i) const
 Return a node pointer.
virtual int size () const
 Return size.
CbcNodeoperator[] (int i) const
 [] operator
CbcNodenodePointer (int i) const
 Return a node pointer.
virtual 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 double getBestPossibleObjective ()
 Get best possible objective function in the tree.
void resetNodeNumbers ()
 Reset maximum node number.
int maximumNodeNumber () const
 Get maximum node number.
void setNumberBranching (int value)
 Set number of branches.
int getNumberBranching () const
 Get number of branches.
void setMaximumBranching (int value)
 Set maximum branches.
int getMaximumBranching () const
 Get maximum branches.
unsigned int * branched () const
 Get branched variables.
int * newBounds () const
 Get bounds.
void addBranchingInformation (const CbcModel *model, const CbcNodeInfo *nodeInfo, const double *currentLower, const double *currentUpper)
 Adds branching information to complete state.
void increaseSpace ()
 Increase space for data.
virtual 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 double getBestPossibleObjective ()
 Get best possible objective function in the tree.
void resetNodeNumbers ()
 Reset maximum node number.
int maximumNodeNumber () const
 Get maximum node number.
void setNumberBranching (int value)
 Set number of branches.
int getNumberBranching () const
 Get number of branches.
void setMaximumBranching (int value)
 Set maximum branches.
int getMaximumBranching () const
 Get maximum branches.
unsigned int * branched () const
 Get branched variables.
int * newBounds () const
 Get bounds.
void addBranchingInformation (const CbcModel *model, const CbcNodeInfo *nodeInfo, const double *currentLower, const double *currentUpper)
 Adds branching information to complete state.
void increaseSpace ()
 Increase space for data.

Private Attributes

CbcNodelocalNode_
double * bestSolution_
double * savedSolution_
int saveNumberSolutions_
OsiRowCut cut_
OsiRowCut fixedCut_
CbcModelmodel_
double * originalLower_
double * originalUpper_
int range_
int typeCuts_
int maxDiversification_
int diversification_
bool nextStrong_
double rhs_
double savedGap_
double bestCutoff_
int timeLimit_
int startTime_
int nodeLimit_
int startNode_
int searchType_
bool refine_

Additional Inherited Members

- Protected Attributes inherited from CbcTree
std::vector< CbcNode * > nodes_
CbcCompare comparison_
int maximumNodeNumber_
 

Sort function for heap ordering.


int numberBranching_
 Size of variable list.
int maximumBranching_
 Maximum size of variable list.
unsigned int * branched_
 Integer variables branched or bounded top bit set if new upper bound next bit set if a branch.
int * newBound_
 New bound.

Detailed Description

Definition at line 38 of file CbcTreeLocal.hpp.


Constructor & Destructor Documentation

CbcTreeLocal::CbcTreeLocal ( )
CbcTreeLocal::CbcTreeLocal ( CbcModel model,
const double *  solution,
int  range = 10,
int  typeCuts = 0,
int  maxDiversification = 0,
int  timeLimit = 1000000,
int  nodeLimit = 1000000,
bool  refine = true 
)
CbcTreeLocal::CbcTreeLocal ( const CbcTreeLocal rhs)
virtual CbcTreeLocal::~CbcTreeLocal ( )
virtual
CbcTreeLocal::CbcTreeLocal ( )
CbcTreeLocal::CbcTreeLocal ( CbcModel model,
const double *  solution,
int  range = 10,
int  typeCuts = 0,
int  maxDiversification = 0,
int  timeLimit = 1000000,
int  nodeLimit = 1000000,
bool  refine = true 
)
CbcTreeLocal::CbcTreeLocal ( const CbcTreeLocal rhs)
virtual CbcTreeLocal::~CbcTreeLocal ( )
virtual

Member Function Documentation

CbcTreeLocal& CbcTreeLocal::operator= ( const CbcTreeLocal rhs)
virtual CbcTree* CbcTreeLocal::clone ( ) const
virtual

Clone.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::generateCpp ( FILE *  fp)
virtual

Create C++ lines to get to current state.

Reimplemented from CbcTree.

virtual CbcNode* CbcTreeLocal::top ( ) const
virtual

Return the top node of the heap.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::push ( CbcNode x)
virtual

Add a node to the heap.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::pop ( )
virtual

Remove the top node from the heap.

Reimplemented from CbcTree.

int CbcTreeLocal::createCut ( const double *  solution,
OsiRowCut &  cut 
)

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

virtual bool CbcTreeLocal::empty ( )
virtual

Test if empty *** note may be overridden.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::endSearch ( )
virtual

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

Reimplemented from CbcTree.

void CbcTreeLocal::reverseCut ( int  state,
double  bias = 0.0 
)

Other side of last cut branch (if bias==rhs_ will be weakest possible)

void CbcTreeLocal::deleteCut ( OsiRowCut &  cut)

Delete last cut branch.

void CbcTreeLocal::passInSolution ( const double *  solution,
double  solutionValue 
)

Pass in solution (so can be used after heuristic)

int CbcTreeLocal::range ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 105 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setRange ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 109 of file CbcTreeLocal.hpp.

int CbcTreeLocal::typeCuts ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 113 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setTypeCuts ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 117 of file CbcTreeLocal.hpp.

int CbcTreeLocal::maxDiversification ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 121 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setMaxDiversification ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 125 of file CbcTreeLocal.hpp.

int CbcTreeLocal::timeLimit ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 129 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setTimeLimit ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 133 of file CbcTreeLocal.hpp.

int CbcTreeLocal::nodeLimit ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 137 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setNodeLimit ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 141 of file CbcTreeLocal.hpp.

bool CbcTreeLocal::refine ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 145 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setRefine ( bool  yesNo)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 149 of file CbcTreeLocal.hpp.

CbcTreeLocal& CbcTreeLocal::operator= ( const CbcTreeLocal rhs)
virtual CbcTree* CbcTreeLocal::clone ( ) const
virtual

Clone.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::generateCpp ( FILE *  fp)
virtual

Create C++ lines to get to current state.

Reimplemented from CbcTree.

virtual CbcNode* CbcTreeLocal::top ( ) const
virtual

Return the top node of the heap.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::push ( CbcNode x)
virtual

Add a node to the heap.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::pop ( )
virtual

Remove the top node from the heap.

Reimplemented from CbcTree.

int CbcTreeLocal::createCut ( const double *  solution,
OsiRowCut &  cut 
)

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

virtual bool CbcTreeLocal::empty ( )
virtual

Test if empty *** note may be overridden.

Reimplemented from CbcTree.

virtual void CbcTreeLocal::endSearch ( )
virtual

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

Reimplemented from CbcTree.

void CbcTreeLocal::reverseCut ( int  state,
double  bias = 0.0 
)

Other side of last cut branch (if bias==rhs_ will be weakest possible)

void CbcTreeLocal::deleteCut ( OsiRowCut &  cut)

Delete last cut branch.

void CbcTreeLocal::passInSolution ( const double *  solution,
double  solutionValue 
)

Pass in solution (so can be used after heuristic)

int CbcTreeLocal::range ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 105 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setRange ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 109 of file CbcTreeLocal.hpp.

int CbcTreeLocal::typeCuts ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 113 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setTypeCuts ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 117 of file CbcTreeLocal.hpp.

int CbcTreeLocal::maxDiversification ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 121 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setMaxDiversification ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 125 of file CbcTreeLocal.hpp.

int CbcTreeLocal::timeLimit ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 129 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setTimeLimit ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 133 of file CbcTreeLocal.hpp.

int CbcTreeLocal::nodeLimit ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 137 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setNodeLimit ( int  value)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 141 of file CbcTreeLocal.hpp.

bool CbcTreeLocal::refine ( ) const
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 145 of file CbcTreeLocal.hpp.

void CbcTreeLocal::setRefine ( bool  yesNo)
inline

Create cut - return -1 if bad, 0 if okay and 1 if cut is everything.

Definition at line 149 of file CbcTreeLocal.hpp.


Member Data Documentation

CbcNode * CbcTreeLocal::localNode_
private

Definition at line 156 of file CbcTreeLocal.hpp.

double * CbcTreeLocal::bestSolution_
private

Definition at line 158 of file CbcTreeLocal.hpp.

double * CbcTreeLocal::savedSolution_
private

Definition at line 160 of file CbcTreeLocal.hpp.

int CbcTreeLocal::saveNumberSolutions_
private

Definition at line 162 of file CbcTreeLocal.hpp.

OsiRowCut CbcTreeLocal::cut_
private

Definition at line 164 of file CbcTreeLocal.hpp.

OsiRowCut CbcTreeLocal::fixedCut_
private

Definition at line 166 of file CbcTreeLocal.hpp.

CbcModel * CbcTreeLocal::model_
private

Definition at line 168 of file CbcTreeLocal.hpp.

double * CbcTreeLocal::originalLower_
private

Definition at line 170 of file CbcTreeLocal.hpp.

double * CbcTreeLocal::originalUpper_
private

Definition at line 172 of file CbcTreeLocal.hpp.

int CbcTreeLocal::range_
private

Definition at line 174 of file CbcTreeLocal.hpp.

int CbcTreeLocal::typeCuts_
private

Definition at line 176 of file CbcTreeLocal.hpp.

int CbcTreeLocal::maxDiversification_
private

Definition at line 178 of file CbcTreeLocal.hpp.

int CbcTreeLocal::diversification_
private

Definition at line 180 of file CbcTreeLocal.hpp.

bool CbcTreeLocal::nextStrong_
private

Definition at line 182 of file CbcTreeLocal.hpp.

double CbcTreeLocal::rhs_
private

Definition at line 184 of file CbcTreeLocal.hpp.

double CbcTreeLocal::savedGap_
private

Definition at line 186 of file CbcTreeLocal.hpp.

double CbcTreeLocal::bestCutoff_
private

Definition at line 188 of file CbcTreeLocal.hpp.

int CbcTreeLocal::timeLimit_
private

Definition at line 190 of file CbcTreeLocal.hpp.

int CbcTreeLocal::startTime_
private

Definition at line 192 of file CbcTreeLocal.hpp.

int CbcTreeLocal::nodeLimit_
private

Definition at line 194 of file CbcTreeLocal.hpp.

int CbcTreeLocal::startNode_
private

Definition at line 196 of file CbcTreeLocal.hpp.

int CbcTreeLocal::searchType_
private

Definition at line 198 of file CbcTreeLocal.hpp.

bool CbcTreeLocal::refine_
private

Definition at line 200 of file CbcTreeLocal.hpp.


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