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

Lotsize branching object. More...

#include <CbcBranchLotsize.hpp>

+ Inheritance diagram for CbcLotsizeBranchingObject:
+ Collaboration diagram for CbcLotsizeBranchingObject:

Public Member Functions

 CbcLotsizeBranchingObject ()
 Default constructor. More...
 
 CbcLotsizeBranchingObject (CbcModel *model, int variable, int way, double value, const CbcLotsize *lotsize)
 Create a lotsize floor/ceiling branch object. More...
 
 CbcLotsizeBranchingObject (CbcModel *model, int variable, int way, double lowerValue, double upperValue)
 Create a degenerate branch object. More...
 
 CbcLotsizeBranchingObject (const CbcLotsizeBranchingObject &)
 Copy constructor. More...
 
CbcLotsizeBranchingObjectoperator= (const CbcLotsizeBranchingObject &rhs)
 Assignment operator. More...
 
virtual CbcBranchingObjectclone () const
 Clone. More...
 
virtual ~CbcLotsizeBranchingObject ()
 Destructor. More...
 
virtual double branch ()
 Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm. 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 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...
 
virtual int compareOriginalObject (const CbcBranchingObject *brObj) const
 Compare the original object of this with the original object of brObj. 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...
 

Protected Attributes

double down_ [2]
 Lower [0] and upper [1] bounds for the down arm (way_ = -1) More...
 
double up_ [2]
 Lower [0] and upper [1] bounds for the up arm (way_ = 1) More...
 
- 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

Lotsize branching object.

This object can specify a two-way branch on an integer variable. For each arm of the branch, the upper and lower bounds on the variable can be independently specified.

Variable_ holds the index of the integer variable in the integerVariable_ array of the model.

Definition at line 166 of file CbcBranchLotsize.hpp.

Constructor & Destructor Documentation

CbcLotsizeBranchingObject::CbcLotsizeBranchingObject ( )

Default constructor.

CbcLotsizeBranchingObject::CbcLotsizeBranchingObject ( CbcModel model,
int  variable,
int  way,
double  value,
const CbcLotsize lotsize 
)

Create a lotsize floor/ceiling branch object.

Specifies a simple two-way branch. Let value = x*. One arm of the branch will be is lb <= x <= valid range below(x*), the other valid range above(x*) <= x <= ub. Specify way = -1 to set the object state to perform the down arm first, way = 1 for the up arm.

CbcLotsizeBranchingObject::CbcLotsizeBranchingObject ( CbcModel model,
int  variable,
int  way,
double  lowerValue,
double  upperValue 
)

Create a degenerate branch object.

Specifies a `one-way branch'. Calling branch() for this object will always result in lowerValue <= x <= upperValue. Used to fix in valid range

CbcLotsizeBranchingObject::CbcLotsizeBranchingObject ( const CbcLotsizeBranchingObject )

Copy constructor.

virtual CbcLotsizeBranchingObject::~CbcLotsizeBranchingObject ( )
virtual

Destructor.

Member Function Documentation

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

Assignment operator.

virtual CbcBranchingObject* CbcLotsizeBranchingObject::clone ( ) const
virtual

Clone.

Implements CbcBranchingObject.

virtual double CbcLotsizeBranchingObject::branch ( )
virtual

Sets the bounds for the variable according to the current arm of the branch and advances the object state to the next arm.

Implements CbcBranchingObject.

virtual void CbcLotsizeBranchingObject::print ( )
virtual

Print something about branch - only if log level high.

virtual CbcBranchObjType CbcLotsizeBranchingObject::type ( ) const
inlinevirtual

Return the type (an integer identifier) of this.

Implements CbcBranchingObject.

Definition at line 216 of file CbcBranchLotsize.hpp.

virtual CbcRangeCompare CbcLotsizeBranchingObject::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

double CbcLotsizeBranchingObject::down_[2]
protected

Lower [0] and upper [1] bounds for the down arm (way_ = -1)

Definition at line 236 of file CbcBranchLotsize.hpp.

double CbcLotsizeBranchingObject::up_[2]
protected

Lower [0] and upper [1] bounds for the up arm (way_ = 1)

Definition at line 238 of file CbcBranchLotsize.hpp.


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