CbcObject Class Reference
#include <CbcBranchBase.hpp>
Public Member Functions | |
| CbcObject () | |
| CbcObject (CbcModel *model) | |
| CbcObject (const CbcObject &) | |
| CbcObject & | operator= (const CbcObject &rhs) |
| Assignment operator. | |
| virtual CbcObject * | clone () const =0 |
| Clone. | |
| virtual | ~CbcObject () |
| Destructor. | |
| virtual double | infeasibility (int &preferredWay) const =0 |
| Infeasibility of the object. | |
| virtual double | infeasibility (const OsiBranchingInformation *info, int &preferredWay) const |
| Dummy one for compatibility. | |
| virtual void | feasibleRegion ()=0 |
| For the variable(s) referenced by the object, look at the current solution and set bounds to match the solution. | |
| virtual double | feasibleRegion (OsiSolverInterface *solver, const OsiBranchingInformation *info) const |
| Dummy one for compatibility. | |
| virtual CbcBranchingObject * | createBranch (int way)=0 |
| Create a branching object and indicate which way to branch first. | |
| virtual double | infeasibility (const OsiSolverInterface *solver, int &preferredWay) const |
| Infeasibility of the object. | |
| 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 OsiBranchingObject * | createBranch (OsiSolverInterface *solver, int way) const |
| Create a branching object and indicate which way to branch first. | |
| virtual OsiBranchingObject * | createBranch (OsiSolverInterface *solver, const OsiBranchingInformation *info, int way) const |
| Create a branching object and indicate which way to branch first. | |
| virtual OsiSolverBranch * | solverBranch () const |
| Create an OsiSolverBranch object. | |
| virtual CbcBranchingObject * | preferredNewFeasible () const |
| Given a valid solution (with reduced costs, etc. | |
| virtual CbcBranchingObject * | notPreferredNewFeasible () const |
| Given a valid solution (with reduced costs, etc. | |
| virtual void | resetBounds (const OsiSolverInterface *solver) |
| Reset variable bounds to their original values. | |
| 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 &data) |
| Update object by CbcObjectUpdateData. | |
| int | id () const |
| Identifier (normally column number in matrix). | |
| void | setModel (CbcModel *model) |
| update model | |
| CbcModel * | model () 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 *model, int numberColumns, const int *originalColumns) |
| Redoes data when sequence numbers change. | |
Protected Attributes | |
| CbcModel * | model_ |
| data | |
| int | id_ |
| Identifier (normally column number in matrix). | |
| int | preferredWay_ |
| If -1 down always chosen first, +1 up always, 0 normal. | |
Detailed Description
Definition at line 73 of file CbcBranchBase.hpp.
Constructor & Destructor Documentation
| CbcObject::CbcObject | ( | ) |
| CbcObject::CbcObject | ( | CbcModel * | model | ) |
| CbcObject::CbcObject | ( | const CbcObject & | ) |
| virtual CbcObject::~CbcObject | ( | ) | [virtual] |
Destructor.
Member Function Documentation
Assignment operator.
Reimplemented from OsiObject.
Reimplemented in CbcFollowOn2, CbcLink, CbcSimpleIntegerFixed, CbcClique, CbcSOS, CbcSimpleInteger, CbcNWay, CbcSimpleIntegerPseudoCost, CbcFollowOn, CbcBranchCut, CbcBranchToFixLots, CbcBranchAllDifferent, CbcSimpleIntegerDynamicPseudoCost, and CbcLotsize.
| virtual CbcObject* CbcObject::clone | ( | ) | const [pure virtual] |
Clone.
Implements OsiObject.
Implemented in CbcFollowOn2, CbcLink, CbcSimpleIntegerFixed, CbcClique, CbcSOS, CbcSimpleInteger, CbcNWay, CbcSimpleIntegerPseudoCost, CbcFollowOn, CbcBranchCut, CbcBranchToFixLots, CbcBranchAllDifferent, CbcSimpleIntegerDynamicPseudoCost, and CbcLotsize.
| virtual double CbcObject::infeasibility | ( | int & | preferredWay | ) | const [pure virtual] |
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
Implemented in CbcFollowOn2, CbcLink, CbcSimpleIntegerFixed, CbcClique, CbcSOS, CbcSimpleInteger, CbcNWay, CbcSimpleIntegerPseudoCost, CbcFollowOn, CbcBranchCut, CbcBranchToFixLots, CbcBranchAllDifferent, CbcSimpleIntegerDynamicPseudoCost, and CbcLotsize.
| virtual double CbcObject::infeasibility | ( | const OsiBranchingInformation * | info, | |
| int & | preferredWay | |||
| ) | const [virtual] |
Dummy one for compatibility.
Implements OsiObject.
| 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 CbcFollowOn2, CbcLink, CbcClique, CbcSOS, CbcSimpleInteger, CbcNWay, CbcFollowOn, CbcBranchCut, and CbcLotsize.
| virtual double CbcObject::feasibleRegion | ( | OsiSolverInterface * | solver, | |
| const OsiBranchingInformation * | info | |||
| ) | const [virtual] |
| virtual CbcBranchingObject* CbcObject::createBranch | ( | int | way | ) | [pure virtual] |
Create a branching object and indicate which way to branch first.
The branching object has to know how to create branches (fix variables, etc.)
Implemented in CbcFollowOn2, CbcLink, CbcClique, CbcSOS, CbcSimpleInteger, CbcNWay, CbcSimpleIntegerPseudoCost, CbcFollowOn, CbcBranchCut, CbcBranchToFixLots, CbcBranchAllDifferent, CbcSimpleIntegerDynamicPseudoCost, and CbcLotsize.
| virtual double CbcObject::infeasibility | ( | const OsiSolverInterface * | solver, | |
| int & | preferredWay | |||
| ) | const [virtual] |
Infeasibility of the object.
This is some measure of the infeasibility of the object. 0.0 indicates that the object is satisfied.
The preferred branching direction is returned in way,
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
This should also set mutable infeasibility_ and whichWay_ This is for instant re-use for speed
Reimplemented from OsiObject.
| 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 OsiBranchingObject* CbcObject::createBranch | ( | OsiSolverInterface * | solver, | |
| int | way | |||
| ) | const [virtual] |
Create a branching object and indicate which way to branch first.
The branching object has to know how to create branches (fix variables, etc.)
| virtual OsiBranchingObject* CbcObject::createBranch | ( | OsiSolverInterface * | solver, | |
| const OsiBranchingInformation * | info, | |||
| int | way | |||
| ) | const [virtual] |
Create a branching object and indicate which way to branch first.
The branching object has to know how to create branches (fix variables, etc.)
Implements OsiObject.
| virtual OsiSolverBranch* CbcObject::solverBranch | ( | ) | const [virtual] |
Create an OsiSolverBranch object.
This returns NULL if branch not represented by bound changes
Reimplemented in CbcSOS, and CbcSimpleIntegerDynamicPseudoCost.
| virtual CbcBranchingObject* CbcObject::preferredNewFeasible | ( | ) | const [inline, virtual] |
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 178 of file CbcBranchBase.hpp.
| virtual CbcBranchingObject* CbcObject::notPreferredNewFeasible | ( | ) | const [inline, virtual] |
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 189 of file CbcBranchBase.hpp.
| virtual void CbcObject::resetBounds | ( | const OsiSolverInterface * | solver | ) | [inline, virtual] |
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 196 of file CbcBranchBase.hpp.
| virtual void CbcObject::floorCeiling | ( | double & | floorValue, | |
| double & | ceilingValue, | |||
| double | value, | |||
| double | tolerance | |||
| ) | const [virtual] |
| 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.
| virtual void CbcObject::updateInformation | ( | const CbcObjectUpdateData & | data | ) | [inline, virtual] |
Update object by CbcObjectUpdateData.
Reimplemented in CbcSimpleIntegerDynamicPseudoCost.
Definition at line 211 of file CbcBranchBase.hpp.
| int CbcObject::id | ( | ) | const [inline] |
Identifier (normally column number in matrix).
Definition at line 214 of file CbcBranchBase.hpp.
| void CbcObject::setModel | ( | CbcModel * | model | ) | [inline] |
update model
Definition at line 218 of file CbcBranchBase.hpp.
| CbcModel* CbcObject::model | ( | ) | const [inline] |
Return model.
Definition at line 222 of file CbcBranchBase.hpp.
| int CbcObject::preferredWay | ( | ) | const [inline, virtual] |
If -1 down always chosen first, +1 up always, 0 normal.
Reimplemented from OsiObject.
Definition at line 226 of file CbcBranchBase.hpp.
| void CbcObject::setPreferredWay | ( | int | value | ) | [inline] |
Set -1 down always chosen first, +1 up always, 0 normal.
Definition at line 229 of file CbcBranchBase.hpp.
| virtual void CbcObject::redoSequenceEtc | ( | CbcModel * | model, | |
| int | numberColumns, | |||
| const int * | originalColumns | |||
| ) | [inline, virtual] |
Redoes data when sequence numbers change.
Reimplemented in CbcClique, CbcSOS, and CbcNWay.
Definition at line 232 of file CbcBranchBase.hpp.
Member Data Documentation
CbcModel* CbcObject::model_ [protected] |
int CbcObject::id_ [protected] |
Identifier (normally column number in matrix).
Definition at line 240 of file CbcBranchBase.hpp.
int CbcObject::preferredWay_ [protected] |
If -1 down always chosen first, +1 up always, 0 normal.
Reimplemented in CbcSimpleInteger.
Definition at line 242 of file CbcBranchBase.hpp.
The documentation for this class was generated from the following file:
- /home/coin/svn-release/OptimizationSuite-1.1.0/Cbc/src/CbcBranchBase.hpp
