#include <BonDiver.hpp>
Public Member Functions | |
CbcDiver () | |
Default constructor. | |
CbcDiver (const CbcDiver &rhs) | |
Copy constructor. | |
CbcDiver & | operator= (const CbcDiver &rhs) |
Assignment operator. | |
virtual | ~CbcDiver () |
Destructor. | |
virtual CbcTree * | clone () const |
copy constructor. | |
virtual void | cleanTree (CbcModel *model, double cutoff, double &bestPossibleObjective) |
Prune the tree using an objective function cutoff if nextOnBranch_ exists we push it on the heap and call CbcTree function. | |
virtual double | getBestPossibleObjective () |
Get best possible objective function in the tree. | |
virtual void | endSearch () |
Don't know what this is yet? | |
void | initialize (BabSetupBase &b) |
Initialize the method (get options). | |
Heap access and maintenance methods. | |
virtual CbcNode * | top () const |
Return top node (next node to process.*/. | |
virtual void | push (CbcNode *x) |
Add node to the heap. | |
virtual void | pop () |
Remove the top node of the heap. | |
virtual CbcNode * | bestNode (double cutoff) |
Remove the best node from the heap and return it. | |
vector methods | |
virtual bool | empty () |
Test if empty. | |
virtual int | size () |
Give size of the tree. | |
Static Public Member Functions | |
static void | registerOptions (Ipopt::SmartPtr< Bonmin::RegisteredOptions > roptions) |
Register the options of the method. | |
Private Attributes | |
bool | treeCleaning_ |
Say if we are cleaning the tree (then only call CbcTree functions). | |
CbcNode * | nextOnBranch_ |
Noext node on the branch. | |
bool | stop_diving_on_cutoff_ |
Flag indicating if we want to stop diving based on the guessed objective value and the cutoff value. |
Principle is that branch-and-bound follows current branch of the tree untill it hits the bottom at which point it goes to the best candidate (according to CbcCompare) on the heap.
Definition at line 26 of file BonDiver.hpp.
Bonmin::CbcDiver::CbcDiver | ( | ) |
Bonmin::CbcDiver::CbcDiver | ( | const CbcDiver & | rhs | ) |
Bonmin::CbcDiver::~CbcDiver | ( | ) | [virtual] |
Assignment operator.
Definition at line 39 of file BonDiver.cpp.
References nextOnBranch_, stop_diving_on_cutoff_, and treeCleaning_.
CbcTree * Bonmin::CbcDiver::clone | ( | ) | const [virtual] |
CbcNode * Bonmin::CbcDiver::top | ( | ) | const [virtual] |
Return top node (next node to process.*/.
Definition at line 64 of file BonDiver.cpp.
References nextOnBranch_, and treeCleaning_.
void Bonmin::CbcDiver::push | ( | CbcNode * | x | ) | [virtual] |
Add node to the heap.
Definition at line 77 of file BonDiver.cpp.
References nextOnBranch_, and treeCleaning_.
void Bonmin::CbcDiver::pop | ( | ) | [virtual] |
Remove the top node of the heap.
Definition at line 94 of file BonDiver.cpp.
References nextOnBranch_, and treeCleaning_.
CbcNode * Bonmin::CbcDiver::bestNode | ( | double | cutoff | ) | [virtual] |
Remove the best node from the heap and return it.
Definition at line 107 of file BonDiver.cpp.
References nextOnBranch_, stop_diving_on_cutoff_, and treeCleaning_.
bool Bonmin::CbcDiver::empty | ( | ) | [virtual] |
virtual int Bonmin::CbcDiver::size | ( | ) | [inline, virtual] |
void Bonmin::CbcDiver::cleanTree | ( | CbcModel * | model, | |
double | cutoff, | |||
double & | bestPossibleObjective | |||
) | [virtual] |
Prune the tree using an objective function cutoff if nextOnBranch_ exists we push it on the heap and call CbcTree function.
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.
Definition at line 143 of file BonDiver.cpp.
References nextOnBranch_, and treeCleaning_.
double Bonmin::CbcDiver::getBestPossibleObjective | ( | ) | [virtual] |
Get best possible objective function in the tree.
Definition at line 155 of file BonDiver.cpp.
References nextOnBranch_.
virtual void Bonmin::CbcDiver::endSearch | ( | ) | [inline, virtual] |
void Bonmin::CbcDiver::registerOptions | ( | Ipopt::SmartPtr< Bonmin::RegisteredOptions > | roptions | ) | [static] |
Register the options of the method.
Definition at line 169 of file BonDiver.cpp.
References Bonmin::RegisteredOptions::UndocumentedCategory.
Referenced by Bonmin::BabSetupBase::registerAllOptions().
void Bonmin::CbcDiver::initialize | ( | BabSetupBase & | b | ) |
Initialize the method (get options).
Definition at line 184 of file BonDiver.cpp.
References Bonmin::BabSetupBase::options(), Bonmin::BabSetupBase::prefix(), and stop_diving_on_cutoff_.
bool Bonmin::CbcDiver::treeCleaning_ [private] |
Say if we are cleaning the tree (then only call CbcTree functions).
Definition at line 95 of file BonDiver.hpp.
Referenced by bestNode(), cleanTree(), operator=(), pop(), push(), and top().
CbcNode* Bonmin::CbcDiver::nextOnBranch_ [private] |
Noext node on the branch.
Definition at line 97 of file BonDiver.hpp.
Referenced by bestNode(), cleanTree(), empty(), endSearch(), getBestPossibleObjective(), operator=(), pop(), push(), size(), and top().
bool Bonmin::CbcDiver::stop_diving_on_cutoff_ [private] |
Flag indicating if we want to stop diving based on the guessed objective value and the cutoff value.
Definition at line 100 of file BonDiver.hpp.
Referenced by bestNode(), initialize(), and operator=().