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
CbcSOSBranchingObject Class Reference

Branching object for Special ordered sets. More...

#include <CbcSOS.hpp>

+ Inheritance diagram for CbcSOSBranchingObject:
+ Collaboration diagram for CbcSOSBranchingObject:

Public Member Functions

 CbcSOSBranchingObject ()
 
 CbcSOSBranchingObject (CbcModel *model, const CbcSOS *clique, int way, double separator)
 
 CbcSOSBranchingObject (const CbcSOSBranchingObject &)
 
CbcSOSBranchingObjectoperator= (const CbcSOSBranchingObject &rhs)
 
virtual CbcBranchingObjectclone () const
 Clone. More...
 
virtual ~CbcSOSBranchingObject ()
 
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...
 
void computeNonzeroRange ()
 Fill out the firstNonzero_ and lastNonzero_ data members. 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 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...
 
- 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

const CbcSOSset_
 data More...
 
double separator_
 separator More...
 
int firstNonzero_
 The following two members describe the range in the members_ of the original object that whose upper bound is not fixed to 0. More...
 
int lastNonzero_
 

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

Branching object for Special ordered sets.

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

Definition at line 191 of file CbcSOS.hpp.

Constructor & Destructor Documentation

CbcSOSBranchingObject::CbcSOSBranchingObject ( )
CbcSOSBranchingObject::CbcSOSBranchingObject ( CbcModel model,
const CbcSOS clique,
int  way,
double  separator 
)
CbcSOSBranchingObject::CbcSOSBranchingObject ( const CbcSOSBranchingObject )
virtual CbcSOSBranchingObject::~CbcSOSBranchingObject ( )
virtual

Member Function Documentation

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

Clone.

Implements CbcBranchingObject.

virtual double CbcSOSBranchingObject::branch ( )
virtual

Does next branch and updates state.

Implements CbcBranchingObject.

virtual void CbcSOSBranchingObject::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.

virtual void CbcSOSBranchingObject::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 227 of file CbcSOS.hpp.

virtual void CbcSOSBranchingObject::print ( )
virtual

Print something about branch - only if log level high.

virtual CbcBranchObjType CbcSOSBranchingObject::type ( ) const
inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 238 of file CbcSOS.hpp.

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

void CbcSOSBranchingObject::computeNonzeroRange ( )

Fill out the firstNonzero_ and lastNonzero_ data members.

Member Data Documentation

const CbcSOS* CbcSOSBranchingObject::set_
private

data

Definition at line 267 of file CbcSOS.hpp.

double CbcSOSBranchingObject::separator_
private

separator

Definition at line 269 of file CbcSOS.hpp.

int CbcSOSBranchingObject::firstNonzero_
private

The following two members describe the range in the members_ of the original object that whose upper bound is not fixed to 0.

This is not necessary for Cbc to function correctly, this is there for heuristics so that separate branching decisions on the same object can be pooled into one branching object.

Definition at line 275 of file CbcSOS.hpp.

int CbcSOSBranchingObject::lastNonzero_
private

Definition at line 276 of file CbcSOS.hpp.


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