Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
Couenne::CouenneBranchingObject Class Reference

"Spatial" branching object. More...

#include <CouenneBranchingObject.hpp>

Inheritance diagram for Couenne::CouenneBranchingObject:
Inheritance graph
[legend]
Collaboration diagram for Couenne::CouenneBranchingObject:
Collaboration graph
[legend]

Public Member Functions

 CouenneBranchingObject (OsiSolverInterface *solver, const OsiObject *originalObject, JnlstPtr jnlst, CouenneCutGenerator *c, CouenneProblem *p, expression *var, int way, CouNumber brpoint, bool doFBBT, bool doConvCuts)
 Constructor. More...
 
 CouenneBranchingObject (const CouenneBranchingObject &src)
 Copy constructor. More...
 
virtual OsiBranchingObject * clone () const
 cloning method More...
 
virtual double branch (OsiSolverInterface *solver=NULL)
 Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
 
virtual bool boundBranch () const
 does this branching object only change variable bounds? More...
 
void setSimulate (bool s)
 set simulate_ field below More...
 
expressionvariable ()
 return branching variable More...
 
void branchCore (OsiSolverInterface *, int, int, bool, double, t_chg_bounds *&)
 Perform branching step. More...
 

Static Public Attributes

static int nOrbBr = 0
 
static int maxDepthOrbBranch = -1
 
static int nSGcomputations = 0
 

Protected Attributes

CouenneCutGeneratorcutGen_
 Pointer to CouenneCutGenerator (if any); if not NULL, allows to do extra cut generation during branching. More...
 
CouenneProblemproblem_
 Pointer to CouenneProblem (necessary to allow FBBT) More...
 
expressionvariable_
 The index of the variable this branching object refers to. More...
 
JnlstPtr jnlst_
 SmartPointer to the Journalist. More...
 
bool doFBBT_
 shall we do Feasibility based Bound Tightening (FBBT) at branching? More...
 
bool doConvCuts_
 shall we add convexification cuts at branching? More...
 
double downEstimate_
 down branch estimate (done at selectBranch with reduced costs) More...
 
double upEstimate_
 up branch estimate More...
 
bool simulate_
 are we currently in strong branching? More...
 

Detailed Description

"Spatial" branching object.

Branching can also be performed on continuous variables.

Definition at line 37 of file CouenneBranchingObject.hpp.

Constructor & Destructor Documentation

CouenneBranchingObject::CouenneBranchingObject ( OsiSolverInterface *  solver,
const OsiObject *  originalObject,
JnlstPtr  jnlst,
CouenneCutGenerator cutGen,
CouenneProblem problem,
expression var,
int  way,
CouNumber  brpoint,
bool  doFBBT,
bool  doConvCuts 
)

Constructor.

Get a variable as an argument and set value_ through a call to operator () of that exprAux.

Definition at line 35 of file CouenneBranchingObject.cpp.

Couenne::CouenneBranchingObject::CouenneBranchingObject ( const CouenneBranchingObject src)
inline

Copy constructor.

Definition at line 54 of file CouenneBranchingObject.hpp.

Member Function Documentation

virtual OsiBranchingObject* Couenne::CouenneBranchingObject::clone ( ) const
inlinevirtual

cloning method

Reimplemented in Couenne::CouenneOrbitBranchingObj, and Couenne::CouenneComplBranchingObject.

Definition at line 68 of file CouenneBranchingObject.hpp.

double CouenneBranchingObject::branch ( OsiSolverInterface *  solver = NULL)
virtual

Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state.

Returns change in guessed objective on next branch

Reimplemented in Couenne::CouenneOrbitBranchingObj, and Couenne::CouenneComplBranchingObject.

Definition at line 107 of file CouenneBranchingObject.cpp.

virtual bool Couenne::CouenneBranchingObject::boundBranch ( ) const
inlinevirtual

does this branching object only change variable bounds?

Reimplemented in Couenne::CouenneOrbitBranchingObj.

Definition at line 79 of file CouenneBranchingObject.hpp.

void Couenne::CouenneBranchingObject::setSimulate ( bool  s)
inline

set simulate_ field below

Definition at line 83 of file CouenneBranchingObject.hpp.

expression* Couenne::CouenneBranchingObject::variable ( )
inline

return branching variable

Definition at line 87 of file CouenneBranchingObject.hpp.

void CouenneBranchingObject::branchCore ( OsiSolverInterface *  solver,
int  indVar,
int  way,
bool  integer,
double  brpt,
t_chg_bounds *&  chg_bds 
)

Perform branching step.

Execute the core of the branch — need to separate code because of include conflicts with other packages' config_*.h.

only perform orbital branching if

1) Nauty has been made available through configure 2) The orbital_branching option has been set to yes

plain (non-orbital) branching

Definition at line 29 of file BranchCore.cpp.

Member Data Documentation

int CouenneBranchingObject::nOrbBr = 0
static

Definition at line 94 of file CouenneBranchingObject.hpp.

int CouenneBranchingObject::maxDepthOrbBranch = -1
static

Definition at line 95 of file CouenneBranchingObject.hpp.

int CouenneBranchingObject::nSGcomputations = 0
static

Definition at line 96 of file CouenneBranchingObject.hpp.

CouenneCutGenerator* Couenne::CouenneBranchingObject::cutGen_
protected

Pointer to CouenneCutGenerator (if any); if not NULL, allows to do extra cut generation during branching.

Definition at line 102 of file CouenneBranchingObject.hpp.

CouenneProblem* Couenne::CouenneBranchingObject::problem_
protected

Pointer to CouenneProblem (necessary to allow FBBT)

Definition at line 105 of file CouenneBranchingObject.hpp.

expression* Couenne::CouenneBranchingObject::variable_
protected

The index of the variable this branching object refers to.

If the corresponding CouenneObject was created on w=f(x,y), it is either x or y, chosen previously with a call to getFixVar() expression *reference_;

Definition at line 111 of file CouenneBranchingObject.hpp.

JnlstPtr Couenne::CouenneBranchingObject::jnlst_
protected

SmartPointer to the Journalist.

Definition at line 114 of file CouenneBranchingObject.hpp.

bool Couenne::CouenneBranchingObject::doFBBT_
protected

shall we do Feasibility based Bound Tightening (FBBT) at branching?

Definition at line 117 of file CouenneBranchingObject.hpp.

bool Couenne::CouenneBranchingObject::doConvCuts_
protected

shall we add convexification cuts at branching?

Definition at line 120 of file CouenneBranchingObject.hpp.

double Couenne::CouenneBranchingObject::downEstimate_
protected

down branch estimate (done at selectBranch with reduced costs)

Definition at line 123 of file CouenneBranchingObject.hpp.

double Couenne::CouenneBranchingObject::upEstimate_
protected

up branch estimate

Definition at line 126 of file CouenneBranchingObject.hpp.

bool Couenne::CouenneBranchingObject::simulate_
protected

are we currently in strong branching?

Definition at line 129 of file CouenneBranchingObject.hpp.


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