OsiCbcSolverInterface Class Reference

Cbc Solver Interface. More...

#include <OsiCbcSolverInterface.hpp>

Inheritance diagram for OsiCbcSolverInterface:
Inheritance graph
[legend]
Collaboration diagram for OsiCbcSolverInterface:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void setObjSense (double s)
 Set objective function sense (1 for min (default), -1 for max,).
virtual void setColSolution (const double *colsol)
 Set the primal solution column values.
virtual void setRowPrice (const double *rowprice)
 Set dual solution vector.
Solve methods



virtual void initialSolve ()
 Solve initial LP relaxation.
virtual void resolve ()
 Resolve an LP relaxation after problem modification.
virtual void branchAndBound ()
 Invoke solver's built-in enumeration algorithm.
Parameter set/get methods

The set methods return true if the parameter was set to the given value, false otherwise.

There can be various reasons for failure: the given parameter is not applicable for the solver (e.g., refactorization frequency for the cbc algorithm), the parameter is not yet implemented for the solver or simply the value of the parameter is out of the range the solver accepts. If a parameter setting call returns false check the details of your solver.

The get methods return true if the given parameter is applicable for the solver and is implemented. In this case the value of the parameter is returned in the second argument. Otherwise they return false.



bool setIntParam (OsiIntParam key, int value)
 Get a hint parameter.
bool setDblParam (OsiDblParam key, double value)
 Get a hint parameter.
bool setStrParam (OsiStrParam key, const std::string &value)
 Get a hint parameter.
bool getIntParam (OsiIntParam key, int &value) const
 Get a hint parameter.
bool getDblParam (OsiDblParam key, double &value) const
 Get a hint parameter.
bool getStrParam (OsiStrParam key, std::string &value) const
 Get a hint parameter.
virtual bool setHintParam (OsiHintParam key, bool yesNo=true, OsiHintStrength strength=OsiHintTry, void *otherInformation=NULL)
 Get a hint parameter.
virtual bool getHintParam (OsiHintParam key, bool &yesNo, OsiHintStrength &strength, void *&otherInformation) const
 Get a hint parameter.
virtual bool getHintParam (OsiHintParam key, bool &yesNo, OsiHintStrength &strength) const
 Get a hint parameter.
Methods returning info on how the solution process terminated



virtual bool isAbandoned () const
 Are there a numerical difficulties?
virtual bool isProvenOptimal () const
 Is optimality proven?
virtual bool isProvenPrimalInfeasible () const
 Is primal infeasiblity proven?
virtual bool isProvenDualInfeasible () const
 Is dual infeasiblity proven?
virtual bool isPrimalObjectiveLimitReached () const
 Is the given primal objective limit reached?
virtual bool isDualObjectiveLimitReached () const
 Is the given dual objective limit reached?
virtual bool isIterationLimitReached () const
 Iteration limit reached?
WarmStart related methods



virtual CoinWarmStartgetEmptyWarmStart () const
 Get an empty warm start object.
virtual CoinWarmStartgetWarmStart () const
 Get warmstarting information.
virtual bool setWarmStart (const CoinWarmStart *warmstart)
 Set warmstarting information.
Hotstart related methods (primarily used in strong branching). <br>

The user can create a hotstart (a snapshot) of the optimization process then reoptimize over and over again always starting from there.


NOTE: between hotstarted optimizations only bound changes are allowed.



virtual void markHotStart ()
 Create a hotstart point of the optimization process.
virtual void solveFromHotStart ()
 Optimize starting from the hotstart.
virtual void unmarkHotStart ()
 Delete the snapshot.
Methods related to querying the input data



virtual int getNumCols () const
 Get number of columns.
virtual int getNumRows () const
 Get number of rows.
virtual int getNumElements () const
 Get number of nonzero elements.
virtual const double * getColLower () const
 Get pointer to array[getNumCols()] of column lower bounds.
virtual const double * getColUpper () const
 Get pointer to array[getNumCols()] of column upper bounds.
virtual const char * getRowSense () const
 Get pointer to array[getNumRows()] of row constraint senses.
virtual const double * getRightHandSide () const
 Get pointer to array[getNumRows()] of rows right-hand sides.
virtual const double * getRowRange () const
 Get pointer to array[getNumRows()] of row ranges.
virtual const double * getRowLower () const
 Get pointer to array[getNumRows()] of row lower bounds.
virtual const double * getRowUpper () const
 Get pointer to array[getNumRows()] of row upper bounds.
virtual const double * getObjCoefficients () const
 Get pointer to array[getNumCols()] of objective function coefficients.
virtual double getObjSense () const
 Get objective function sense (1 for min (default), -1 for max).
virtual bool isContinuous (int colNumber) const
 Return true if column is continuous.
virtual const CoinPackedMatrixgetMatrixByRow () const
 Get pointer to row-wise copy of matrix.
virtual const CoinPackedMatrixgetMatrixByCol () const
 Get pointer to column-wise copy of matrix.
virtual double getInfinity () const
 Get solver's value for infinity.
Methods related to querying the solution



virtual const double * getColSolution () const
 Get pointer to array[getNumCols()] of primal solution vector.
virtual const double * getRowPrice () const
 Get pointer to array[getNumRows()] of dual prices.
virtual const double * getReducedCost () const
 Get a pointer to array[getNumCols()] of reduced costs.
virtual const double * getRowActivity () const
 Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector.
virtual double getObjValue () const
 Get objective function value.
virtual int getIterationCount () const
 Get how many iterations it took to solve the problem (whatever "iteration" mean to the solver.
virtual std::vector< double * > getDualRays (int maxNumRays) const
 Get as many dual rays as the solver can provide.
virtual std::vector< double * > getPrimalRays (int maxNumRays) const
 Get as many primal rays as the solver can provide.
Methods for row and column names.

Because OsiCbc is a pass-through class, it's necessary to override any virtual method in order to be sure we catch an override by the underlying solver. See the OsiSolverInterface class documentation for detailed descriptions.



virtual std::string dfltRowColName (char rc, int ndx, unsigned digits=7) const
 Generate a standard name of the form Rnnnnnnn or Cnnnnnnn.
virtual std::string getObjName (unsigned maxLen=std::string::npos) const
 Return the name of the objective function.
virtual void setObjName (std::string name)
 Set the name of the objective function.
virtual std::string getRowName (int rowIndex, unsigned maxLen=std::string::npos) const
 Return the name of the row.
virtual const OsiNameVecgetRowNames ()
 Return a pointer to a vector of row names.
virtual void setRowName (int ndx, std::string name)
 Set a row name.
virtual void setRowNames (OsiNameVec &srcNames, int srcStart, int len, int tgtStart)
 Set multiple row names.
virtual void deleteRowNames (int tgtStart, int len)
 Delete len row names starting at index tgtStart.
virtual std::string getColName (int colIndex, unsigned maxLen=std::string::npos) const
 Return the name of the column.
virtual const OsiNameVecgetColNames ()
 Return a pointer to a vector of column names.
virtual void setColName (int ndx, std::string name)
 Set a column name.
virtual void setColNames (OsiNameVec &srcNames, int srcStart, int len, int tgtStart)
 Set multiple column names.
virtual void deleteColNames (int tgtStart, int len)
 Delete len column names starting at index tgtStart.
Changing bounds on variables and constraints



virtual void setObjCoeff (int elementIndex, double elementValue)
 Set an objective function coefficient.
virtual void setColLower (int elementIndex, double elementValue)
 Set a single column lower bound
Use -DBL_MAX for -infinity.
virtual void setColUpper (int elementIndex, double elementValue)
 Set a single column upper bound
Use DBL_MAX for infinity.
virtual void setColBounds (int elementIndex, double lower, double upper)
 Set a single column lower and upper bound.
virtual void setColSetBounds (const int *indexFirst, const int *indexLast, const double *boundList)
 Set the bounds on a number of columns simultaneously
The default implementation just invokes setColLower() and setColUpper() over and over again.
virtual void setRowLower (int elementIndex, double elementValue)
 Set a single row lower bound
Use -DBL_MAX for -infinity.
virtual void setRowUpper (int elementIndex, double elementValue)
 Set a single row upper bound
Use DBL_MAX for infinity.
virtual void setRowBounds (int elementIndex, double lower, double upper)
 Set a single row lower and upper bound.
virtual void setRowType (int index, char sense, double rightHandSide, double range)
 Set the type of a single row
.
virtual void setRowSetBounds (const int *indexFirst, const int *indexLast, const double *boundList)
 Set the bounds on a number of rows simultaneously
The default implementation just invokes setRowLower() and setRowUpper() over and over again.
virtual void setRowSetTypes (const int *indexFirst, const int *indexLast, const char *senseList, const double *rhsList, const double *rangeList)
 Set the type of a number of rows simultaneously
The default implementation just invokes setRowType() over and over again.
Integrality related changing methods



virtual void setContinuous (int index)
 Set the index-th variable to be a continuous variable.
virtual void setInteger (int index)
 Set the index-th variable to be an integer variable.
virtual void setContinuous (const int *indices, int len)
 Set the variables listed in indices (which is of length len) to be continuous variables.
virtual void setInteger (const int *indices, int len)
 Set the variables listed in indices (which is of length len) to be integer variables.
Methods to expand a problem.<br>

Note that if a column is added then by default it will correspond to a continuous variable.



virtual void addCol (const CoinPackedVectorBase &vec, const double collb, const double colub, const double obj)
 Add a column (primal variable) to the problem.
virtual void addCol (int numberElements, const int *rows, const double *elements, const double collb, const double colub, const double obj)
 Add a column (primal variable) to the problem.
virtual void addCols (const int numcols, const CoinPackedVectorBase *const *cols, const double *collb, const double *colub, const double *obj)
 Add a column (primal variable) to the problem.
virtual void deleteCols (const int num, const int *colIndices)
 Add a column (primal variable) to the problem.
virtual void addRow (const CoinPackedVectorBase &vec, const double rowlb, const double rowub)
 Add a column (primal variable) to the problem.
virtual void addRow (const CoinPackedVectorBase &vec, const char rowsen, const double rowrhs, const double rowrng)
 Add a column (primal variable) to the problem.
virtual void addRows (const int numrows, const CoinPackedVectorBase *const *rows, const double *rowlb, const double *rowub)
 Add a column (primal variable) to the problem.
virtual void addRows (const int numrows, const CoinPackedVectorBase *const *rows, const char *rowsen, const double *rowrhs, const double *rowrng)
 Add a column (primal variable) to the problem.
virtual void deleteRows (const int num, const int *rowIndices)
 Add a column (primal variable) to the problem.
virtual void applyRowCuts (int numberCuts, const OsiRowCut *cuts)
 Apply a collection of row cuts which are all effective.
virtual void applyRowCuts (int numberCuts, const OsiRowCut **cuts)
 Apply a collection of row cuts which are all effective.
Methods to input a problem



virtual void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds).
virtual void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, double *&rowlb, double *&rowub)
 Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by lower and upper bounds).
virtual void loadProblem (const CoinPackedMatrix &matrix, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Load in an problem by copying the arguments (the constraints on the rows are given by sense/rhs/range triplets).
virtual void assignProblem (CoinPackedMatrix *&matrix, double *&collb, double *&colub, double *&obj, char *&rowsen, double *&rowrhs, double *&rowrng)
 Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by sense/rhs/range triplets).
virtual void loadProblem (const int numcols, const int numrows, const CoinBigIndex *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const double *rowlb, const double *rowub)
 Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).
virtual void loadProblem (const int numcols, const int numrows, const CoinBigIndex *start, const int *index, const double *value, const double *collb, const double *colub, const double *obj, const char *rowsen, const double *rowrhs, const double *rowrng)
 Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).
virtual int readMps (const char *filename, const char *extension="mps")
 Read an mps file from the given filename (defaults to Osi reader) - returns number of errors (see OsiMpsReader class).
virtual void writeMps (const char *filename, const char *extension="mps", double objSense=0.0) const
 Write the problem into an mps file of the given filename.
virtual int writeMpsNative (const char *filename, const char **rowNames, const char **columnNames, int formatType=0, int numberAcross=2, double objSense=0.0) const
 Write the problem into an mps file of the given filename, names may be null.
Message handling (extra for Cbc messages).

Normally I presume you would want the same language.

If not then you could use underlying model pointer



void newLanguage (CoinMessages::Language language)
 Set language.
void setLanguage (CoinMessages::Language language)
 Set language.
Cbc specific public interfaces



CbcModelgetModelPtr () const
 Get pointer to Cbc model.
OsiSolverInterfacegetRealSolverPtr () const
 Get pointer to underlying solver.
void setCutoff (double value)
 Set cutoff bound on the objective function.
double getCutoff () const
 Get the cutoff bound on the objective function - always as minimize.
void setMaximumNodes (int value)
 Set the CbcModel::CbcMaxNumNode maximum node limit.
int getMaximumNodes () const
 Get the CbcModel::CbcMaxNumNode maximum node limit.
void setMaximumSolutions (int value)
 Set the CbcModel::CbcMaxNumSol maximum number of solutions.
int getMaximumSolutions () const
 Get the CbcModel::CbcMaxNumSol maximum number of solutions.
void setMaximumSeconds (double value)
 Set the CbcModel::CbcMaximumSeconds maximum number of seconds.
double getMaximumSeconds () const
 Get the CbcModel::CbcMaximumSeconds maximum number of seconds.
bool isNodeLimitReached () const
 Node limit reached?
bool isSolutionLimitReached () const
 Solution limit reached?
int getNodeCount () const
 Get how many Nodes it took to solve the problem.
int status () const
 Final status of problem - 0 finished, 1 stopped, 2 difficulties.
Constructors and destructors



 OsiCbcSolverInterface (OsiSolverInterface *solver=NULL, CbcStrategy *strategy=NULL)
 Default Constructor.
virtual OsiSolverInterfaceclone (bool copyData=true) const
 Clone.
 OsiCbcSolverInterface (const OsiCbcSolverInterface &)
 Copy constructor.
OsiCbcSolverInterfaceoperator= (const OsiCbcSolverInterface &rhs)
 Assignment operator.
virtual ~OsiCbcSolverInterface ()
 Destructor.

Protected Member Functions

Protected methods



virtual void applyRowCut (const OsiRowCut &rc)
 Apply a row cut (append to constraint matrix).
virtual void applyColCut (const OsiColCut &cc)
 Apply a column cut (adjust one or more bounds).

Protected Attributes

Protected member data



CbcModelmodelPtr_
 Cbc model represented by this class instance.

Friends

void OsiCbcSolverInterfaceUnitTest (const std::string &mpsDir, const std::string &netlibDir)
 A function that tests the methods in the OsiCbcSolverInterface class.

Detailed Description

Cbc Solver Interface.

Instantiation of OsiCbcSolverInterface for the Model Algorithm.

Definition at line 32 of file OsiCbcSolverInterface.hpp.


Constructor & Destructor Documentation

OsiCbcSolverInterface::OsiCbcSolverInterface ( OsiSolverInterface solver = NULL,
CbcStrategy strategy = NULL 
)

Default Constructor.

OsiCbcSolverInterface::OsiCbcSolverInterface ( const OsiCbcSolverInterface  ) 

Copy constructor.

virtual OsiCbcSolverInterface::~OsiCbcSolverInterface (  )  [virtual]

Destructor.


Member Function Documentation

virtual void OsiCbcSolverInterface::initialSolve (  )  [virtual]

Solve initial LP relaxation.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::resolve (  )  [virtual]

Resolve an LP relaxation after problem modification.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::branchAndBound (  )  [virtual]

Invoke solver's built-in enumeration algorithm.

Implements OsiSolverInterface.

bool OsiCbcSolverInterface::setIntParam ( OsiIntParam  key,
int  value 
) [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

bool OsiCbcSolverInterface::setDblParam ( OsiDblParam  key,
double  value 
) [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

bool OsiCbcSolverInterface::setStrParam ( OsiStrParam  key,
const std::string &  value 
) [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

bool OsiCbcSolverInterface::getIntParam ( OsiIntParam  key,
int &  value 
) const [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

bool OsiCbcSolverInterface::getDblParam ( OsiDblParam  key,
double &  value 
) const [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

bool OsiCbcSolverInterface::getStrParam ( OsiStrParam  key,
std::string &  value 
) const [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

virtual bool OsiCbcSolverInterface::setHintParam ( OsiHintParam  key,
bool  yesNo = true,
OsiHintStrength  strength = OsiHintTry,
void *  otherInformation = NULL 
) [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

virtual bool OsiCbcSolverInterface::getHintParam ( OsiHintParam  key,
bool &  yesNo,
OsiHintStrength strength,
void *&  otherInformation 
) const [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

virtual bool OsiCbcSolverInterface::getHintParam ( OsiHintParam  key,
bool &  yesNo,
OsiHintStrength strength 
) const [virtual]

Get a hint parameter.

Reimplemented from OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isAbandoned (  )  const [virtual]

Are there a numerical difficulties?

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isProvenOptimal (  )  const [virtual]

Is optimality proven?

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isProvenPrimalInfeasible (  )  const [virtual]

Is primal infeasiblity proven?

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isProvenDualInfeasible (  )  const [virtual]

Is dual infeasiblity proven?

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isPrimalObjectiveLimitReached (  )  const [virtual]

Is the given primal objective limit reached?

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isDualObjectiveLimitReached (  )  const [virtual]

Is the given dual objective limit reached?

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isIterationLimitReached (  )  const [virtual]

Iteration limit reached?

Implements OsiSolverInterface.

virtual CoinWarmStart* OsiCbcSolverInterface::getEmptyWarmStart (  )  const [virtual]

Get an empty warm start object.

This routine returns an empty CoinWarmStartBasis object. Its purpose is to provide a way to give a client a warm start basis object of the appropriate type, which can resized and modified as desired.

Implements OsiSolverInterface.

virtual CoinWarmStart* OsiCbcSolverInterface::getWarmStart (  )  const [virtual]

Get warmstarting information.

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::setWarmStart ( const CoinWarmStart warmstart  )  [virtual]

Set warmstarting information.

Return true/false depending on whether the warmstart information was accepted or not.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::markHotStart (  )  [virtual]

Create a hotstart point of the optimization process.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::solveFromHotStart (  )  [virtual]

Optimize starting from the hotstart.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::unmarkHotStart (  )  [virtual]

Delete the snapshot.

Reimplemented from OsiSolverInterface.

virtual int OsiCbcSolverInterface::getNumCols (  )  const [virtual]

Get number of columns.

Implements OsiSolverInterface.

virtual int OsiCbcSolverInterface::getNumRows (  )  const [virtual]

Get number of rows.

Implements OsiSolverInterface.

virtual int OsiCbcSolverInterface::getNumElements (  )  const [virtual]

Get number of nonzero elements.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getColLower (  )  const [virtual]

Get pointer to array[getNumCols()] of column lower bounds.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getColUpper (  )  const [virtual]

Get pointer to array[getNumCols()] of column upper bounds.

Implements OsiSolverInterface.

virtual const char* OsiCbcSolverInterface::getRowSense (  )  const [virtual]

Get pointer to array[getNumRows()] of row constraint senses.

  • 'L' <= constraint
  • 'E' = constraint
  • 'G' >= constraint
  • 'R' ranged constraint
  • 'N' free constraint

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getRightHandSide (  )  const [virtual]

Get pointer to array[getNumRows()] of rows right-hand sides.

  • if rowsense()[i] == 'L' then rhs()[i] == rowupper()[i]
  • if rowsense()[i] == 'G' then rhs()[i] == rowlower()[i]
  • if rowsense()[i] == 'R' then rhs()[i] == rowupper()[i]
  • if rowsense()[i] == 'N' then rhs()[i] == 0.0

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getRowRange (  )  const [virtual]

Get pointer to array[getNumRows()] of row ranges.

  • if rowsense()[i] == 'R' then rowrange()[i] == rowupper()[i] - rowlower()[i]
  • if rowsense()[i] != 'R' then rowrange()[i] is undefined

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getRowLower (  )  const [virtual]

Get pointer to array[getNumRows()] of row lower bounds.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getRowUpper (  )  const [virtual]

Get pointer to array[getNumRows()] of row upper bounds.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getObjCoefficients (  )  const [virtual]

Get pointer to array[getNumCols()] of objective function coefficients.

Implements OsiSolverInterface.

virtual double OsiCbcSolverInterface::getObjSense (  )  const [virtual]

Get objective function sense (1 for min (default), -1 for max).

Implements OsiSolverInterface.

virtual bool OsiCbcSolverInterface::isContinuous ( int  colNumber  )  const [virtual]

Return true if column is continuous.

Implements OsiSolverInterface.

virtual const CoinPackedMatrix* OsiCbcSolverInterface::getMatrixByRow (  )  const [virtual]

Get pointer to row-wise copy of matrix.

Implements OsiSolverInterface.

virtual const CoinPackedMatrix* OsiCbcSolverInterface::getMatrixByCol (  )  const [virtual]

Get pointer to column-wise copy of matrix.

Implements OsiSolverInterface.

virtual double OsiCbcSolverInterface::getInfinity (  )  const [virtual]

Get solver's value for infinity.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getColSolution (  )  const [virtual]

Get pointer to array[getNumCols()] of primal solution vector.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getRowPrice (  )  const [virtual]

Get pointer to array[getNumRows()] of dual prices.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getReducedCost (  )  const [virtual]

Get a pointer to array[getNumCols()] of reduced costs.

Implements OsiSolverInterface.

virtual const double* OsiCbcSolverInterface::getRowActivity (  )  const [virtual]

Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector.

Implements OsiSolverInterface.

virtual double OsiCbcSolverInterface::getObjValue (  )  const [virtual]

Get objective function value.

Implements OsiSolverInterface.

virtual int OsiCbcSolverInterface::getIterationCount (  )  const [virtual]

Get how many iterations it took to solve the problem (whatever "iteration" mean to the solver.

Implements OsiSolverInterface.

virtual std::vector<double*> OsiCbcSolverInterface::getDualRays ( int  maxNumRays  )  const [virtual]

Get as many dual rays as the solver can provide.

(In case of proven primal infeasibility there should be at least one.)

NOTE for implementers of solver interfaces:
The double pointers in the vector should point to arrays of length getNumRows() and they should be allocated via new[].

NOTE for users of solver interfaces:
It is the user's responsibility to free the double pointers in the vector using delete[].

Implements OsiSolverInterface.

virtual std::vector<double*> OsiCbcSolverInterface::getPrimalRays ( int  maxNumRays  )  const [virtual]

Get as many primal rays as the solver can provide.

(In case of proven dual infeasibility there should be at least one.)

NOTE for implementers of solver interfaces:
The double pointers in the vector should point to arrays of length getNumCols() and they should be allocated via new[].

NOTE for users of solver interfaces:
It is the user's responsibility to free the double pointers in the vector using delete[].

Implements OsiSolverInterface.

virtual std::string OsiCbcSolverInterface::dfltRowColName ( char  rc,
int  ndx,
unsigned  digits = 7 
) const [virtual]

Generate a standard name of the form Rnnnnnnn or Cnnnnnnn.

Reimplemented from OsiSolverInterface.

virtual std::string OsiCbcSolverInterface::getObjName ( unsigned  maxLen = std::string::npos  )  const [virtual]

Return the name of the objective function.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setObjName ( std::string  name  )  [virtual]

Set the name of the objective function.

Reimplemented from OsiSolverInterface.

virtual std::string OsiCbcSolverInterface::getRowName ( int  rowIndex,
unsigned  maxLen = std::string::npos 
) const [virtual]

Return the name of the row.

Reimplemented from OsiSolverInterface.

virtual const OsiNameVec& OsiCbcSolverInterface::getRowNames (  )  [virtual]

Return a pointer to a vector of row names.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowName ( int  ndx,
std::string  name 
) [virtual]

Set a row name.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowNames ( OsiNameVec srcNames,
int  srcStart,
int  len,
int  tgtStart 
) [virtual]

Set multiple row names.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::deleteRowNames ( int  tgtStart,
int  len 
) [virtual]

Delete len row names starting at index tgtStart.

Reimplemented from OsiSolverInterface.

virtual std::string OsiCbcSolverInterface::getColName ( int  colIndex,
unsigned  maxLen = std::string::npos 
) const [virtual]

Return the name of the column.

Reimplemented from OsiSolverInterface.

virtual const OsiNameVec& OsiCbcSolverInterface::getColNames (  )  [virtual]

Return a pointer to a vector of column names.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColName ( int  ndx,
std::string  name 
) [virtual]

Set a column name.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColNames ( OsiNameVec srcNames,
int  srcStart,
int  len,
int  tgtStart 
) [virtual]

Set multiple column names.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::deleteColNames ( int  tgtStart,
int  len 
) [virtual]

Delete len column names starting at index tgtStart.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setObjCoeff ( int  elementIndex,
double  elementValue 
) [virtual]

Set an objective function coefficient.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColLower ( int  elementIndex,
double  elementValue 
) [virtual]

Set a single column lower bound
Use -DBL_MAX for -infinity.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColUpper ( int  elementIndex,
double  elementValue 
) [virtual]

Set a single column upper bound
Use DBL_MAX for infinity.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColBounds ( int  elementIndex,
double  lower,
double  upper 
) [virtual]

Set a single column lower and upper bound.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColSetBounds ( const int *  indexFirst,
const int *  indexLast,
const double *  boundList 
) [virtual]

Set the bounds on a number of columns simultaneously
The default implementation just invokes setColLower() and setColUpper() over and over again.

Parameters:
indexFirst,indexLast pointers to the beginning and after the end of the array of the indices of the variables whose either bound changes
boundList the new lower/upper bound pairs for the variables

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowLower ( int  elementIndex,
double  elementValue 
) [virtual]

Set a single row lower bound
Use -DBL_MAX for -infinity.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowUpper ( int  elementIndex,
double  elementValue 
) [virtual]

Set a single row upper bound
Use DBL_MAX for infinity.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowBounds ( int  elementIndex,
double  lower,
double  upper 
) [virtual]

Set a single row lower and upper bound.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowType ( int  index,
char  sense,
double  rightHandSide,
double  range 
) [virtual]

Set the type of a single row
.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowSetBounds ( const int *  indexFirst,
const int *  indexLast,
const double *  boundList 
) [virtual]

Set the bounds on a number of rows simultaneously
The default implementation just invokes setRowLower() and setRowUpper() over and over again.

Parameters:
indexFirst,indexLast pointers to the beginning and after the end of the array of the indices of the constraints whose either bound changes
boundList the new lower/upper bound pairs for the constraints

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowSetTypes ( const int *  indexFirst,
const int *  indexLast,
const char *  senseList,
const double *  rhsList,
const double *  rangeList 
) [virtual]

Set the type of a number of rows simultaneously
The default implementation just invokes setRowType() over and over again.

Parameters:
indexFirst,indexLast pointers to the beginning and after the end of the array of the indices of the constraints whose any characteristics changes
senseList the new senses
rhsList the new right hand sides
rangeList the new ranges

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setContinuous ( int  index  )  [virtual]

Set the index-th variable to be a continuous variable.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setInteger ( int  index  )  [virtual]

Set the index-th variable to be an integer variable.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setContinuous ( const int *  indices,
int  len 
) [virtual]

Set the variables listed in indices (which is of length len) to be continuous variables.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setInteger ( const int *  indices,
int  len 
) [virtual]

Set the variables listed in indices (which is of length len) to be integer variables.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::setObjSense ( double  s  )  [virtual]

Set objective function sense (1 for min (default), -1 for max,).

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setColSolution ( const double *  colsol  )  [virtual]

Set the primal solution column values.

colsol[numcols()] is an array of values of the problem column variables. These values are copied to memory owned by the solver object or the solver. They will be returned as the result of colsol() until changed by another call to setColsol() or by a call to any solver routine. Whether the solver makes use of the solution in any way is solver-dependent.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::setRowPrice ( const double *  rowprice  )  [virtual]

Set dual solution vector.

rowprice[numrows()] is an array of values of the problem row dual variables. These values are copied to memory owned by the solver object or the solver. They will be returned as the result of rowprice() until changed by another call to setRowprice() or by a call to any solver routine. Whether the solver makes use of the solution in any way is solver-dependent.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::addCol ( const CoinPackedVectorBase vec,
const double  collb,
const double  colub,
const double  obj 
) [virtual]

Add a column (primal variable) to the problem.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::addCol ( int  numberElements,
const int *  rows,
const double *  elements,
const double  collb,
const double  colub,
const double  obj 
) [virtual]

Add a column (primal variable) to the problem.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::addCols ( const int  numcols,
const CoinPackedVectorBase *const *  cols,
const double *  collb,
const double *  colub,
const double *  obj 
) [virtual]

Add a column (primal variable) to the problem.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::deleteCols ( const int  num,
const int *  colIndices 
) [virtual]

Add a column (primal variable) to the problem.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::addRow ( const CoinPackedVectorBase vec,
const double  rowlb,
const double  rowub 
) [virtual]

Add a column (primal variable) to the problem.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::addRow ( const CoinPackedVectorBase vec,
const char  rowsen,
const double  rowrhs,
const double  rowrng 
) [virtual]

Add a column (primal variable) to the problem.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::addRows ( const int  numrows,
const CoinPackedVectorBase *const *  rows,
const double *  rowlb,
const double *  rowub 
) [virtual]

Add a column (primal variable) to the problem.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::addRows ( const int  numrows,
const CoinPackedVectorBase *const *  rows,
const char *  rowsen,
const double *  rowrhs,
const double *  rowrng 
) [virtual]

Add a column (primal variable) to the problem.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::deleteRows ( const int  num,
const int *  rowIndices 
) [virtual]

Add a column (primal variable) to the problem.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::applyRowCuts ( int  numberCuts,
const OsiRowCut cuts 
) [virtual]

Apply a collection of row cuts which are all effective.

applyCuts seems to do one at a time which seems inefficient.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::applyRowCuts ( int  numberCuts,
const OsiRowCut **  cuts 
) [virtual]

Apply a collection of row cuts which are all effective.

applyCuts seems to do one at a time which seems inefficient. This uses array of pointers

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::loadProblem ( const CoinPackedMatrix matrix,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub 
) [virtual]

Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds).

If a pointer is 0 then the following values are the default:

  • colub: all columns have upper bound infinity
  • collb: all columns have lower bound 0
  • rowub: all rows have upper bound infinity
  • rowlb: all rows have lower bound -infinity
  • obj: all variables have 0 objective coefficient

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::assignProblem ( CoinPackedMatrix *&  matrix,
double *&  collb,
double *&  colub,
double *&  obj,
double *&  rowlb,
double *&  rowub 
) [virtual]

Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by lower and upper bounds).

For default values see the previous method.
WARNING: The arguments passed to this method will be freed using the C++ delete and delete[] functions.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::loadProblem ( const CoinPackedMatrix matrix,
const double *  collb,
const double *  colub,
const double *  obj,
const char *  rowsen,
const double *  rowrhs,
const double *  rowrng 
) [virtual]

Load in an problem by copying the arguments (the constraints on the rows are given by sense/rhs/range triplets).

If a pointer is 0 then the following values are the default:

  • colub: all columns have upper bound infinity
  • collb: all columns have lower bound 0
  • obj: all variables have 0 objective coefficient
  • rowsen: all rows are >=
  • rowrhs: all right hand sides are 0
  • rowrng: 0 for the ranged rows

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::assignProblem ( CoinPackedMatrix *&  matrix,
double *&  collb,
double *&  colub,
double *&  obj,
char *&  rowsen,
double *&  rowrhs,
double *&  rowrng 
) [virtual]

Load in an problem by assuming ownership of the arguments (the constraints on the rows are given by sense/rhs/range triplets).

For default values see the previous method.
WARNING: The arguments passed to this method will be freed using the C++ delete and delete[] functions.

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::loadProblem ( const int  numcols,
const int  numrows,
const CoinBigIndex start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const double *  rowlb,
const double *  rowub 
) [virtual]

Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::loadProblem ( const int  numcols,
const int  numrows,
const CoinBigIndex start,
const int *  index,
const double *  value,
const double *  collb,
const double *  colub,
const double *  obj,
const char *  rowsen,
const double *  rowrhs,
const double *  rowrng 
) [virtual]

Just like the other loadProblem() methods except that the matrix is given in a standard column major ordered format (without gaps).

Implements OsiSolverInterface.

virtual int OsiCbcSolverInterface::readMps ( const char *  filename,
const char *  extension = "mps" 
) [virtual]

Read an mps file from the given filename (defaults to Osi reader) - returns number of errors (see OsiMpsReader class).

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::writeMps ( const char *  filename,
const char *  extension = "mps",
double  objSense = 0.0 
) const [virtual]

Write the problem into an mps file of the given filename.

If objSense is non zero then -1.0 forces the code to write a maximization objective and +1.0 to write a minimization one. If 0.0 then solver can do what it wants

Implements OsiSolverInterface.

virtual int OsiCbcSolverInterface::writeMpsNative ( const char *  filename,
const char **  rowNames,
const char **  columnNames,
int  formatType = 0,
int  numberAcross = 2,
double  objSense = 0.0 
) const [virtual]

Write the problem into an mps file of the given filename, names may be null.

formatType is 0 - normal 1 - extra accuracy 2 - IEEE hex (later)

Returns non-zero on I/O error

void OsiCbcSolverInterface::newLanguage ( CoinMessages::Language  language  ) 

Set language.

Reimplemented from OsiSolverInterface.

void OsiCbcSolverInterface::setLanguage ( CoinMessages::Language  language  )  [inline]

Set language.

Reimplemented from OsiSolverInterface.

Definition at line 650 of file OsiCbcSolverInterface.hpp.

CbcModel* OsiCbcSolverInterface::getModelPtr (  )  const [inline]

Get pointer to Cbc model.

Definition at line 658 of file OsiCbcSolverInterface.hpp.

OsiSolverInterface* OsiCbcSolverInterface::getRealSolverPtr (  )  const [inline]

Get pointer to underlying solver.

Definition at line 661 of file OsiCbcSolverInterface.hpp.

void OsiCbcSolverInterface::setCutoff ( double  value  )  [inline]

Set cutoff bound on the objective function.

Definition at line 664 of file OsiCbcSolverInterface.hpp.

double OsiCbcSolverInterface::getCutoff (  )  const [inline]

Get the cutoff bound on the objective function - always as minimize.

Definition at line 667 of file OsiCbcSolverInterface.hpp.

void OsiCbcSolverInterface::setMaximumNodes ( int  value  )  [inline]

Set the CbcModel::CbcMaxNumNode maximum node limit.

Definition at line 670 of file OsiCbcSolverInterface.hpp.

int OsiCbcSolverInterface::getMaximumNodes (  )  const [inline]

Get the CbcModel::CbcMaxNumNode maximum node limit.

Definition at line 673 of file OsiCbcSolverInterface.hpp.

void OsiCbcSolverInterface::setMaximumSolutions ( int  value  )  [inline]

Set the CbcModel::CbcMaxNumSol maximum number of solutions.

Definition at line 676 of file OsiCbcSolverInterface.hpp.

int OsiCbcSolverInterface::getMaximumSolutions (  )  const [inline]

Get the CbcModel::CbcMaxNumSol maximum number of solutions.

Definition at line 679 of file OsiCbcSolverInterface.hpp.

void OsiCbcSolverInterface::setMaximumSeconds ( double  value  )  [inline]

Set the CbcModel::CbcMaximumSeconds maximum number of seconds.

Definition at line 682 of file OsiCbcSolverInterface.hpp.

double OsiCbcSolverInterface::getMaximumSeconds (  )  const [inline]

Get the CbcModel::CbcMaximumSeconds maximum number of seconds.

Definition at line 685 of file OsiCbcSolverInterface.hpp.

bool OsiCbcSolverInterface::isNodeLimitReached (  )  const [inline]

Node limit reached?

Definition at line 688 of file OsiCbcSolverInterface.hpp.

bool OsiCbcSolverInterface::isSolutionLimitReached (  )  const [inline]

Solution limit reached?

Definition at line 691 of file OsiCbcSolverInterface.hpp.

int OsiCbcSolverInterface::getNodeCount (  )  const [inline]

Get how many Nodes it took to solve the problem.

Definition at line 694 of file OsiCbcSolverInterface.hpp.

int OsiCbcSolverInterface::status (  )  const [inline]

Final status of problem - 0 finished, 1 stopped, 2 difficulties.

Definition at line 697 of file OsiCbcSolverInterface.hpp.

virtual OsiSolverInterface* OsiCbcSolverInterface::clone ( bool  copyData = true  )  const [virtual]

Clone.

Implements OsiSolverInterface.

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

Assignment operator.

Reimplemented from OsiSolverInterface.

virtual void OsiCbcSolverInterface::applyRowCut ( const OsiRowCut rc  )  [protected, virtual]

Apply a row cut (append to constraint matrix).

Implements OsiSolverInterface.

virtual void OsiCbcSolverInterface::applyColCut ( const OsiColCut cc  )  [protected, virtual]

Apply a column cut (adjust one or more bounds).

Implements OsiSolverInterface.


Friends And Related Function Documentation

void OsiCbcSolverInterfaceUnitTest ( const std::string &  mpsDir,
const std::string &  netlibDir 
) [friend]

A function that tests the methods in the OsiCbcSolverInterface class.

The only reason for it not to be a member method is that this way it doesn't have to be compiled into the library. And that's a gain, because the library should be compiled with optimization on, but this method should be compiled with debugging. Also, if this method is compiled with optimization, the compilation takes 10-15 minutes and the machine pages (has 256M core memory!)...


Member Data Documentation

Cbc model represented by this class instance.

Definition at line 742 of file OsiCbcSolverInterface.hpp.


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

Generated on 15 Mar 2015 for Coin-All by  doxygen 1.6.1