Bonmin::Bab Class Reference

#include <BonCbc.hpp>

Inheritance diagram for Bonmin::Bab:
Inheritance graph
[legend]

List of all members.

Public Types

enum  MipStatuses {
  FeasibleOptimal, ProvenInfeasible, Feasible, UnboundedOrInfeasible,
  NoSolutionKnown, NumMipStats
}
 

Integer optimization return codes.

More...

Public Member Functions

 Bab ()
 Constructor.
virtual ~Bab ()
 destructor.
virtual void branchAndBound (BabSetupBase &s)
 Perform a branch-and-bound using given setup.
virtual void operator() (BabSetupBase &s)
 operator() performs the branchAndBound
virtual void operator() (BabSetupBase *s)
 operator() performs the branchAndBound
const double * bestSolution () const
 get the best solution known to the problem (is optimal if MipStatus is FeasibleOptimal).
double bestObj () const
 return objective value of the bestSolution
MipStatuses mipStatus () const
 return Mip Status
double bestBound ()
 return the best known lower bound on the objective value
int numNodes () const
 return the total number of nodes explored.
int iterationCount ()
 return the total number of iterations in the last mip solved.
double continuousRelaxation ()
 returns the value of the continuous relaxation.
virtual void replaceIntegers (OsiObject **objects, int numberObjects)
 virtual callback function to eventually modify objects for integer variable (replace with user set).
const CbcModel & model () const
 Get cbc model used to solve.
CbcModel & model ()
 Get cbc model used to solve as non-const, in case we want to change options before things happen.
void setUsingCouenne (bool v)
 Say that algorithm is using Couenne.
bool getUsingCouenne ()
 Get value of usingCouenne variable.

Protected Attributes

double * bestSolution_
 Stores the solution of MIP.
MipStatuses mipStatus_
 Status of the mip solved.
double bestObj_
 objValue of MIP
double bestBound_
 best known (lower) bound.
double continuousRelaxation_
 Continuous relaxation of the problem.
int numNodes_
 Number of nodes enumerated.
int mipIterationCount_
 get total number of iterations in last mip solved.
CbcModel model_
 CbcModel used to solve problem.
CoinMessageHandler * modelHandler_
 Message handler for CbcModel.
OsiObject ** objects_
 OsiObjects of the model.
int nObjects_
 number of objects.
bool usingCouenne_
 Say if current algorithm is Couenne.

Detailed Description

Definition at line 19 of file BonCbc.hpp.


Member Enumeration Documentation

Integer optimization return codes.

Enumerator:
FeasibleOptimal 

Optimum solution has been found and its optimality proved.

ProvenInfeasible 

Problem has been proven to be infeasible.

Feasible 

An integer solution to the problem has been found.

UnboundedOrInfeasible 
NoSolutionKnown 

No feasible solution to the problem is known.

NumMipStats 

Definition at line 23 of file BonCbc.hpp.


Constructor & Destructor Documentation

Bonmin::Bab::Bab (  ) 

Constructor.

Definition at line 69 of file BonCbc.cpp.

Bonmin::Bab::~Bab (  )  [virtual]

destructor.

Destructor.

Definition at line 85 of file BonCbc.cpp.


Member Function Documentation

void Bonmin::Bab::branchAndBound ( BabSetupBase s  )  [virtual]

Perform a branch-and-bound using given setup.

Perform a branch-and-bound on given setup.

Reimplemented in Couenne::CouenneBab.

Definition at line 105 of file BonCbc.cpp.

void Bonmin::Bab::operator() ( BabSetupBase s  )  [virtual]

operator() performs the branchAndBound

Definition at line 98 of file BonCbc.cpp.

virtual void Bonmin::Bab::operator() ( BabSetupBase s  )  [inline, virtual]

operator() performs the branchAndBound

Definition at line 42 of file BonCbc.hpp.

const double* Bonmin::Bab::bestSolution (  )  const [inline]

get the best solution known to the problem (is optimal if MipStatus is FeasibleOptimal).

if no solution is known returns NULL.

Reimplemented in Couenne::CouenneBab.

Definition at line 47 of file BonCbc.hpp.

double Bonmin::Bab::bestObj (  )  const [inline]

return objective value of the bestSolution

Reimplemented in Couenne::CouenneBab.

Definition at line 52 of file BonCbc.hpp.

MipStatuses Bonmin::Bab::mipStatus (  )  const [inline]

return Mip Status

Definition at line 58 of file BonCbc.hpp.

double Bonmin::Bab::bestBound (  ) 

return the best known lower bound on the objective value

Definition at line 676 of file BonCbc.cpp.

int Bonmin::Bab::numNodes (  )  const [inline]

return the total number of nodes explored.

Definition at line 66 of file BonCbc.hpp.

int Bonmin::Bab::iterationCount (  )  [inline]

return the total number of iterations in the last mip solved.

Definition at line 71 of file BonCbc.hpp.

double Bonmin::Bab::continuousRelaxation (  )  [inline]

returns the value of the continuous relaxation.

Definition at line 76 of file BonCbc.hpp.

virtual void Bonmin::Bab::replaceIntegers ( OsiObject **  objects,
int  numberObjects 
) [inline, virtual]

virtual callback function to eventually modify objects for integer variable (replace with user set).

This is called after CbcModel::findIntegers

Definition at line 83 of file BonCbc.hpp.

const CbcModel& Bonmin::Bab::model (  )  const [inline]

Get cbc model used to solve.

Definition at line 86 of file BonCbc.hpp.

CbcModel& Bonmin::Bab::model (  )  [inline]

Get cbc model used to solve as non-const, in case we want to change options before things happen.

Definition at line 93 of file BonCbc.hpp.

void Bonmin::Bab::setUsingCouenne ( bool  v  )  [inline]

Say that algorithm is using Couenne.

Definition at line 98 of file BonCbc.hpp.

bool Bonmin::Bab::getUsingCouenne (  )  [inline]

Get value of usingCouenne variable.

Definition at line 104 of file BonCbc.hpp.


Member Data Documentation

double* Bonmin::Bab::bestSolution_ [protected]

Stores the solution of MIP.

Definition at line 110 of file BonCbc.hpp.

Status of the mip solved.

Definition at line 113 of file BonCbc.hpp.

double Bonmin::Bab::bestObj_ [protected]

objValue of MIP

Definition at line 115 of file BonCbc.hpp.

double Bonmin::Bab::bestBound_ [protected]

best known (lower) bound.

Definition at line 117 of file BonCbc.hpp.

Continuous relaxation of the problem.

Definition at line 119 of file BonCbc.hpp.

int Bonmin::Bab::numNodes_ [protected]

Number of nodes enumerated.

Definition at line 121 of file BonCbc.hpp.

get total number of iterations in last mip solved.

Definition at line 123 of file BonCbc.hpp.

CbcModel Bonmin::Bab::model_ [protected]

CbcModel used to solve problem.

Definition at line 125 of file BonCbc.hpp.

CoinMessageHandler* Bonmin::Bab::modelHandler_ [protected]

Message handler for CbcModel.

Definition at line 127 of file BonCbc.hpp.

OsiObject** Bonmin::Bab::objects_ [protected]

OsiObjects of the model.

this is not null if and only if there are some non-simple-integer branching objects such as SOS constraints. It is up to Bab to pass them over to appropriate components of the algorithm.

Definition at line 131 of file BonCbc.hpp.

int Bonmin::Bab::nObjects_ [protected]

number of objects.

Definition at line 133 of file BonCbc.hpp.

bool Bonmin::Bab::usingCouenne_ [protected]

Say if current algorithm is Couenne.

Definition at line 136 of file BonCbc.hpp.


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

Generated on 16 Feb 2012 by  doxygen 1.6.1