Cbc  2.10.3
Public Member Functions | List of all members
CbcOrbitalBranchingObject Class Reference

Branching object for Orbital branching. More...

#include <CbcSymmetry.hpp>

+ Inheritance diagram for CbcOrbitalBranchingObject:

Public Member Functions

 CbcOrbitalBranchingObject ()
 
 CbcOrbitalBranchingObject (CbcModel *model, int column, int way, int numberExtra, const int *extraToZero)
 
 CbcOrbitalBranchingObject (const CbcOrbitalBranchingObject &)
 
CbcOrbitalBranchingObjectoperator= (const CbcOrbitalBranchingObject &rhs)
 
virtual CbcBranchingObjectclone () const
 Clone. More...
 
virtual ~CbcOrbitalBranchingObject ()
 
virtual double branch ()
 Does next branch and updates state. More...
 
virtual void fix (OsiSolverInterface *solver, double *lower, double *upper, int branchState) const
 Update bounds in solver as in 'branch' and update given bounds. More...
 
virtual void previousBranch ()
 Reset every information so that the branching object appears to point to the previous child. More...
 
virtual void print ()
 Print something about branch - only if log level high. 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...
 
virtual double branch ()=0
 Execute the actions required to branch, as specified by the current state of the branching object, and advance the object's state. 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 print () const
 Print something about branch - only if log level high. More...
 
virtual void print (const OsiSolverInterface *=NULL) const
 
- 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 bool tighten (OsiSolverInterface *)
 Change (tighten) bounds in object to reflect bounds in solver. 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...
 
virtual void print (const OsiSolverInterface *=NULL) const
 
- 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 ()
 
virtual bool boundBranch () const
 
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
 

Additional Inherited Members

- 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_
 
const OsiObjectoriginalObject_
 
int numberBranches_
 
short branchIndex_
 

Detailed Description

Branching object for Orbital branching.

Variable_ is the set id number (redundant, as the object also holds a pointer to the set.

Definition at line 302 of file CbcSymmetry.hpp.

Constructor & Destructor Documentation

◆ CbcOrbitalBranchingObject() [1/3]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject ( )

◆ CbcOrbitalBranchingObject() [2/3]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject ( CbcModel model,
int  column,
int  way,
int  numberExtra,
const int *  extraToZero 
)

◆ CbcOrbitalBranchingObject() [3/3]

CbcOrbitalBranchingObject::CbcOrbitalBranchingObject ( const CbcOrbitalBranchingObject )

◆ ~CbcOrbitalBranchingObject()

virtual CbcOrbitalBranchingObject::~CbcOrbitalBranchingObject ( )
virtual

Member Function Documentation

◆ operator=()

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

◆ clone()

virtual CbcBranchingObject* CbcOrbitalBranchingObject::clone ( ) const
virtual

Clone.

Implements CbcBranchingObject.

◆ branch() [1/3]

virtual double CbcOrbitalBranchingObject::branch ( )
virtual

Does next branch and updates state.

Implements CbcBranchingObject.

◆ fix()

virtual void CbcOrbitalBranchingObject::fix ( OsiSolverInterface solver,
double *  lower,
double *  upper,
int  branchState 
) const
virtual

Update bounds in solver as in 'branch' and update given bounds.

branchState is -1 for 'down' +1 for 'up'

Reimplemented from CbcBranchingObject.

◆ previousBranch()

virtual void CbcOrbitalBranchingObject::previousBranch ( )
inlinevirtual

Reset every information so that the branching object appears to point to the previous child.

This method does not need to modify anything in any solver.

Reimplemented from CbcBranchingObject.

Definition at line 337 of file CbcSymmetry.hpp.

◆ print() [1/3]

virtual void CbcOrbitalBranchingObject::print ( )
virtual

Print something about branch - only if log level high.

◆ type()

virtual CbcBranchObjType CbcOrbitalBranchingObject::type ( ) const
inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 348 of file CbcSymmetry.hpp.

◆ compareOriginalObject()

virtual int CbcOrbitalBranchingObject::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.

◆ compareBranchingObject()

virtual CbcRangeCompare CbcOrbitalBranchingObject::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.

◆ branch() [2/3]

virtual double CbcBranchingObject::branch

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

Mainly for diagnostics, whether it is true branch or strong branching is also passed. Returns change in guessed objective on next branch

◆ branch() [3/3]

virtual double CbcBranchingObject::branch
inline

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

Mainly for diagnostics, whether it is true branch or strong branching is also passed. Returns change in guessed objective on next branch

Definition at line 105 of file CbcBranchingObject.hpp.

◆ print() [2/3]

virtual void CbcBranchingObject::print
inline

Print something about branch - only if log level high.

Definition at line 132 of file CbcBranchingObject.hpp.

◆ print() [3/3]

virtual void OsiBranchingObject::print

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