Couenne  0.5.8
Public Member Functions | Protected Attributes | List of all members
Couenne::CouenneComplBranchingObject Class Reference

"Spatial" branching object for complementarity constraints. More...

#include <CouenneComplBranchingObject.hpp>

+ Inheritance diagram for Couenne::CouenneComplBranchingObject:
+ Collaboration diagram for Couenne::CouenneComplBranchingObject:

Public Member Functions

 CouenneComplBranchingObject (OsiSolverInterface *solver, const OsiObject *originalObject, JnlstPtr jnlst, CouenneCutGenerator *c, CouenneProblem *p, expression *var, expression *var2, int way, CouNumber brpoint, bool doFBBT, bool doConvCuts, int sign)
 Constructor. More...
 
 CouenneComplBranchingObject (const CouenneComplBranchingObject &src)
 Copy constructor. More...
 
virtual OsiBranchingObjectclone () 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...
 
- Public Member Functions inherited from 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. More...
 
 CouenneBranchingObject (const CouenneBranchingObject &src)
 Copy constructor. 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...
 
- 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
 

Protected Attributes

expressionvariable2_
 use CouenneBranchingObject::variable_ as the first variable to set to 0, and this one as the second More...
 
int sign_
 -1 if object is for xi * xj <= 0 +1 if object is for xi * xj <= 0 0 if object is for xi * xj = 0 (classical) More...
 
- Protected Attributes inherited from Couenne::CouenneBranchingObject
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...
 
- Protected Attributes inherited from OsiTwoWayBranchingObject
int firstBranch_
 
- Protected Attributes inherited from OsiBranchingObject
double value_
 
const OsiObjectoriginalObject_
 
int numberBranches_
 
short branchIndex_
 

Additional Inherited Members

- Static Public Attributes inherited from Couenne::CouenneBranchingObject
static int nOrbBr
 
static int maxDepthOrbBranch
 
static int nSGcomputations
 

Detailed Description

"Spatial" branching object for complementarity constraints.

Branching on such an object x_1 x_2 = 0 is performed by setting either x_1=0 or x_2=0

Definition at line 24 of file CouenneComplBranchingObject.hpp.

Constructor & Destructor Documentation

◆ CouenneComplBranchingObject() [1/2]

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

Constructor.

◆ CouenneComplBranchingObject() [2/2]

Couenne::CouenneComplBranchingObject::CouenneComplBranchingObject ( const CouenneComplBranchingObject src)
inline

Copy constructor.

Definition at line 43 of file CouenneComplBranchingObject.hpp.

Member Function Documentation

◆ clone()

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

cloning method

Reimplemented from Couenne::CouenneBranchingObject.

Definition at line 49 of file CouenneComplBranchingObject.hpp.

◆ branch()

virtual double Couenne::CouenneComplBranchingObject::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 from Couenne::CouenneBranchingObject.

Member Data Documentation

◆ variable2_

expression* Couenne::CouenneComplBranchingObject::variable2_
protected

use CouenneBranchingObject::variable_ as the first variable to set to 0, and this one as the second

Definition at line 63 of file CouenneComplBranchingObject.hpp.

◆ sign_

int Couenne::CouenneComplBranchingObject::sign_
protected

-1 if object is for xi * xj <= 0 +1 if object is for xi * xj <= 0 0 if object is for xi * xj = 0 (classical)

Definition at line 68 of file CouenneComplBranchingObject.hpp.


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