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

N way branching Object class. More...

#include <CbcNWay.hpp>

+ Inheritance diagram for CbcNWayBranchingObject:
+ Collaboration diagram for CbcNWayBranchingObject:

Public Member Functions

 CbcNWayBranchingObject ()
 
 CbcNWayBranchingObject (CbcModel *model, const CbcNWay *nway, int numberBranches, const int *order)
 Useful constructor - order had matrix indices way_ -1 corresponds to setting first, +1 to second, +3 etc. More...
 
 CbcNWayBranchingObject (const CbcNWayBranchingObject &)
 
CbcNWayBranchingObjectoperator= (const CbcNWayBranchingObject &rhs)
 
virtual CbcBranchingObjectclone () const
 Clone. More...
 
virtual ~CbcNWayBranchingObject ()
 
virtual double branch ()
 Does next branch and updates state. More...
 
virtual void print ()
 Print something about branch - only if log level high. More...
 
virtual int numberBranches () const
 The number of branch arms created for this branching object. More...
 
virtual bool twoWay () const
 Is this a two way object (-1 down, +1 up) 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...
 
virtual bool boundBranch () const
 Return true if branch should fix variables. 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...
 

Private Attributes

int * order_
 order of branching - points back to CbcNWay More...
 
const CbcNWayobject_
 Points back to object. More...
 
int numberInSet_
 Number in set. More...
 

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_
 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

N way branching Object class.

Variable is number of set.

Definition at line 81 of file CbcNWay.hpp.

Constructor & Destructor Documentation

CbcNWayBranchingObject::CbcNWayBranchingObject ( )
CbcNWayBranchingObject::CbcNWayBranchingObject ( CbcModel model,
const CbcNWay nway,
int  numberBranches,
const int *  order 
)

Useful constructor - order had matrix indices way_ -1 corresponds to setting first, +1 to second, +3 etc.

this is so -1 and +1 have similarity to normal

CbcNWayBranchingObject::CbcNWayBranchingObject ( const CbcNWayBranchingObject )
virtual CbcNWayBranchingObject::~CbcNWayBranchingObject ( )
virtual

Member Function Documentation

CbcNWayBranchingObject& CbcNWayBranchingObject::operator= ( const CbcNWayBranchingObject rhs)
virtual CbcBranchingObject* CbcNWayBranchingObject::clone ( ) const
virtual

Clone.

Implements CbcBranchingObject.

virtual double CbcNWayBranchingObject::branch ( )
virtual

Does next branch and updates state.

Implements CbcBranchingObject.

virtual void CbcNWayBranchingObject::print ( )
virtual

Print something about branch - only if log level high.

virtual int CbcNWayBranchingObject::numberBranches ( ) const
inlinevirtual

The number of branch arms created for this branching object.

Definition at line 125 of file CbcNWay.hpp.

virtual bool CbcNWayBranchingObject::twoWay ( ) const
inlinevirtual

Is this a two way object (-1 down, +1 up)

Definition at line 129 of file CbcNWay.hpp.

virtual CbcBranchObjType CbcNWayBranchingObject::type ( ) const
inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 134 of file CbcNWay.hpp.

virtual int CbcNWayBranchingObject::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 CbcNWayBranchingObject::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

int* CbcNWayBranchingObject::order_
private

order of branching - points back to CbcNWay

Definition at line 160 of file CbcNWay.hpp.

const CbcNWay* CbcNWayBranchingObject::object_
private

Points back to object.

Definition at line 162 of file CbcNWay.hpp.

int CbcNWayBranchingObject::numberInSet_
private

Number in set.

Definition at line 164 of file CbcNWay.hpp.


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