Bonmin::Bab Class Reference

#include <BonCbc.hpp>

Collaboration diagram for Bonmin::Bab:

Collaboration graph
[legend]
List of all members.

Public Types

 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.
 NoSolutionKnown
 No feasible solution to the problem is known.
enum  MipStatuses { FeasibleOptimal, ProvenInfeasible, Feasible, NoSolutionKnown }
 Integer optimization return codes. More...

Public Member Functions

 Bab ()
 Constructor.
virtual ~Bab ()
 destructor.
virtual void branchAndBound (BabSetupBase &s)
 Perform a branch-and-bound on given IpoptInterface using passed parameters.
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 CbcModelmodel () const
 Get cbc model used to solve.
CbcModelmodel ()
 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.
CoinMessageHandlermodelHandler_
 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

enum Bonmin::Bab::MipStatuses

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.
NoSolutionKnown  No feasible solution to the problem is known.

Definition at line 23 of file BonCbc.hpp.


Constructor & Destructor Documentation

Bonmin::Bab::Bab (  ) 

Constructor.

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

destructor.


Member Function Documentation

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

Perform a branch-and-bound on given IpoptInterface using passed parameters.

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

operator() performs the branchAndBound

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.

Definition at line 39 of file BonCbc.hpp.

References bestSolution_.

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

return objective value of the bestSolution

Definition at line 44 of file BonCbc.hpp.

References bestObj_.

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

return Mip Status

Definition at line 50 of file BonCbc.hpp.

References mipStatus_.

double Bonmin::Bab::bestBound (  ) 

return the best known lower bound on the objective value

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

return the total number of nodes explored.

Definition at line 57 of file BonCbc.hpp.

References numNodes_.

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

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

Definition at line 62 of file BonCbc.hpp.

References mipIterationCount_.

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

returns the value of the continuous relaxation.

Definition at line 67 of file BonCbc.hpp.

References continuousRelaxation_.

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 74 of file BonCbc.hpp.

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

Get cbc model used to solve.

Definition at line 77 of file BonCbc.hpp.

References model_.

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 84 of file BonCbc.hpp.

References model_.

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

Say that algorithm is using Couenne.

Definition at line 89 of file BonCbc.hpp.

References usingCouenne_.

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

Get value of usingCouenne variable.

Definition at line 95 of file BonCbc.hpp.

References usingCouenne_.


Member Data Documentation

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

Stores the solution of MIP.

Definition at line 101 of file BonCbc.hpp.

Referenced by bestSolution().

MipStatuses Bonmin::Bab::mipStatus_ [protected]

Status of the mip solved.

Definition at line 104 of file BonCbc.hpp.

Referenced by mipStatus().

double Bonmin::Bab::bestObj_ [protected]

objValue of MIP

Definition at line 106 of file BonCbc.hpp.

Referenced by bestObj().

double Bonmin::Bab::bestBound_ [protected]

best known (lower) bound.

Definition at line 108 of file BonCbc.hpp.

double Bonmin::Bab::continuousRelaxation_ [protected]

Continuous relaxation of the problem.

Definition at line 110 of file BonCbc.hpp.

Referenced by continuousRelaxation().

int Bonmin::Bab::numNodes_ [protected]

Number of nodes enumerated.

Definition at line 112 of file BonCbc.hpp.

Referenced by numNodes().

int Bonmin::Bab::mipIterationCount_ [protected]

get total number of iterations in last mip solved.

Definition at line 114 of file BonCbc.hpp.

Referenced by iterationCount().

CbcModel Bonmin::Bab::model_ [protected]

CbcModel used to solve problem.

Definition at line 116 of file BonCbc.hpp.

Referenced by model().

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

Message handler for CbcModel.

Definition at line 118 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 122 of file BonCbc.hpp.

int Bonmin::Bab::nObjects_ [protected]

number of objects.

Definition at line 124 of file BonCbc.hpp.

bool Bonmin::Bab::usingCouenne_ [protected]

Say if current algorithm is Couenne.

Definition at line 127 of file BonCbc.hpp.

Referenced by getUsingCouenne(), and setUsingCouenne().


The documentation for this class was generated from the following file:
Generated on Thu Jun 26 03:20:49 2008 for Bonmin by  doxygen 1.4.7