Couenne 0.5.8
Loading...
Searching...
No Matches
Couenne::CouenneBranchingObject Class Reference

"Spatial" branching object. More...

#include <CouenneBranchingObject.hpp>

+ Inheritance diagram for Couenne::CouenneBranchingObject:
+ Collaboration diagram for Couenne::CouenneBranchingObject:

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.
 
 CouenneBranchingObject (const CouenneBranchingObject &src)
 Copy constructor.
 
virtual OsiBranchingObjectclone () const
 cloning method
 
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.
 
virtual bool boundBranch () const
 does this branching object only change variable bounds?
 
void setSimulate (bool s)
 set simulate_ field below
 
expressionvariable ()
 return branching variable
 
void branchCore (OsiSolverInterface *, int, int, bool, double, t_chg_bounds *&)
 Perform branching step.
 
- Public Member Functions inherited from OsiTwoWayBranchingObject
 OsiTwoWayBranchingObject ()
 
 OsiTwoWayBranchingObject (OsiSolverInterface *solver, const OsiObject *originalObject, int way, double value)
 
 OsiTwoWayBranchingObject (const OsiTwoWayBranchingObject &)
 
OsiTwoWayBranchingObjectoperator= (const OsiTwoWayBranchingObject &rhs)
 
virtual ~OsiTwoWayBranchingObject ()
 
int firstBranch () const
 
int way () const
 
virtual double branch ()
 
- Public Member Functions inherited from OsiBranchingObject
 OsiBranchingObject ()
 
 OsiBranchingObject (OsiSolverInterface *solver, double value)
 
 OsiBranchingObject (const OsiBranchingObject &)
 
OsiBranchingObjectoperator= (const OsiBranchingObject &rhs)
 
virtual ~OsiBranchingObject ()
 
int numberBranches () const
 
int numberBranchesLeft () const
 
void incrementNumberBranchesLeft ()
 
void setNumberBranchesLeft (int)
 
void decrementNumberBranchesLeft ()
 
int branchIndex () const
 
void setBranchingIndex (int branchIndex)
 
double value () const
 
const OsiObjectoriginalObject () const
 
void setOriginalObject (const OsiObject *object)
 
virtual void checkIsCutoff (double)
 
int columnNumber () const
 
virtual void print (const OsiSolverInterface *=NULL) const
 

Static Public Attributes

static int nOrbBr
 
static int maxDepthOrbBranch
 
static int nSGcomputations
 

Protected Attributes

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

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() [1/2]

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

Constructor.

◆ CouenneBranchingObject() [2/2]

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

Copy constructor.

Definition at line 54 of file CouenneBranchingObject.hpp.

Member Function Documentation

◆ clone()

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

cloning method

Implements OsiBranchingObject.

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

Definition at line 68 of file CouenneBranchingObject.hpp.

◆ branch()

virtual double Couenne::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

Implements OsiTwoWayBranchingObject.

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

◆ boundBranch()

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

does this branching object only change variable bounds?

Reimplemented from OsiBranchingObject.

Reimplemented in Couenne::CouenneOrbitBranchingObj.

Definition at line 79 of file CouenneBranchingObject.hpp.

◆ setSimulate()

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

set simulate_ field below

Definition at line 83 of file CouenneBranchingObject.hpp.

◆ variable()

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

return branching variable

Definition at line 87 of file CouenneBranchingObject.hpp.

◆ branchCore()

void Couenne::CouenneBranchingObject::branchCore ( OsiSolverInterface * ,
int ,
int ,
bool ,
double ,
t_chg_bounds *&  )

Perform branching step.

Member Data Documentation

◆ nOrbBr

int Couenne::CouenneBranchingObject::nOrbBr
static

Definition at line 94 of file CouenneBranchingObject.hpp.

◆ maxDepthOrbBranch

int Couenne::CouenneBranchingObject::maxDepthOrbBranch
static

Definition at line 95 of file CouenneBranchingObject.hpp.

◆ nSGcomputations

int Couenne::CouenneBranchingObject::nSGcomputations
static

Definition at line 96 of file CouenneBranchingObject.hpp.

◆ cutGen_

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.

◆ problem_

CouenneProblem* Couenne::CouenneBranchingObject::problem_
protected

Pointer to CouenneProblem (necessary to allow FBBT)

Definition at line 105 of file CouenneBranchingObject.hpp.

◆ variable_

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.

◆ jnlst_

JnlstPtr Couenne::CouenneBranchingObject::jnlst_
protected

SmartPointer to the Journalist.

Definition at line 114 of file CouenneBranchingObject.hpp.

◆ doFBBT_

bool Couenne::CouenneBranchingObject::doFBBT_
protected

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

Definition at line 117 of file CouenneBranchingObject.hpp.

◆ doConvCuts_

bool Couenne::CouenneBranchingObject::doConvCuts_
protected

shall we add convexification cuts at branching?

Definition at line 120 of file CouenneBranchingObject.hpp.

◆ downEstimate_

double Couenne::CouenneBranchingObject::downEstimate_
protected

down branch estimate (done at selectBranch with reduced costs)

Definition at line 123 of file CouenneBranchingObject.hpp.

◆ upEstimate_

double Couenne::CouenneBranchingObject::upEstimate_
protected

up branch estimate

Definition at line 126 of file CouenneBranchingObject.hpp.

◆ simulate_

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 file: