Public Member Functions | Protected Attributes

CbcBranchingObject Class Reference

Abstract branching object base class Now just difference with OsiBranchingObject. More...

#include <CbcBranchingObject.hpp>

Inheritance diagram for CbcBranchingObject:
CbcCliqueBranchingObject CbcCliqueBranchingObject CbcCutBranchingObject CbcCutBranchingObject CbcDummyBranchingObject CbcDummyBranchingObject CbcFixingBranchingObject CbcFixingBranchingObject CbcIntegerBranchingObject CbcIntegerBranchingObject CbcLinkBranchingObject CbcLongCliqueBranchingObject CbcLongCliqueBranchingObject CbcLotsizeBranchingObject CbcLotsizeBranchingObject CbcNWayBranchingObject CbcNWayBranchingObject CbcSOSBranchingObject CbcSOSBranchingObject

List of all members.

Public Member Functions

 CbcBranchingObject ()
 Default Constructor.
 CbcBranchingObject (CbcModel *model, int variable, int way, double value)
 Constructor.
 CbcBranchingObject (const CbcBranchingObject &)
 Copy constructor.
CbcBranchingObjectoperator= (const CbcBranchingObject &rhs)
 Assignment operator.
virtual CbcBranchingObjectclone () const =0
 Clone.
virtual ~CbcBranchingObject ()
 Destructor.
virtual int fillStrongInfo (CbcStrongInfo &)
 Some branchingObjects may claim to be able to skip strong branching.
void resetNumberBranchesLeft ()
 Reset number of branches left to original.
void setNumberBranches (int value)
 Set number of branches to do.
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.
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.
virtual void fix (OsiSolverInterface *, double *, double *, int) const
 Update bounds in solver as in 'branch' and update given bounds.
virtual void previousBranch ()
 Reset every information so that the branching object appears to point to the previous child.
virtual void print () const
 Print something about branch - only if log level high.
int variable () const
 Index identifying the associated CbcObject within its class.
int way () const
 Get the state of the branching object.
void way (int way)
 Set the state of the branching object.
void setModel (CbcModel *model)
 update model
CbcModelmodel () const
 Return model.
CbcObjectobject () const
 Return pointer back to object which created.
void setOriginalObject (CbcObject *object)
 Set pointer back to object which created.
virtual CbcBranchObjType type () const =0
 Return the type (an integer identifier) of this.
virtual int compareOriginalObject (const CbcBranchingObject *brObj) const
 Compare the original object of this with the original object of brObj.
virtual CbcRangeCompare compareBranchingObject (const CbcBranchingObject *brObj, const bool replaceIfOverlap=false)=0
 Compare the this with brObj.
 CbcBranchingObject ()
 Default Constructor.
 CbcBranchingObject (CbcModel *model, int variable, int way, double value)
 Constructor.
 CbcBranchingObject (const CbcBranchingObject &)
 Copy constructor.
CbcBranchingObjectoperator= (const CbcBranchingObject &rhs)
 Assignment operator.
virtual CbcBranchingObjectclone () const =0
 Clone.
virtual ~CbcBranchingObject ()
 Destructor.
virtual int fillStrongInfo (CbcStrongInfo &)
 Some branchingObjects may claim to be able to skip strong branching.
void resetNumberBranchesLeft ()
 Reset number of branches left to original.
void setNumberBranches (int value)
 Set number of branches to do.
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.
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.
virtual void fix (OsiSolverInterface *, double *, double *, int) const
 Update bounds in solver as in 'branch' and update given bounds.
virtual void previousBranch ()
 Reset every information so that the branching object appears to point to the previous child.
virtual void print () const
 Print something about branch - only if log level high.
int variable () const
 Index identifying the associated CbcObject within its class.
int way () const
 Get the state of the branching object.
void way (int way)
 Set the state of the branching object.
void setModel (CbcModel *model)
 update model
CbcModelmodel () const
 Return model.
CbcObjectobject () const
 Return pointer back to object which created.
void setOriginalObject (CbcObject *object)
 Set pointer back to object which created.
virtual CbcBranchObjType type () const =0
 Return the type (an integer identifier) of this.
virtual int compareOriginalObject (const CbcBranchingObject *brObj) const
 Compare the original object of this with the original object of brObj.
virtual CbcRangeCompare compareBranchingObject (const CbcBranchingObject *brObj, const bool replaceIfOverlap=false)=0
 Compare the this with brObj.

Protected Attributes

CbcModelmodel_
 The model that owns this branching object.
CbcObjectoriginalCbcObject_
 Pointer back to object which created.
int variable_
 Branching variable (0 is first integer).
int way_
 The state of the branching object.

Detailed Description

Abstract branching object base class Now just difference with OsiBranchingObject.

In the abstract, an CbcBranchingObject contains instructions for how to branch. We want an abstract class so that we can describe how to branch on simple objects (e.g., integers) and more exotic objects (e.g., cliques or hyperplanes).

The branch() method is the crucial routine: it is expected to be able to step through a set of branch arms, executing the actions required to create each subproblem in turn. The base class is primarily virtual to allow for a wide range of problem modifications.

See CbcObject for an overview of the three classes (CbcObject, CbcBranchingObject, and CbcBranchDecision) which make up cbc's branching model.

Definition at line 47 of file CbcBranchingObject.hpp.


Constructor & Destructor Documentation

CbcBranchingObject::CbcBranchingObject (  ) 

Default Constructor.

CbcBranchingObject::CbcBranchingObject ( CbcModel model,
int  variable,
int  way,
double  value 
)

Constructor.

CbcBranchingObject::CbcBranchingObject ( const CbcBranchingObject  ) 

Copy constructor.

virtual CbcBranchingObject::~CbcBranchingObject (  )  [virtual]

Destructor.

CbcBranchingObject::CbcBranchingObject (  ) 

Default Constructor.

CbcBranchingObject::CbcBranchingObject ( CbcModel model,
int  variable,
int  way,
double  value 
)

Constructor.

CbcBranchingObject::CbcBranchingObject ( const CbcBranchingObject  ) 

Copy constructor.

virtual CbcBranchingObject::~CbcBranchingObject (  )  [virtual]

Destructor.


Member Function Documentation

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

Assignment operator.

virtual int CbcBranchingObject::fillStrongInfo ( CbcStrongInfo  )  [inline, virtual]

Some branchingObjects may claim to be able to skip strong branching.

If so they have to fill in CbcStrongInfo. The object mention in incoming CbcStrongInfo must match. Returns nonzero if skip is wanted

Reimplemented in CbcDynamicPseudoCostBranchingObject, and CbcDynamicPseudoCostBranchingObject.

Definition at line 73 of file CbcBranchingObject.hpp.

void CbcBranchingObject::resetNumberBranchesLeft (  )  [inline]

Reset number of branches left to original.

Definition at line 77 of file CbcBranchingObject.hpp.

void CbcBranchingObject::setNumberBranches ( int  value  )  [inline]

Set number of branches to do.

Definition at line 81 of file CbcBranchingObject.hpp.

virtual double CbcBranchingObject::branch (  )  [pure virtual]
virtual double CbcBranchingObject::branch ( OsiSolverInterface *   )  [inline, virtual]

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 99 of file CbcBranchingObject.hpp.

virtual void CbcBranchingObject::fix ( OsiSolverInterface *  ,
double *  ,
double *  ,
int   
) const [inline, virtual]

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

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

Reimplemented in CbcIntegerBranchingObject, CbcSOSBranchingObject, CbcIntegerBranchingObject, and CbcSOSBranchingObject.

Definition at line 104 of file CbcBranchingObject.hpp.

virtual void CbcBranchingObject::previousBranch (  )  [inline, virtual]

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 in CbcSOSBranchingObject, and CbcSOSBranchingObject.

Definition at line 111 of file CbcBranchingObject.hpp.

virtual void CbcBranchingObject::print (  )  const [inline, virtual]

Print something about branch - only if log level high.

Definition at line 120 of file CbcBranchingObject.hpp.

int CbcBranchingObject::variable (  )  const [inline]

Index identifying the associated CbcObject within its class.

The name is misleading, and typically the index will not refer directly to a variable. Rather, it identifies an CbcObject within the class of similar CbcObjects

E.g., for an CbcSimpleInteger, variable() is the index of the integer variable in the set of integer variables (not the index of the variable in the set of all variables).

Definition at line 133 of file CbcBranchingObject.hpp.

int CbcBranchingObject::way (  )  const [inline]

Get the state of the branching object.

Returns a code indicating the active arm of the branching object. The precise meaning is defined in the derived class.

See also:
way_

Definition at line 144 of file CbcBranchingObject.hpp.

void CbcBranchingObject::way ( int  way  )  [inline]

Set the state of the branching object.

See way()

Definition at line 152 of file CbcBranchingObject.hpp.

void CbcBranchingObject::setModel ( CbcModel model  )  [inline]

update model

Definition at line 157 of file CbcBranchingObject.hpp.

CbcModel* CbcBranchingObject::model (  )  const [inline]

Return model.

Definition at line 161 of file CbcBranchingObject.hpp.

CbcObject* CbcBranchingObject::object (  )  const [inline]

Return pointer back to object which created.

Reimplemented in CbcDynamicPseudoCostBranchingObject, and CbcDynamicPseudoCostBranchingObject.

Definition at line 166 of file CbcBranchingObject.hpp.

void CbcBranchingObject::setOriginalObject ( CbcObject object  )  [inline]

Set pointer back to object which created.

Definition at line 170 of file CbcBranchingObject.hpp.

virtual int CbcBranchingObject::compareOriginalObject ( const CbcBranchingObject brObj  )  const [inline, 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 in CbcCutBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, CbcSOSBranchingObject, CbcCutBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, and CbcSOSBranchingObject.

Definition at line 189 of file CbcBranchingObject.hpp.

virtual CbcRangeCompare CbcBranchingObject::compareBranchingObject ( const CbcBranchingObject brObj,
const bool  replaceIfOverlap = false 
) [pure virtual]

Compare the this with brObj.

this and brObj must be of 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.

Implemented in CbcLinkBranchingObject, CbcCutBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, CbcIntegerBranchingObject, CbcIntegerPseudoCostBranchingObject, CbcSOSBranchingObject, CbcCutBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, CbcIntegerBranchingObject, CbcIntegerPseudoCostBranchingObject, and CbcSOSBranchingObject.

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

Assignment operator.

virtual int CbcBranchingObject::fillStrongInfo ( CbcStrongInfo  )  [inline, virtual]

Some branchingObjects may claim to be able to skip strong branching.

If so they have to fill in CbcStrongInfo. The object mention in incoming CbcStrongInfo must match. Returns nonzero if skip is wanted

Reimplemented in CbcDynamicPseudoCostBranchingObject, and CbcDynamicPseudoCostBranchingObject.

Definition at line 73 of file CbcBranchingObject.hpp.

void CbcBranchingObject::resetNumberBranchesLeft (  )  [inline]

Reset number of branches left to original.

Definition at line 77 of file CbcBranchingObject.hpp.

void CbcBranchingObject::setNumberBranches ( int  value  )  [inline]

Set number of branches to do.

Definition at line 81 of file CbcBranchingObject.hpp.

virtual double CbcBranchingObject::branch (  )  [pure virtual]
virtual double CbcBranchingObject::branch ( OsiSolverInterface *   )  [inline, virtual]

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 99 of file CbcBranchingObject.hpp.

virtual void CbcBranchingObject::fix ( OsiSolverInterface *  ,
double *  ,
double *  ,
int   
) const [inline, virtual]

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

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

Reimplemented in CbcIntegerBranchingObject, CbcSOSBranchingObject, CbcIntegerBranchingObject, and CbcSOSBranchingObject.

Definition at line 104 of file CbcBranchingObject.hpp.

virtual void CbcBranchingObject::previousBranch (  )  [inline, virtual]

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 in CbcSOSBranchingObject, and CbcSOSBranchingObject.

Definition at line 111 of file CbcBranchingObject.hpp.

virtual void CbcBranchingObject::print (  )  const [inline, virtual]

Print something about branch - only if log level high.

Definition at line 120 of file CbcBranchingObject.hpp.

int CbcBranchingObject::variable (  )  const [inline]

Index identifying the associated CbcObject within its class.

The name is misleading, and typically the index will not refer directly to a variable. Rather, it identifies an CbcObject within the class of similar CbcObjects

E.g., for an CbcSimpleInteger, variable() is the index of the integer variable in the set of integer variables (not the index of the variable in the set of all variables).

Definition at line 133 of file CbcBranchingObject.hpp.

int CbcBranchingObject::way (  )  const [inline]

Get the state of the branching object.

Returns a code indicating the active arm of the branching object. The precise meaning is defined in the derived class.

See also:
way_

Definition at line 144 of file CbcBranchingObject.hpp.

void CbcBranchingObject::way ( int  way  )  [inline]

Set the state of the branching object.

See way()

Definition at line 152 of file CbcBranchingObject.hpp.

void CbcBranchingObject::setModel ( CbcModel model  )  [inline]

update model

Definition at line 157 of file CbcBranchingObject.hpp.

CbcModel* CbcBranchingObject::model (  )  const [inline]

Return model.

Definition at line 161 of file CbcBranchingObject.hpp.

CbcObject* CbcBranchingObject::object (  )  const [inline]

Return pointer back to object which created.

Reimplemented in CbcDynamicPseudoCostBranchingObject, and CbcDynamicPseudoCostBranchingObject.

Definition at line 166 of file CbcBranchingObject.hpp.

void CbcBranchingObject::setOriginalObject ( CbcObject object  )  [inline]

Set pointer back to object which created.

Definition at line 170 of file CbcBranchingObject.hpp.

virtual int CbcBranchingObject::compareOriginalObject ( const CbcBranchingObject brObj  )  const [inline, 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 in CbcCutBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, CbcSOSBranchingObject, CbcCutBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, and CbcSOSBranchingObject.

Definition at line 189 of file CbcBranchingObject.hpp.

virtual CbcRangeCompare CbcBranchingObject::compareBranchingObject ( const CbcBranchingObject brObj,
const bool  replaceIfOverlap = false 
) [pure virtual]

Compare the this with brObj.

this and brObj must be of 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.

Implemented in CbcLinkBranchingObject, CbcCutBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, CbcIntegerBranchingObject, CbcIntegerPseudoCostBranchingObject, CbcSOSBranchingObject, CbcCutBranchingObject, CbcLotsizeBranchingObject, CbcCliqueBranchingObject, CbcLongCliqueBranchingObject, CbcDummyBranchingObject, CbcFixingBranchingObject, CbcNWayBranchingObject, CbcIntegerBranchingObject, CbcIntegerPseudoCostBranchingObject, and CbcSOSBranchingObject.


Member Data Documentation

The model that owns this branching object.

Definition at line 208 of file CbcBranchingObject.hpp.

Pointer back to object which created.

Definition at line 210 of file CbcBranchingObject.hpp.

Branching variable (0 is first integer).

Definition at line 213 of file CbcBranchingObject.hpp.

int CbcBranchingObject::way_ [protected]

The state of the branching object.

Specifies the active arm of the branching object. Coded as -1 to take the `down' arm, +1 for the `up' arm. `Down' and `up' are defined based on the natural meaning (floor and ceiling, respectively) for a simple integer. The precise meaning is defined in the derived class.

Definition at line 222 of file CbcBranchingObject.hpp.


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