#include <CbcBranchBase.hpp>
Inheritance diagram for CbcBranchDecision:
Public Member Functions | |
CbcBranchDecision () | |
Default Constructor. | |
virtual | ~CbcBranchDecision () |
Destructor. | |
virtual CbcBranchDecision * | clone () const =0 |
Clone. | |
virtual void | initialize (CbcModel *model)=0 |
Initialize e.g. before starting to choose a branch at a node. | |
virtual int | betterBranch (CbcBranchingObject *thisOne, CbcBranchingObject *bestSoFar, double changeUp, int numberInfeasibilitiesUp, double changeDown, int numberInfeasibilitiesDown)=0 |
Compare two branching objects. | |
virtual int | bestBranch (CbcBranchingObject **objects, int numberObjects, int numberUnsatisfied, double *changeUp, int *numberInfeasibilitiesUp, double *changeDown, int *numberInfeasibilitiesDown, double objectiveValue) |
Compare N branching objects. | |
virtual int | whichMethod () |
Says whether this method can handle both methods - 1 better, 2 best, 3 both. | |
virtual void | saveBranchingObject (CbcBranchingObject *object) |
Saves a clone of current branching object. | |
virtual void | updateInformation (OsiSolverInterface *solver, const CbcNode *node) |
Pass in information on branch just done. | |
virtual void | setBestCriterion (double value) |
Sets or gets best criterion so far. | |
virtual double | getBestCriterion () const |
virtual void | generateCpp (FILE *fp) |
Create C++ lines to get to current state. | |
Protected Attributes | |
CbcBranchingObject * | object_ |
Private Member Functions | |
CbcBranchDecision & | operator= (const CbcBranchDecision &rhs) |
Assignment is illegal. |
In the abstract, an CbcBranchDecision object is expected to be able to compare two possible branching choices.
The betterBranch() method is the crucial routine. It is expected to be able to compare two CbcBranchingObjects .
See CbcObject for an overview of the three classes (CbcObject, CbcBranchingObject, and CbcBranchDecision) which make up cbc's branching model.
Definition at line 370 of file CbcBranchBase.hpp.
CbcBranchDecision::CbcBranchDecision | ( | ) |
Default Constructor.
virtual CbcBranchDecision::~CbcBranchDecision | ( | ) | [virtual] |
Destructor.
virtual CbcBranchDecision* CbcBranchDecision::clone | ( | ) | const [pure virtual] |
Clone.
Implemented in CbcBranchUserDecision, CbcBranchDefaultDecision, and CbcBranchDynamicDecision.
virtual void CbcBranchDecision::initialize | ( | CbcModel * | model | ) | [pure virtual] |
Initialize e.g. before starting to choose a branch at a node.
Implemented in CbcBranchUserDecision, CbcBranchDefaultDecision, and CbcBranchDynamicDecision.
virtual int CbcBranchDecision::betterBranch | ( | CbcBranchingObject * | thisOne, | |
CbcBranchingObject * | bestSoFar, | |||
double | changeUp, | |||
int | numberInfeasibilitiesUp, | |||
double | changeDown, | |||
int | numberInfeasibilitiesDown | |||
) | [pure virtual] |
Compare two branching objects.
Return nonzero if branching using thisOne
is better than branching using bestSoFar
.
If bestSoFar
is NULL, the routine should return a nonzero value. This routine is used only after strong branching. Either this or bestBranch is used depending which user wants.
Implemented in CbcBranchUserDecision, CbcBranchDefaultDecision, and CbcBranchDynamicDecision.
virtual int CbcBranchDecision::bestBranch | ( | CbcBranchingObject ** | objects, | |
int | numberObjects, | |||
int | numberUnsatisfied, | |||
double * | changeUp, | |||
int * | numberInfeasibilitiesUp, | |||
double * | changeDown, | |||
int * | numberInfeasibilitiesDown, | |||
double | objectiveValue | |||
) | [virtual] |
Compare N branching objects.
Return index of best and sets way of branching in chosen object.
Either this or betterBranch is used depending which user wants.
Reimplemented in CbcBranchUserDecision, and CbcBranchDefaultDecision.
virtual int CbcBranchDecision::whichMethod | ( | ) | [inline, virtual] |
Says whether this method can handle both methods - 1 better, 2 best, 3 both.
Reimplemented in CbcBranchDynamicDecision.
Definition at line 413 of file CbcBranchBase.hpp.
virtual void CbcBranchDecision::saveBranchingObject | ( | CbcBranchingObject * | object | ) | [inline, virtual] |
Saves a clone of current branching object.
Can be used to update information on object causing branch - after branch
Reimplemented in CbcBranchDynamicDecision.
Definition at line 417 of file CbcBranchBase.hpp.
virtual void CbcBranchDecision::updateInformation | ( | OsiSolverInterface * | solver, | |
const CbcNode * | node | |||
) | [inline, virtual] |
Pass in information on branch just done.
assumes object can get information from solver
Reimplemented in CbcBranchDynamicDecision.
Definition at line 420 of file CbcBranchBase.hpp.
virtual void CbcBranchDecision::setBestCriterion | ( | double | value | ) | [inline, virtual] |
Sets or gets best criterion so far.
Reimplemented in CbcBranchDefaultDecision, and CbcBranchDynamicDecision.
Definition at line 423 of file CbcBranchBase.hpp.
virtual double CbcBranchDecision::getBestCriterion | ( | ) | const [inline, virtual] |
Reimplemented in CbcBranchDefaultDecision, and CbcBranchDynamicDecision.
Definition at line 424 of file CbcBranchBase.hpp.
virtual void CbcBranchDecision::generateCpp | ( | FILE * | fp | ) | [inline, virtual] |
CbcBranchDecision& CbcBranchDecision::operator= | ( | const CbcBranchDecision & | rhs | ) | [private] |
Assignment is illegal.
CbcBranchingObject* CbcBranchDecision::object_ [protected] |
Definition at line 426 of file CbcBranchBase.hpp.