Cbc  2.8.12
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | 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...
 

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

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 189 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 225 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 236 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.


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