Cbc  2.9.9
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
CbcCutBranchingObject Class Reference

Cut branching object. More...

#include <CbcBranchCut.hpp>

+ Inheritance diagram for CbcCutBranchingObject:
+ Collaboration diagram for CbcCutBranchingObject:

Public Member Functions

 CbcCutBranchingObject ()
 Default constructor. More...
 
 CbcCutBranchingObject (CbcModel *model, OsiRowCut &down, OsiRowCut &up, bool canFix)
 Create a cut branching object. More...
 
 CbcCutBranchingObject (const CbcCutBranchingObject &)
 Copy constructor. More...
 
CbcCutBranchingObjectoperator= (const CbcCutBranchingObject &rhs)
 Assignment operator. More...
 
virtual CbcBranchingObjectclone () const
 Clone. More...
 
virtual ~CbcCutBranchingObject ()
 Destructor. More...
 
virtual double branch ()
 Sets the bounds for variables or adds a cut depending on the current arm of the branch and advances the object state to the next arm. More...
 
virtual void print ()
 Print something about branch - only if log level high. More...
 
virtual bool boundBranch () const
 Return true if branch should fix variables. More...
 
virtual CbcBranchObjType type () const
 Return the type (an integer identifier) of this. More...
 
virtual int compareOriginalObject (const CbcBranchingObject *brObj) const
 Compare the original object of this with the original object of brObj. More...
 
virtual CbcRangeCompare compareBranchingObject (const CbcBranchingObject *brObj, const bool replaceIfOverlap=false)
 Compare the this with brObj. More...
 
- Public Member Functions inherited from CbcBranchingObject
 CbcBranchingObject ()
 Default Constructor. More...
 
 CbcBranchingObject (CbcModel *model, int variable, int way, double value)
 Constructor. More...
 
 CbcBranchingObject (const CbcBranchingObject &)
 Copy constructor. More...
 
CbcBranchingObjectoperator= (const CbcBranchingObject &rhs)
 Assignment operator. More...
 
virtual ~CbcBranchingObject ()
 Destructor. More...
 
virtual int fillStrongInfo (CbcStrongInfo &)
 Some branchingObjects may claim to be able to skip strong branching. More...
 
void resetNumberBranchesLeft ()
 Reset number of branches left to original. More...
 
void setNumberBranches (int value)
 Set number of branches to do. More...
 
virtual double branch (OsiSolverInterface *)
 Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. More...
 
virtual void fix (OsiSolverInterface *, double *, double *, int) const
 Update bounds in solver as in 'branch' and update given bounds. More...
 
virtual bool tighten (OsiSolverInterface *)
 Change (tighten) bounds in object to reflect bounds in solver. More...
 
virtual void previousBranch ()
 Reset every information so that the branching object appears to point to the previous child. More...
 
virtual void print () const
 Print something about branch - only if log level high. More...
 
int variable () const
 Index identifying the associated CbcObject within its class. More...
 
int way () const
 Get the state of the branching object. More...
 
void way (int way)
 Set the state of the branching object. More...
 
void setModel (CbcModel *model)
 update model More...
 
CbcModelmodel () const
 Return model. More...
 
CbcObjectobject () const
 Return pointer back to object which created. More...
 
void setOriginalObject (CbcObject *object)
 Set pointer back to object which created. More...
 
- Public Member Functions inherited from OsiBranchingObject
 OsiBranchingObject ()
 Default Constructor. More...
 
 OsiBranchingObject (OsiSolverInterface *solver, double value)
 Constructor. More...
 
 OsiBranchingObject (const OsiBranchingObject &)
 Copy constructor. More...
 
OsiBranchingObjectoperator= (const OsiBranchingObject &rhs)
 Assignment operator. More...
 
virtual ~OsiBranchingObject ()
 Destructor. More...
 
int numberBranches () const
 The number of branch arms created for this branching object. More...
 
int numberBranchesLeft () const
 The number of branch arms left for this branching object. More...
 
void incrementNumberBranchesLeft ()
 Increment the number of branch arms left for this branching object. More...
 
void setNumberBranchesLeft (int)
 Set the number of branch arms left for this branching object Just for forcing. More...
 
void decrementNumberBranchesLeft ()
 Decrement the number of branch arms left for this branching object. More...
 
int branchIndex () const
 Get the state of the branching object This is just the branch index. More...
 
void setBranchingIndex (int branchIndex)
 Set the state of the branching object. More...
 
double value () const
 Current value. More...
 
const OsiObjectoriginalObject () const
 Return pointer back to object which created. More...
 
void setOriginalObject (const OsiObject *object)
 Set pointer back to object which created. More...
 
virtual void checkIsCutoff (double)
 Double checks in case node can change its mind! Returns objective value Can change objective etc. More...
 
int columnNumber () const
 For debug. More...
 
virtual void print (const OsiSolverInterface *=NULL) const
 Print something about branch - only if log level high. More...
 

Protected Attributes

OsiRowCut down_
 Cut for the down arm (way_ = -1) More...
 
OsiRowCut up_
 Cut for the up arm (way_ = 1) More...
 
bool canFix_
 True if one way can fix variables. More...
 
- Protected Attributes inherited from CbcBranchingObject
CbcModelmodel_
 The model that owns this branching object. More...
 
CbcObjectoriginalCbcObject_
 Pointer back to object which created. More...
 
int variable_
 Branching variable (0 is first integer) More...
 
int way_
 The state of the branching object. More...
 
- Protected Attributes inherited from OsiBranchingObject
double value_
 Current value - has some meaning about branch. More...
 
const OsiObjectoriginalObject_
 Pointer back to object which created. More...
 
int numberBranches_
 Number of branches. More...
 
short branchIndex_
 The state of the branching object. More...
 

Detailed Description

Cut branching object.

This object can specify a two-way branch in terms of two cuts

Definition at line 108 of file CbcBranchCut.hpp.

Constructor & Destructor Documentation

CbcCutBranchingObject::CbcCutBranchingObject ( )

Default constructor.

CbcCutBranchingObject::CbcCutBranchingObject ( CbcModel model,
OsiRowCut down,
OsiRowCut up,
bool  canFix 
)

Create a cut branching object.

Cut down will applied on way=-1, up on way==1 Assumed down will be first so way_ set to -1

CbcCutBranchingObject::CbcCutBranchingObject ( const CbcCutBranchingObject )

Copy constructor.

virtual CbcCutBranchingObject::~CbcCutBranchingObject ( )
virtual

Destructor.

Member Function Documentation

CbcCutBranchingObject& CbcCutBranchingObject::operator= ( const CbcCutBranchingObject rhs)

Assignment operator.

virtual CbcBranchingObject* CbcCutBranchingObject::clone ( ) const
virtual

Clone.

Implements CbcBranchingObject.

virtual double CbcCutBranchingObject::branch ( )
virtual

Sets the bounds for variables or adds a cut depending on the current arm of the branch and advances the object state to the next arm.

Returns change in guessed objective on next branch

Implements CbcBranchingObject.

virtual void CbcCutBranchingObject::print ( )
virtual

Print something about branch - only if log level high.

virtual bool CbcCutBranchingObject::boundBranch ( ) const
virtual

Return true if branch should fix variables.

Reimplemented from OsiBranchingObject.

virtual CbcBranchObjType CbcCutBranchingObject::type ( ) const
inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 151 of file CbcBranchCut.hpp.

virtual int CbcCutBranchingObject::compareOriginalObject ( const CbcBranchingObject brObj) const
virtual

Compare the original object of this with the original object of brObj.

Assumes that there is an ordering of the original objects. This method should be invoked only if this and brObj are of the same type. Return negative/0/positive depending on whether this is smaller/same/larger than the argument.

Reimplemented from CbcBranchingObject.

virtual CbcRangeCompare CbcCutBranchingObject::compareBranchingObject ( const CbcBranchingObject brObj,
const bool  replaceIfOverlap = false 
)
virtual

Compare the this with brObj.

this and brObj must be os the same type and must have the same original object, but they may have different feasible regions. Return the appropriate CbcRangeCompare value (first argument being the sub/superset if that's the case). In case of overlap (and if replaceIfOverlap is true) replace the current branching object with one whose feasible region is the overlap.

Implements CbcBranchingObject.

Member Data Documentation

OsiRowCut CbcCutBranchingObject::down_
protected

Cut for the down arm (way_ = -1)

Definition at line 177 of file CbcBranchCut.hpp.

OsiRowCut CbcCutBranchingObject::up_
protected

Cut for the up arm (way_ = 1)

Definition at line 179 of file CbcBranchCut.hpp.

bool CbcCutBranchingObject::canFix_
protected

True if one way can fix variables.

Definition at line 181 of file CbcBranchCut.hpp.


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