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
CbcObject Class Referenceabstract

#include <CbcObject.hpp>

+ Inheritance diagram for CbcObject:
+ Collaboration diagram for CbcObject:

Public Member Functions

 CbcObject ()
 
 CbcObject (CbcModel *model)
 
 CbcObject (const CbcObject &)
 
CbcObjectoperator= (const CbcObject &rhs)
 
virtual CbcObjectclone () const =0
 Clone. More...
 
virtual ~CbcObject ()
 Destructor. More...
 
virtual double infeasibility (const OsiBranchingInformation *, int &preferredWay) const
 Infeasibility of the object. More...
 
virtual double infeasibility (int &) const
 
virtual void feasibleRegion ()=0
 For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution. More...
 
virtual double feasibleRegion (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
 Dummy one for compatibility. More...
 
virtual double feasibleRegion (OsiSolverInterface *solver) const
 For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution. More...
 
virtual CbcBranchingObjectcreateCbcBranch (OsiSolverInterface *, const OsiBranchingInformation *, int)
 Create a branching object and indicate which way to branch first. More...
 
virtual OsiBranchingObjectcreateBranch (OsiSolverInterface *, const OsiBranchingInformation *, int) const
 Create a branching object and indicate which way to branch first. More...
 
virtual OsiBranchingObjectcreateOsiBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way) const
 Create an Osibranching object and indicate which way to branch first. More...
 
virtual OsiSolverBranchsolverBranch () const
 Create an OsiSolverBranch object. More...
 
virtual CbcBranchingObjectpreferredNewFeasible () const
 Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a good direction. More...
 
virtual CbcBranchingObjectnotPreferredNewFeasible () const
 Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a bad direction. More...
 
virtual void resetBounds (const OsiSolverInterface *)
 Reset variable bounds to their original values. More...
 
virtual void floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
 Returns floor and ceiling i.e. More...
 
virtual CbcObjectUpdateData createUpdateInformation (const OsiSolverInterface *solver, const CbcNode *node, const CbcBranchingObject *branchingObject)
 Pass in information on branch just done and create CbcObjectUpdateData instance. More...
 
virtual void updateInformation (const CbcObjectUpdateData &)
 Update object by CbcObjectUpdateData. More...
 
int id () const
 Identifier (normally column number in matrix) More...
 
void setId (int value)
 Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e. More...
 
bool optionalObject () const
 Return true if optional branching object i.e. More...
 
int position () const
 Get position in object_ list. More...
 
void setPosition (int position)
 Set position in object_ list. More...
 
void setModel (CbcModel *model)
 update model More...
 
CbcModelmodel () const
 Return model. More...
 
int preferredWay () const
 If -1 down always chosen first, +1 up always, 0 normal. More...
 
void setPreferredWay (int value)
 Set -1 down always chosen first, +1 up always, 0 normal. More...
 
virtual void redoSequenceEtc (CbcModel *, int, const int *)
 Redoes data when sequence numbers change. More...
 
virtual void initializeForBranching (CbcModel *)
 Initialize for branching. More...
 
- Public Member Functions inherited from OsiObject
 OsiObject ()
 Default Constructor. More...
 
 OsiObject (const OsiObject &)
 Copy constructor. More...
 
OsiObjectoperator= (const OsiObject &rhs)
 Assignment operator. More...
 
virtual ~OsiObject ()
 Destructor. More...
 
double infeasibility (const OsiSolverInterface *solver, int &whichWay) const
 Infeasibility of the object. More...
 
virtual double checkInfeasibility (const OsiBranchingInformation *info) const
 
virtual bool canDoHeuristics () const
 Return true if object can take part in normal heuristics. More...
 
virtual bool canMoveToNearest () const
 Return true if object can take part in move to nearest heuristic. More...
 
virtual int columnNumber () const
 Column number if single column object -1 otherwise, Used by heuristics. More...
 
int priority () const
 Return Priority - note 1 is highest priority. More...
 
void setPriority (int priority)
 Set priority. More...
 
virtual bool boundBranch () const
 Return true if branch should only bound variables. More...
 
virtual bool canHandleShadowPrices () const
 Return true if knows how to deal with Pseudo Shadow Prices. More...
 
int numberWays () const
 Return maximum number of ways branch may have. More...
 
void setNumberWays (int numberWays)
 Set maximum number of ways branch may have. More...
 
void setWhichWay (int way)
 Return preferred way to branch. More...
 
int whichWay () const
 Return current preferred way to branch. More...
 
double infeasibility () const
 Return infeasibility. More...
 
virtual double upEstimate () const
 Return "up" estimate (default 1.0e-5) More...
 
virtual double downEstimate () const
 Return "down" estimate (default 1.0e-5) More...
 
virtual void resetSequenceEtc (int, const int *)
 Change column numbers after preprocessing. More...
 
virtual void updateBefore (const OsiObject *)
 Updates stuff like pseudocosts before threads. More...
 
virtual void updateAfter (const OsiObject *, const OsiObject *)
 Updates stuff like pseudocosts after threads finished. More...
 

Protected Attributes

CbcModelmodel_
 data More...
 
int id_
 Identifier (normally column number in matrix) More...
 
int position_
 Position in object list. More...
 
int preferredWay_
 If -1 down always chosen first, +1 up always, 0 normal. More...
 
- Protected Attributes inherited from OsiObject
double infeasibility_
 data More...
 
short whichWay_
 Computed preferred way to branch. More...
 
short numberWays_
 Maximum number of ways on branch. More...
 
int priority_
 Priority. More...
 

Detailed Description

Definition at line 67 of file CbcObject.hpp.

Constructor & Destructor Documentation

CbcObject::CbcObject ( )
CbcObject::CbcObject ( CbcModel model)
CbcObject::CbcObject ( const CbcObject )
virtual CbcObject::~CbcObject ( )
virtual

Destructor.

Member Function Documentation

CbcObject& CbcObject::operator= ( const CbcObject rhs)
virtual CbcObject* CbcObject::clone ( ) const
pure virtual
virtual double CbcObject::infeasibility ( const OsiBranchingInformation ,
int &  preferredWay 
) const
inlinevirtual

Infeasibility of the object.

This is some measure of the infeasibility of the object. It should be scaled to be in the range [0.0, 0.5], with 0.0 indicating the object is satisfied.

The preferred branching direction is returned in preferredWay,

This is used to prepare for strong branching but should also think of case when no strong branching

The object may also compute an estimate of cost of going "up" or "down". This will probably be based on pseudo-cost ideas

Implements OsiObject.

Reimplemented in CbcSimpleInteger, CbcIdiotBranch, CbcClique, CbcSimpleIntegerDynamicPseudoCost, CbcSOS, CbcBranchToFixLots, CbcFollowOn, CbcBranchAllDifferent, CbcNWay, CbcSimpleIntegerPseudoCost, CbcGeneral, CbcBranchCut, and CbcLotsize.

Definition at line 107 of file CbcObject.hpp.

virtual double CbcObject::infeasibility ( int &  ) const
inlinevirtual

Reimplemented in CbcSimpleIntegerFixed, CbcLink, and CbcFollowOn2.

Definition at line 111 of file CbcObject.hpp.

virtual void CbcObject::feasibleRegion ( )
pure virtual

For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution.

Implemented in CbcSimpleInteger, CbcIdiotBranch, CbcClique, CbcSOS, CbcLink, CbcFollowOn, CbcFollowOn2, CbcBranchCut, CbcNWay, CbcLotsize, and CbcGeneral.

virtual double CbcObject::feasibleRegion ( OsiSolverInterface solver,
const OsiBranchingInformation info 
) const
virtual

Dummy one for compatibility.

Implements OsiObject.

Reimplemented in CbcSimpleInteger.

virtual double CbcObject::feasibleRegion ( OsiSolverInterface solver) const
virtual

For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution.

Returns measure of how much it had to move solution to make feasible

Reimplemented from OsiObject.

virtual CbcBranchingObject* CbcObject::createCbcBranch ( OsiSolverInterface ,
const OsiBranchingInformation ,
int   
)
inlinevirtual

Create a branching object and indicate which way to branch first.

The branching object has to know how to create branches (fix variables, etc.)

Reimplemented in CbcSimpleInteger, CbcIdiotBranch, CbcClique, CbcSOS, CbcBranchToFixLots, CbcSimpleIntegerDynamicPseudoCost, CbcLink, CbcBranchCut, CbcFollowOn, CbcNWay, CbcLotsize, CbcBranchAllDifferent, CbcGeneral, and CbcSimpleIntegerPseudoCost.

Definition at line 137 of file CbcObject.hpp.

virtual OsiBranchingObject* CbcObject::createBranch ( OsiSolverInterface ,
const OsiBranchingInformation ,
int   
) const
inlinevirtual

Create a branching object and indicate which way to branch first.

The branching object has to know how to create branches (fix variables, etc.)

Reimplemented from OsiObject.

Definition at line 144 of file CbcObject.hpp.

virtual OsiBranchingObject* CbcObject::createOsiBranch ( OsiSolverInterface solver,
const OsiBranchingInformation info,
int  way 
) const
virtual

Create an Osibranching object and indicate which way to branch first.

The branching object has to know how to create branches (fix variables, etc.)

virtual OsiSolverBranch* CbcObject::solverBranch ( ) const
virtual

Create an OsiSolverBranch object.

This returns NULL if branch not represented by bound changes

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSOS.

virtual CbcBranchingObject* CbcObject::preferredNewFeasible ( ) const
inlinevirtual

Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a good direction.

If the method cannot generate a feasible point (because there aren't any, or because it isn't bright enough to find one), it should return null.

Reimplemented in CbcBranchCut, and CbcLotsize.

Definition at line 169 of file CbcObject.hpp.

virtual CbcBranchingObject* CbcObject::notPreferredNewFeasible ( ) const
inlinevirtual

Given a valid solution (with reduced costs, etc.), return a branching object which would give a new feasible point in a bad direction.

If the method cannot generate a feasible point (because there aren't any, or because it isn't bright enough to find one), it should return null.

Reimplemented in CbcBranchCut, and CbcLotsize.

Definition at line 181 of file CbcObject.hpp.

virtual void CbcObject::resetBounds ( const OsiSolverInterface )
inlinevirtual

Reset variable bounds to their original values.

Bounds may be tightened, so it may be good to be able to set this info in object.

Reimplemented from OsiObject.

Reimplemented in CbcSimpleInteger, and CbcLotsize.

Definition at line 189 of file CbcObject.hpp.

virtual void CbcObject::floorCeiling ( double &  floorValue,
double &  ceilingValue,
double  value,
double  tolerance 
) const
virtual

Returns floor and ceiling i.e.

closest valid points

Reimplemented in CbcLotsize.

virtual CbcObjectUpdateData CbcObject::createUpdateInformation ( const OsiSolverInterface solver,
const CbcNode node,
const CbcBranchingObject branchingObject 
)
virtual

Pass in information on branch just done and create CbcObjectUpdateData instance.

If object does not need data then backward pointer will be NULL. Assumes can get information from solver

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSOS.

virtual void CbcObject::updateInformation ( const CbcObjectUpdateData )
inlinevirtual

Update object by CbcObjectUpdateData.

Reimplemented in CbcSimpleIntegerDynamicPseudoCost, and CbcSOS.

Definition at line 204 of file CbcObject.hpp.

int CbcObject::id ( ) const
inline

Identifier (normally column number in matrix)

Definition at line 207 of file CbcObject.hpp.

void CbcObject::setId ( int  value)
inline

Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.

code would work without it

Definition at line 214 of file CbcObject.hpp.

bool CbcObject::optionalObject ( ) const
inline

Return true if optional branching object i.e.

code would work without it

Definition at line 220 of file CbcObject.hpp.

int CbcObject::position ( ) const
inline

Get position in object_ list.

Definition at line 225 of file CbcObject.hpp.

void CbcObject::setPosition ( int  position)
inline

Set position in object_ list.

Definition at line 230 of file CbcObject.hpp.

void CbcObject::setModel ( CbcModel model)
inline

update model

Definition at line 235 of file CbcObject.hpp.

CbcModel* CbcObject::model ( ) const
inline

Return model.

Definition at line 240 of file CbcObject.hpp.

int CbcObject::preferredWay ( ) const
inlinevirtual

If -1 down always chosen first, +1 up always, 0 normal.

Reimplemented from OsiObject.

Definition at line 245 of file CbcObject.hpp.

void CbcObject::setPreferredWay ( int  value)
inline

Set -1 down always chosen first, +1 up always, 0 normal.

Definition at line 249 of file CbcObject.hpp.

virtual void CbcObject::redoSequenceEtc ( CbcModel ,
int  ,
const int *   
)
inlinevirtual

Redoes data when sequence numbers change.

Reimplemented in CbcClique, CbcSOS, CbcBranchToFixLots, CbcNWay, and CbcGeneral.

Definition at line 253 of file CbcObject.hpp.

virtual void CbcObject::initializeForBranching ( CbcModel )
inlinevirtual

Initialize for branching.

Reimplemented in CbcIdiotBranch.

Definition at line 255 of file CbcObject.hpp.

Member Data Documentation

CbcModel* CbcObject::model_
protected

data

Model

Definition at line 261 of file CbcObject.hpp.

int CbcObject::id_
protected

Identifier (normally column number in matrix)

Definition at line 263 of file CbcObject.hpp.

int CbcObject::position_
protected

Position in object list.

Definition at line 265 of file CbcObject.hpp.

int CbcObject::preferredWay_
protected

If -1 down always chosen first, +1 up always, 0 normal.

Definition at line 267 of file CbcObject.hpp.


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