Public Member Functions | Protected Attributes
CbcSimpleIntegerPseudoCost Class Reference

Define a single integer class but with pseudo costs. More...

#include <CbcSimpleIntegerPseudoCost.hpp>

Inheritance diagram for CbcSimpleIntegerPseudoCost:
CbcSimpleInteger CbcSimpleInteger CbcObject CbcObject CbcObject CbcObject

List of all members.

Public Member Functions

 CbcSimpleIntegerPseudoCost ()
 CbcSimpleIntegerPseudoCost (CbcModel *model, int iColumn, double breakEven=0.5)
 CbcSimpleIntegerPseudoCost (CbcModel *model, int iColumn, double downPseudoCost, double upPseudoCost)
 CbcSimpleIntegerPseudoCost (CbcModel *model, int dummy, int iColumn, double downPseudoCost, double upPseudoCost)
 CbcSimpleIntegerPseudoCost (const CbcSimpleIntegerPseudoCost &)
virtual CbcObjectclone () const
 Clone.
CbcSimpleIntegerPseudoCostoperator= (const CbcSimpleIntegerPseudoCost &rhs)
virtual ~CbcSimpleIntegerPseudoCost ()
virtual double infeasibility (const OsiBranchingInformation *info, int &preferredWay) const
 Infeasibility - large is 0.5.
virtual CbcBranchingObjectcreateCbcBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way)
 Creates a branching object.
double downPseudoCost () const
 Down pseudo cost.
void setDownPseudoCost (double value)
 Set down pseudo cost.
double upPseudoCost () const
 Up pseudo cost.
void setUpPseudoCost (double value)
 Set up pseudo cost.
double upDownSeparator () const
 Up down separator.
void setUpDownSeparator (double value)
 Set up down separator.
virtual double upEstimate () const
 Return "up" estimate.
virtual double downEstimate () const
 Return "down" estimate (default 1.0e-5)
int method () const
 method - see below for details
void setMethod (int value)
 Set method.
 CbcSimpleIntegerPseudoCost ()
 CbcSimpleIntegerPseudoCost (CbcModel *model, int iColumn, double breakEven=0.5)
 CbcSimpleIntegerPseudoCost (CbcModel *model, int iColumn, double downPseudoCost, double upPseudoCost)
 CbcSimpleIntegerPseudoCost (CbcModel *model, int dummy, int iColumn, double downPseudoCost, double upPseudoCost)
 CbcSimpleIntegerPseudoCost (const CbcSimpleIntegerPseudoCost &)
virtual CbcObjectclone () const
 Clone.
CbcSimpleIntegerPseudoCostoperator= (const CbcSimpleIntegerPseudoCost &rhs)
virtual ~CbcSimpleIntegerPseudoCost ()
virtual double infeasibility (const OsiBranchingInformation *info, int &preferredWay) const
 Infeasibility - large is 0.5.
virtual CbcBranchingObjectcreateCbcBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way)
 Creates a branching object.
double downPseudoCost () const
 Down pseudo cost.
void setDownPseudoCost (double value)
 Set down pseudo cost.
double upPseudoCost () const
 Up pseudo cost.
void setUpPseudoCost (double value)
 Set up pseudo cost.
double upDownSeparator () const
 Up down separator.
void setUpDownSeparator (double value)
 Set up down separator.
virtual double upEstimate () const
 Return "up" estimate.
virtual double downEstimate () const
 Return "down" estimate (default 1.0e-5)
int method () const
 method - see below for details
void setMethod (int value)
 Set method.
- Public Member Functions inherited from CbcSimpleInteger
 CbcSimpleInteger ()
 CbcSimpleInteger (CbcModel *model, int iColumn, double breakEven=0.5)
 CbcSimpleInteger (CbcModel *model, const OsiSimpleInteger *object)
 CbcSimpleInteger (const CbcSimpleInteger &)
CbcSimpleIntegeroperator= (const CbcSimpleInteger &rhs)
virtual ~CbcSimpleInteger ()
OsiSimpleInteger * osiObject () const
 Construct an OsiSimpleInteger object.
virtual double feasibleRegion (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
 Set bounds to fix the variable at the current (integer) value.
void fillCreateBranch (CbcIntegerBranchingObject *branching, const OsiBranchingInformation *info, int way)
 Fills in a created branching object.
virtual OsiSolverBranch * solverBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
 Create an OsiSolverBranch object.
virtual void feasibleRegion ()
 Set bounds to fix the variable at the current (integer) value.
virtual int columnNumber () const
 Column number if single column object -1 otherwise, so returns >= 0 Used by heuristics.
void setColumnNumber (int value)
 Set column number.
virtual void resetBounds (const OsiSolverInterface *solver)
 Reset variable bounds to their original values.
virtual void resetSequenceEtc (int numberColumns, const int *originalColumns)
 Change column numbers after preprocessing.
double originalLowerBound () const
 Original bounds.
void setOriginalLowerBound (double value)
double originalUpperBound () const
void setOriginalUpperBound (double value)
double breakEven () const
 Breakeven e.g 0.7 -> >= 0.7 go up first.
void setBreakEven (double value)
 Set breakeven e.g 0.7 -> >= 0.7 go up first.
 CbcSimpleInteger ()
 CbcSimpleInteger (CbcModel *model, int iColumn, double breakEven=0.5)
 CbcSimpleInteger (CbcModel *model, const OsiSimpleInteger *object)
 CbcSimpleInteger (const CbcSimpleInteger &)
CbcSimpleIntegeroperator= (const CbcSimpleInteger &rhs)
virtual ~CbcSimpleInteger ()
OsiSimpleInteger * osiObject () const
 Construct an OsiSimpleInteger object.
virtual double feasibleRegion (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
 Set bounds to fix the variable at the current (integer) value.
void fillCreateBranch (CbcIntegerBranchingObject *branching, const OsiBranchingInformation *info, int way)
 Fills in a created branching object.
virtual OsiSolverBranch * solverBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info) const
 Create an OsiSolverBranch object.
virtual void feasibleRegion ()
 Set bounds to fix the variable at the current (integer) value.
virtual int columnNumber () const
 Column number if single column object -1 otherwise, so returns >= 0 Used by heuristics.
void setColumnNumber (int value)
 Set column number.
virtual void resetBounds (const OsiSolverInterface *solver)
 Reset variable bounds to their original values.
virtual void resetSequenceEtc (int numberColumns, const int *originalColumns)
 Change column numbers after preprocessing.
double originalLowerBound () const
 Original bounds.
void setOriginalLowerBound (double value)
double originalUpperBound () const
void setOriginalUpperBound (double value)
double breakEven () const
 Breakeven e.g 0.7 -> >= 0.7 go up first.
void setBreakEven (double value)
 Set breakeven e.g 0.7 -> >= 0.7 go up first.
- Public Member Functions inherited from CbcObject
 CbcObject ()
 CbcObject (CbcModel *model)
 CbcObject (const CbcObject &)
CbcObjectoperator= (const CbcObject &rhs)
virtual ~CbcObject ()
 Destructor.
virtual double infeasibility (int &) const
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.
virtual CbcBranchingObjectcreateBranch (OsiSolverInterface *, const OsiBranchingInformation *, int)
virtual OsiBranchingObject * createOsiBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way) const
 Create an Osibranching object and indicate which way to branch first.
virtual OsiSolverBranch * solverBranch () const
 Create an OsiSolverBranch object.
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.
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.
virtual void floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
 Returns floor and ceiling i.e.
virtual CbcObjectUpdateData createUpdateInformation (const OsiSolverInterface *solver, const CbcNode *node, const CbcBranchingObject *branchingObject)
 Pass in information on branch just done and create CbcObjectUpdateData instance.
virtual void updateInformation (const CbcObjectUpdateData &)
 Update object by CbcObjectUpdateData.
int id () const
 Identifier (normally column number in matrix)
void setId (int value)
 Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.
bool optionalObject () const
 Return true if optional branching object i.e.
int position () const
 Get position in object_ list.
void setPosition (int position)
 Set position in object_ list.
void setModel (CbcModel *model)
 update model
CbcModelmodel () const
 Return model.
int preferredWay () const
 If -1 down always chosen first, +1 up always, 0 normal.
void setPreferredWay (int value)
 Set -1 down always chosen first, +1 up always, 0 normal.
virtual void redoSequenceEtc (CbcModel *, int, const int *)
 Redoes data when sequence numbers change.
 CbcObject ()
 CbcObject (CbcModel *model)
 CbcObject (const CbcObject &)
CbcObjectoperator= (const CbcObject &rhs)
virtual ~CbcObject ()
 Destructor.
virtual double infeasibility (int &) const
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.
virtual CbcBranchingObjectcreateBranch (OsiSolverInterface *, const OsiBranchingInformation *, int)
virtual OsiBranchingObject * createOsiBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way) const
 Create an Osibranching object and indicate which way to branch first.
virtual OsiSolverBranch * solverBranch () const
 Create an OsiSolverBranch object.
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.
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.
virtual void floorCeiling (double &floorValue, double &ceilingValue, double value, double tolerance) const
 Returns floor and ceiling i.e.
virtual CbcObjectUpdateData createUpdateInformation (const OsiSolverInterface *solver, const CbcNode *node, const CbcBranchingObject *branchingObject)
 Pass in information on branch just done and create CbcObjectUpdateData instance.
virtual void updateInformation (const CbcObjectUpdateData &)
 Update object by CbcObjectUpdateData.
int id () const
 Identifier (normally column number in matrix)
void setId (int value)
 Set identifier (normally column number in matrix) but 1000000000 to 1100000000 means optional branching object i.e.
bool optionalObject () const
 Return true if optional branching object i.e.
int position () const
 Get position in object_ list.
void setPosition (int position)
 Set position in object_ list.
void setModel (CbcModel *model)
 update model
CbcModelmodel () const
 Return model.
int preferredWay () const
 If -1 down always chosen first, +1 up always, 0 normal.
void setPreferredWay (int value)
 Set -1 down always chosen first, +1 up always, 0 normal.
virtual void redoSequenceEtc (CbcModel *, int, const int *)
 Redoes data when sequence numbers change.

Protected Attributes

double downPseudoCost_
 data
double upPseudoCost_
 Up pseudo cost.
double upDownSeparator_
 Up/down separator If >0.0 then do first branch up if value-floor(value) >= this value.
int method_
 Method - 0 - normal - return min (up,down) 1 - if before any solution return CoinMax(up,down) 2 - if before branched solution return CoinMax(up,down) 3 - always return CoinMax(up,down)
- Protected Attributes inherited from CbcSimpleInteger
double originalLower_
 data
double originalUpper_
 Original upper bound.
double breakEven_
 Breakeven i.e. >= this preferred is up.
int columnNumber_
 Column number in model.
int preferredWay_
 If -1 down always chosen first, +1 up always, 0 normal.
- Protected Attributes inherited from CbcObject
CbcModelmodel_
 data
int id_
 Identifier (normally column number in matrix)
int position_
 Position in object list.

Detailed Description

Define a single integer class but with pseudo costs.

Definition at line 8 of file CbcSimpleIntegerPseudoCost.hpp.


Constructor & Destructor Documentation

CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( )
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( CbcModel model,
int  iColumn,
double  breakEven = 0.5 
)
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( CbcModel model,
int  iColumn,
double  downPseudoCost,
double  upPseudoCost 
)
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( CbcModel model,
int  dummy,
int  iColumn,
double  downPseudoCost,
double  upPseudoCost 
)
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( const CbcSimpleIntegerPseudoCost )
virtual CbcSimpleIntegerPseudoCost::~CbcSimpleIntegerPseudoCost ( )
virtual
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( )
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( CbcModel model,
int  iColumn,
double  breakEven = 0.5 
)
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( CbcModel model,
int  iColumn,
double  downPseudoCost,
double  upPseudoCost 
)
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( CbcModel model,
int  dummy,
int  iColumn,
double  downPseudoCost,
double  upPseudoCost 
)
CbcSimpleIntegerPseudoCost::CbcSimpleIntegerPseudoCost ( const CbcSimpleIntegerPseudoCost )
virtual CbcSimpleIntegerPseudoCost::~CbcSimpleIntegerPseudoCost ( )
virtual

Member Function Documentation

virtual CbcObject* CbcSimpleIntegerPseudoCost::clone ( ) const
virtual

Clone.

Reimplemented from CbcSimpleInteger.

CbcSimpleIntegerPseudoCost& CbcSimpleIntegerPseudoCost::operator= ( const CbcSimpleIntegerPseudoCost rhs)
virtual double CbcSimpleIntegerPseudoCost::infeasibility ( const OsiBranchingInformation *  info,
int &  preferredWay 
) const
virtual

Infeasibility - large is 0.5.

Reimplemented from CbcSimpleInteger.

virtual CbcBranchingObject* CbcSimpleIntegerPseudoCost::createCbcBranch ( OsiSolverInterface *  solver,
const OsiBranchingInformation *  info,
int  way 
)
virtual

Creates a branching object.

Reimplemented from CbcSimpleInteger.

double CbcSimpleIntegerPseudoCost::downPseudoCost ( ) const
inline

Down pseudo cost.

Definition at line 45 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setDownPseudoCost ( double  value)
inline

Set down pseudo cost.

Definition at line 49 of file CbcSimpleIntegerPseudoCost.hpp.

double CbcSimpleIntegerPseudoCost::upPseudoCost ( ) const
inline

Up pseudo cost.

Definition at line 54 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setUpPseudoCost ( double  value)
inline

Set up pseudo cost.

Definition at line 58 of file CbcSimpleIntegerPseudoCost.hpp.

double CbcSimpleIntegerPseudoCost::upDownSeparator ( ) const
inline

Up down separator.

Definition at line 63 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setUpDownSeparator ( double  value)
inline

Set up down separator.

Definition at line 67 of file CbcSimpleIntegerPseudoCost.hpp.

virtual double CbcSimpleIntegerPseudoCost::upEstimate ( ) const
virtual

Return "up" estimate.

virtual double CbcSimpleIntegerPseudoCost::downEstimate ( ) const
virtual

Return "down" estimate (default 1.0e-5)

int CbcSimpleIntegerPseudoCost::method ( ) const
inline

method - see below for details

Definition at line 77 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setMethod ( int  value)
inline

Set method.

Definition at line 81 of file CbcSimpleIntegerPseudoCost.hpp.

virtual CbcObject* CbcSimpleIntegerPseudoCost::clone ( ) const
virtual

Clone.

Reimplemented from CbcSimpleInteger.

CbcSimpleIntegerPseudoCost& CbcSimpleIntegerPseudoCost::operator= ( const CbcSimpleIntegerPseudoCost rhs)
virtual double CbcSimpleIntegerPseudoCost::infeasibility ( const OsiBranchingInformation *  info,
int &  preferredWay 
) const
virtual

Infeasibility - large is 0.5.

Reimplemented from CbcSimpleInteger.

virtual CbcBranchingObject* CbcSimpleIntegerPseudoCost::createCbcBranch ( OsiSolverInterface *  solver,
const OsiBranchingInformation *  info,
int  way 
)
virtual

Creates a branching object.

Reimplemented from CbcSimpleInteger.

double CbcSimpleIntegerPseudoCost::downPseudoCost ( ) const
inline

Down pseudo cost.

Definition at line 45 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setDownPseudoCost ( double  value)
inline

Set down pseudo cost.

Definition at line 49 of file CbcSimpleIntegerPseudoCost.hpp.

double CbcSimpleIntegerPseudoCost::upPseudoCost ( ) const
inline

Up pseudo cost.

Definition at line 54 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setUpPseudoCost ( double  value)
inline

Set up pseudo cost.

Definition at line 58 of file CbcSimpleIntegerPseudoCost.hpp.

double CbcSimpleIntegerPseudoCost::upDownSeparator ( ) const
inline

Up down separator.

Definition at line 63 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setUpDownSeparator ( double  value)
inline

Set up down separator.

Definition at line 67 of file CbcSimpleIntegerPseudoCost.hpp.

virtual double CbcSimpleIntegerPseudoCost::upEstimate ( ) const
virtual

Return "up" estimate.

virtual double CbcSimpleIntegerPseudoCost::downEstimate ( ) const
virtual

Return "down" estimate (default 1.0e-5)

int CbcSimpleIntegerPseudoCost::method ( ) const
inline

method - see below for details

Definition at line 77 of file CbcSimpleIntegerPseudoCost.hpp.

void CbcSimpleIntegerPseudoCost::setMethod ( int  value)
inline

Set method.

Definition at line 81 of file CbcSimpleIntegerPseudoCost.hpp.


Member Data Documentation

double CbcSimpleIntegerPseudoCost::downPseudoCost_
protected

data

Down pseudo cost

Definition at line 89 of file CbcSimpleIntegerPseudoCost.hpp.

double CbcSimpleIntegerPseudoCost::upPseudoCost_
protected

Up pseudo cost.

Definition at line 91 of file CbcSimpleIntegerPseudoCost.hpp.

double CbcSimpleIntegerPseudoCost::upDownSeparator_
protected

Up/down separator If >0.0 then do first branch up if value-floor(value) >= this value.

Definition at line 96 of file CbcSimpleIntegerPseudoCost.hpp.

int CbcSimpleIntegerPseudoCost::method_
protected

Method - 0 - normal - return min (up,down) 1 - if before any solution return CoinMax(up,down) 2 - if before branched solution return CoinMax(up,down) 3 - always return CoinMax(up,down)

Definition at line 103 of file CbcSimpleIntegerPseudoCost.hpp.


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