Cbc Solver Interface. More...

#include <OsiCbcSolverInterface.hpp>

Inheritance diagram for OsiCbcSolverInterface:

Collaboration diagram for OsiCbcSolverInterface:

Public Member Functions
Solve methods
virtual void	initialSolve ()
	Solve initial LP relaxation. More...

virtual void	resolve ()
	Resolve an LP relaxation after problem modification. More...

virtual void	branchAndBound ()
	Invoke solver's built-in enumeration algorithm. More...

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)

bool	setDblParam (OsiDblParam key, double value)

bool	setStrParam (OsiStrParam key, const std::string &value)

bool	getIntParam (OsiIntParam key, int &value) const

bool	getDblParam (OsiDblParam key, double &value) const

bool	getStrParam (OsiStrParam key, std::string &value) const

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

virtual bool	getHintParam (OsiHintParam key, bool &yesNo, OsiHintStrength &strength, void *&otherInformation) const
	Get a hint parameter. More...

virtual bool	getHintParam (OsiHintParam key, bool &yesNo, OsiHintStrength &strength) const
	Get a hint parameter. More...

Methods returning info on how the solution process terminated
virtual bool	isAbandoned () const
	Are there a numerical difficulties? More...

virtual bool	isProvenOptimal () const
	Is optimality proven? More...

virtual bool	isProvenPrimalInfeasible () const
	Is primal infeasiblity proven? More...

virtual bool	isProvenDualInfeasible () const
	Is dual infeasiblity proven? More...

virtual bool	isPrimalObjectiveLimitReached () const
	Is the given primal objective limit reached? More...

virtual bool	isDualObjectiveLimitReached () const
	Is the given dual objective limit reached? More...

virtual bool	isIterationLimitReached () const
	Iteration limit reached? More...

WarmStart related methods
virtual CoinWarmStart *	getEmptyWarmStart () const
	Get an empty warm start object. More...

virtual CoinWarmStart *	getWarmStart () const
	Get warmstarting information. More...

virtual bool	setWarmStart (const CoinWarmStart *warmstart)
	Set warmstarting information. More...

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. More...

virtual void	solveFromHotStart ()
	Optimize starting from the hotstart. More...

virtual void	unmarkHotStart ()
	Delete the snapshot. More...

Methods related to querying the input data
virtual int	getNumCols () const
	Get number of columns. More...

virtual int	getNumRows () const
	Get number of rows. More...

virtual CoinBigIndex	getNumElements () const
	Get number of nonzero elements. More...

virtual const double *	getColLower () const
	Get pointer to array[getNumCols()] of column lower bounds. More...

virtual const double *	getColUpper () const
	Get pointer to array[getNumCols()] of column upper bounds. More...

virtual const char *	getRowSense () const
	Get pointer to array[getNumRows()] of row constraint senses. More...

virtual const double *	getRightHandSide () const
	Get pointer to array[getNumRows()] of rows right-hand sides. More...

virtual const double *	getRowRange () const
	Get pointer to array[getNumRows()] of row ranges. More...

virtual const double *	getRowLower () const
	Get pointer to array[getNumRows()] of row lower bounds. More...

virtual const double *	getRowUpper () const
	Get pointer to array[getNumRows()] of row upper bounds. More...

virtual const double *	getObjCoefficients () const
	Get pointer to array[getNumCols()] of objective function coefficients. More...

virtual double	getObjSense () const
	Get objective function sense (1 for min (default), -1 for max) More...

virtual bool	isContinuous (int colNumber) const
	Return true if column is continuous. More...

virtual const CoinPackedMatrix *	getMatrixByRow () const
	Get pointer to row-wise copy of matrix. More...

virtual const CoinPackedMatrix *	getMatrixByCol () const
	Get pointer to column-wise copy of matrix. More...

virtual double	getInfinity () const
	Get solver's value for infinity. More...

Methods related to querying the solution
virtual const double *	getColSolution () const
	Get pointer to array[getNumCols()] of primal solution vector. More...

virtual const double *	getRowPrice () const
	Get pointer to array[getNumRows()] of dual prices. More...

virtual const double *	getReducedCost () const
	Get a pointer to array[getNumCols()] of reduced costs. More...

virtual const double *	getRowActivity () const
	Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector. More...

virtual double	getObjValue () const
	Get objective function value. More...

virtual int	getIterationCount () const
	Get how many iterations it took to solve the problem (whatever "iteration" mean to the solver. More...

virtual std::vector< double * >	getDualRays (int maxNumRays, bool fullRay=false) const
	Get as many dual rays as the solver can provide. More...

virtual std::vector< double * >	getPrimalRays (int maxNumRays) const
	Get as many primal rays as the solver can provide. More...

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. More...

virtual std::string	getObjName (std::string::size_type maxLen=std::string::npos) const
	Return the name of the objective function. More...

virtual void	setObjName (std::string name)
	Set the name of the objective function. More...

virtual std::string	getRowName (int rowIndex, std::string::size_type maxLen=std::string::npos) const
	Return the name of the row. More...

virtual const OsiNameVec &	getRowNames ()
	Return a pointer to a vector of row names. More...

virtual void	setRowName (int ndx, std::string name)
	Set a row name. More...

virtual void	setRowNames (OsiNameVec &srcNames, int srcStart, int len, int tgtStart)
	Set multiple row names. More...

virtual void	deleteRowNames (int tgtStart, int len)
	Delete len row names starting at index tgtStart. More...

virtual std::string	getColName (int colIndex, std::string::size_type maxLen=std::string::npos) const
	Return the name of the column. More...

virtual const OsiNameVec &	getColNames ()
	Return a pointer to a vector of column names. More...

virtual void	setColName (int ndx, std::string name)
	Set a column name. More...

virtual void	setColNames (OsiNameVec &srcNames, int srcStart, int len, int tgtStart)
	Set multiple column names. More...

virtual void	deleteColNames (int tgtStart, int len)
	Delete len column names starting at index tgtStart. More...

Changing bounds on variables and constraints
virtual void	setObjCoeff (int elementIndex, double elementValue)
	Set an objective function coefficient. More...

virtual void	setColLower (int elementIndex, double elementValue)
	Set a single column lower bound Use -DBL_MAX for -infinity. More...

virtual void	setColUpper (int elementIndex, double elementValue)
	Set a single column upper bound Use DBL_MAX for infinity. More...

virtual void	setColBounds (int elementIndex, double lower, double upper)
	Set a single column lower and upper bound. More...

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. More...

virtual void	setRowLower (int elementIndex, double elementValue)
	Set a single row lower bound Use -DBL_MAX for -infinity. More...

virtual void	setRowUpper (int elementIndex, double elementValue)
	Set a single row upper bound Use DBL_MAX for infinity. More...

virtual void	setRowBounds (int elementIndex, double lower, double upper)
	Set a single row lower and upper bound. More...

virtual void	setRowType (int index, char sense, double rightHandSide, double range)
	Set the type of a single row More...

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. More...

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. More...

Integrality related changing methods
virtual void	setContinuous (int index)
	Set the index-th variable to be a continuous variable. More...

virtual void	setInteger (int index)
	Set the index-th variable to be an integer variable. More...

virtual void	setContinuous (const int *indices, int len)
	Set the variables listed in indices (which is of length len) to be continuous variables. More...

virtual void	setInteger (const int *indices, int len)
	Set the variables listed in indices (which is of length len) to be integer variables. More...

virtual void	setObjSense (double s)
	Set objective function sense (1 for min (default), -1 for max,) More...

virtual void	setColSolution (const double *colsol)
	Set the primal solution column values. More...

virtual void	setRowPrice (const double *rowprice)
	Set dual solution vector. More...

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)

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. More...

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

virtual void	deleteCols (const int num, const int *colIndices)

virtual void	addRow (const CoinPackedVectorBase &vec, const double rowlb, const double rowub)

virtual void	addRow (const CoinPackedVectorBase &vec, const char rowsen, const double rowrhs, const double rowrng)

virtual void	addRows (const int numrows, const CoinPackedVectorBase const rows, const double rowlb, const double rowub)

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

virtual void	deleteRows (const int num, const int *rowIndices)

virtual void	applyRowCuts (int numberCuts, const OsiRowCut *cuts)
	Apply a collection of row cuts which are all effective. More...

virtual void	applyRowCuts (int numberCuts, const OsiRowCut **cuts)
	Apply a collection of row cuts which are all effective. More...

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). More...

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). More...

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). More...

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). More...

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). More...

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). More...

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) More...

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. More...

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. More...

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. More...

void	setLanguage (CoinMessages::Language language)

Cbc specific public interfaces
CbcModel *	getModelPtr () const
	Get pointer to Cbc model. More...

OsiSolverInterface *	getRealSolverPtr () const
	Get pointer to underlying solver. More...

void	setCutoff (double value)
	Set cutoff bound on the objective function. More...

double	getCutoff () const
	Get the cutoff bound on the objective function - always as minimize. More...

void	setMaximumNodes (int value)
	Set the CbcModel::CbcMaxNumNode maximum node limit. More...

int	getMaximumNodes () const
	Get the CbcModel::CbcMaxNumNode maximum node limit. More...

void	setMaximumSolutions (int value)
	Set the CbcModel::CbcMaxNumSol maximum number of solutions. More...

int	getMaximumSolutions () const
	Get the CbcModel::CbcMaxNumSol maximum number of solutions. More...

void	setMaximumSeconds (double value)
	Set the CbcModel::CbcMaximumSeconds maximum number of seconds. More...

double	getMaximumSeconds () const
	Get the CbcModel::CbcMaximumSeconds maximum number of seconds. More...

bool	isNodeLimitReached () const
	Node limit reached? More...

bool	isSolutionLimitReached () const
	Solution limit reached? More...

int	getNodeCount () const
	Get how many Nodes it took to solve the problem. More...

int	status () const
	Final status of problem - 0 finished, 1 stopped, 2 difficulties. More...

virtual void	passInMessageHandler (CoinMessageHandler *handler)
	Pass in a message handler. More...

Constructors and destructors
	OsiCbcSolverInterface (OsiSolverInterface solver=NULL, CbcStrategy strategy=NULL)
	Default Constructor. More...

virtual OsiSolverInterface *	clone (bool copyData=true) const
	Clone. More...

	OsiCbcSolverInterface (const OsiCbcSolverInterface &)
	Copy constructor. More...

OsiCbcSolverInterface &	operator= (const OsiCbcSolverInterface &rhs)
	Assignment operator. More...

virtual	~OsiCbcSolverInterface ()
	Destructor. More...

Protected Member Functions
Protected methods
virtual void	applyRowCut (const OsiRowCut &rc)
	Apply a row cut (append to constraint matrix). More...

virtual void	applyColCut (const OsiColCut &cc)
	Apply a column cut (adjust one or more bounds). More...

Protected Attributes
Protected member data
CbcModel *	modelPtr_
	Cbc model represented by this class instance. More...

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

Detailed Description

Cbc Solver Interface.

Instantiation of OsiCbcSolverInterface for the Model Algorithm.

Definition at line 30 of file OsiCbcSolverInterface.hpp.

Constructor & Destructor Documentation

◆ OsiCbcSolverInterface() [1/2]

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

Default Constructor.

◆ OsiCbcSolverInterface() [2/2]

OsiCbcSolverInterface::OsiCbcSolverInterface ( const OsiCbcSolverInterface & )

Copy constructor.

◆ ~OsiCbcSolverInterface()

virtual OsiCbcSolverInterface::~OsiCbcSolverInterface ( )

virtual

Destructor.

Member Function Documentation

◆ initialSolve()

virtual void OsiCbcSolverInterface::initialSolve ( )

virtual

Solve initial LP relaxation.

◆ resolve()

virtual void OsiCbcSolverInterface::resolve ( )

virtual

Resolve an LP relaxation after problem modification.

◆ branchAndBound()

virtual void OsiCbcSolverInterface::branchAndBound ( )

virtual

Invoke solver's built-in enumeration algorithm.

◆ setIntParam()

bool OsiCbcSolverInterface::setIntParam	(	OsiIntParam	key,
		int	value
	)

◆ setDblParam()

bool OsiCbcSolverInterface::setDblParam	(	OsiDblParam	key,
		double	value
	)

◆ setStrParam()

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

◆ getIntParam()

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

◆ getDblParam()

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

◆ getStrParam()

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

◆ setHintParam()

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

virtual

◆ getHintParam() [1/2]

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

virtual

Get a hint parameter.

◆ getHintParam() [2/2]

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

virtual

Get a hint parameter.

◆ isAbandoned()

virtual bool OsiCbcSolverInterface::isAbandoned ( ) const

virtual

Are there a numerical difficulties?

◆ isProvenOptimal()

virtual bool OsiCbcSolverInterface::isProvenOptimal ( ) const

virtual

Is optimality proven?

◆ isProvenPrimalInfeasible()

virtual bool OsiCbcSolverInterface::isProvenPrimalInfeasible ( ) const

virtual

Is primal infeasiblity proven?

◆ isProvenDualInfeasible()

virtual bool OsiCbcSolverInterface::isProvenDualInfeasible ( ) const

virtual

Is dual infeasiblity proven?

◆ isPrimalObjectiveLimitReached()

virtual bool OsiCbcSolverInterface::isPrimalObjectiveLimitReached ( ) const

virtual

Is the given primal objective limit reached?

◆ isDualObjectiveLimitReached()

virtual bool OsiCbcSolverInterface::isDualObjectiveLimitReached ( ) const

virtual

Is the given dual objective limit reached?

◆ isIterationLimitReached()

virtual bool OsiCbcSolverInterface::isIterationLimitReached ( ) const

virtual

Iteration limit reached?

◆ getEmptyWarmStart()

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.

◆ getWarmStart()

virtual CoinWarmStart* OsiCbcSolverInterface::getWarmStart ( ) const

virtual

Get warmstarting information.

◆ setWarmStart()

virtual bool OsiCbcSolverInterface::setWarmStart ( const CoinWarmStart * warmstart )

virtual

Set warmstarting information.

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

◆ markHotStart()

virtual void OsiCbcSolverInterface::markHotStart ( )

virtual

Create a hotstart point of the optimization process.

◆ solveFromHotStart()

virtual void OsiCbcSolverInterface::solveFromHotStart ( )

virtual

Optimize starting from the hotstart.

◆ unmarkHotStart()

virtual void OsiCbcSolverInterface::unmarkHotStart ( )

virtual

Delete the snapshot.

◆ getNumCols()

virtual int OsiCbcSolverInterface::getNumCols ( ) const

virtual

Get number of columns.

◆ getNumRows()

virtual int OsiCbcSolverInterface::getNumRows ( ) const

virtual

Get number of rows.

◆ getNumElements()

virtual CoinBigIndex OsiCbcSolverInterface::getNumElements ( ) const

virtual

Get number of nonzero elements.

◆ getColLower()

virtual const double* OsiCbcSolverInterface::getColLower ( ) const

virtual

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

◆ getColUpper()

virtual const double* OsiCbcSolverInterface::getColUpper ( ) const

virtual

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

◆ getRowSense()

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

◆ getRightHandSide()

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

◆ getRowRange()

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

◆ getRowLower()

virtual const double* OsiCbcSolverInterface::getRowLower ( ) const

virtual

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

◆ getRowUpper()

virtual const double* OsiCbcSolverInterface::getRowUpper ( ) const

virtual

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

◆ getObjCoefficients()

virtual const double* OsiCbcSolverInterface::getObjCoefficients ( ) const

virtual

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

◆ getObjSense()

virtual double OsiCbcSolverInterface::getObjSense ( ) const

virtual

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

◆ isContinuous()

virtual bool OsiCbcSolverInterface::isContinuous ( int colNumber ) const

virtual

Return true if column is continuous.

◆ getMatrixByRow()

virtual const CoinPackedMatrix* OsiCbcSolverInterface::getMatrixByRow ( ) const

virtual

Get pointer to row-wise copy of matrix.

◆ getMatrixByCol()

virtual const CoinPackedMatrix* OsiCbcSolverInterface::getMatrixByCol ( ) const

virtual

Get pointer to column-wise copy of matrix.

◆ getInfinity()

virtual double OsiCbcSolverInterface::getInfinity ( ) const

virtual

Get solver's value for infinity.

◆ getColSolution()

virtual const double* OsiCbcSolverInterface::getColSolution ( ) const

virtual

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

◆ getRowPrice()

virtual const double* OsiCbcSolverInterface::getRowPrice ( ) const

virtual

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

◆ getReducedCost()

virtual const double* OsiCbcSolverInterface::getReducedCost ( ) const

virtual

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

◆ getRowActivity()

virtual const double* OsiCbcSolverInterface::getRowActivity ( ) const

virtual

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

◆ getObjValue()

virtual double OsiCbcSolverInterface::getObjValue ( ) const

virtual

Get objective function value.

◆ getIterationCount()

virtual int OsiCbcSolverInterface::getIterationCount ( ) const

virtual

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

◆ getDualRays()

virtual std::vector< double * > OsiCbcSolverInterface::getDualRays	(	int	maxNumRays,
		bool	fullRay = `false`
	)		const

virtual

Get as many dual rays as the solver can provide.

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

The first getNumRows() ray components will always be associated with the row duals (as returned by getRowPrice()). If fullRay is true, the final getNumCols() entries will correspond to the ray components associated with the nonbasic variables. If the full ray is requested and the method cannot provide it, it will throw an exception.

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[].

◆ getPrimalRays()

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[].

◆ dfltRowColName()

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

virtual

Generate a standard name of the form Rnnnnnnn or Cnnnnnnn.

◆ getObjName()

virtual std::string OsiCbcSolverInterface::getObjName ( std::string::size_type maxLen = std::string::npos ) const

virtual

Return the name of the objective function.

◆ setObjName()

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

virtual

Set the name of the objective function.

◆ getRowName()

virtual std::string OsiCbcSolverInterface::getRowName	(	int	rowIndex,
		std::string::size_type	maxLen = `std::string::npos`
	)		const

virtual

Return the name of the row.

◆ getRowNames()

virtual const OsiNameVec& OsiCbcSolverInterface::getRowNames ( )

virtual

Return a pointer to a vector of row names.

◆ setRowName()

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

virtual

Set a row name.

◆ setRowNames()

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

virtual

Set multiple row names.

◆ deleteRowNames()

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

virtual

Delete len row names starting at index tgtStart.

◆ getColName()

virtual std::string OsiCbcSolverInterface::getColName	(	int	colIndex,
		std::string::size_type	maxLen = `std::string::npos`
	)		const

virtual

Return the name of the column.

◆ getColNames()

virtual const OsiNameVec& OsiCbcSolverInterface::getColNames ( )

virtual

Return a pointer to a vector of column names.

◆ setColName()

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

virtual

Set a column name.

◆ setColNames()

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

virtual

Set multiple column names.

◆ deleteColNames()

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

virtual

Delete len column names starting at index tgtStart.

◆ setObjCoeff()

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

virtual

Set an objective function coefficient.

◆ setColLower()

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

virtual

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

◆ setColUpper()

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

virtual

Set a single column upper bound
Use DBL_MAX for infinity.

◆ setColBounds()

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

virtual

Set a single column lower and upper bound.

◆ setColSetBounds()

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

◆ setRowLower()

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

virtual

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

◆ setRowUpper()

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

virtual

Set a single row upper bound
Use DBL_MAX for infinity.

◆ setRowBounds()

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

virtual

Set a single row lower and upper bound.

◆ setRowType()

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

virtual

Set the type of a single row

◆ setRowSetBounds()

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

◆ setRowSetTypes()

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

◆ setContinuous() [1/2]

virtual void OsiCbcSolverInterface::setContinuous ( int index )

virtual

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

◆ setInteger() [1/2]

virtual void OsiCbcSolverInterface::setInteger ( int index )

virtual

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

◆ setContinuous() [2/2]

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.

◆ setInteger() [2/2]

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.

◆ setObjSense()

virtual void OsiCbcSolverInterface::setObjSense ( double s )

virtual

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

◆ setColSolution()

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.

◆ setRowPrice()

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.

◆ addCol() [1/2]

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

virtual

◆ addCol() [2/2]

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.

◆ addCols()

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

virtual

◆ deleteCols()

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

virtual

◆ addRow() [1/2]

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

virtual

◆ addRow() [2/2]

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

virtual

◆ addRows() [1/2]

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

virtual

◆ addRows() [2/2]

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

virtual

◆ deleteRows()

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

virtual

◆ applyRowCuts() [1/2]

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.

◆ applyRowCuts() [2/2]

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

◆ loadProblem() [1/4]

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

◆ assignProblem() [1/2]

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.

◆ loadProblem() [2/4]

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

◆ assignProblem() [2/2]

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.

◆ loadProblem() [3/4]

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).

◆ loadProblem() [4/4]

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).

◆ readMps()

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)

◆ writeMps()

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

◆ writeMpsNative()

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

◆ newLanguage()

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

Set language.

◆ setLanguage()

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

inline

Definition at line 652 of file OsiCbcSolverInterface.hpp.

◆ getModelPtr()

CbcModel* OsiCbcSolverInterface::getModelPtr ( ) const

inline

Get pointer to Cbc model.

Definition at line 662 of file OsiCbcSolverInterface.hpp.

◆ getRealSolverPtr()

OsiSolverInterface* OsiCbcSolverInterface::getRealSolverPtr ( ) const

inline

Get pointer to underlying solver.

Definition at line 667 of file OsiCbcSolverInterface.hpp.

◆ setCutoff()

void OsiCbcSolverInterface::setCutoff ( double value )

inline

Set cutoff bound on the objective function.

Definition at line 672 of file OsiCbcSolverInterface.hpp.

◆ getCutoff()

double OsiCbcSolverInterface::getCutoff ( ) const

inline

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

Definition at line 677 of file OsiCbcSolverInterface.hpp.

◆ setMaximumNodes()

void OsiCbcSolverInterface::setMaximumNodes ( int value )

inline

Set the CbcModel::CbcMaxNumNode maximum node limit.

Definition at line 682 of file OsiCbcSolverInterface.hpp.

◆ getMaximumNodes()

int OsiCbcSolverInterface::getMaximumNodes ( ) const

inline

Get the CbcModel::CbcMaxNumNode maximum node limit.

Definition at line 687 of file OsiCbcSolverInterface.hpp.

◆ setMaximumSolutions()

void OsiCbcSolverInterface::setMaximumSolutions ( int value )

inline

Set the CbcModel::CbcMaxNumSol maximum number of solutions.

Definition at line 692 of file OsiCbcSolverInterface.hpp.

◆ getMaximumSolutions()

int OsiCbcSolverInterface::getMaximumSolutions ( ) const

inline

Get the CbcModel::CbcMaxNumSol maximum number of solutions.

Definition at line 697 of file OsiCbcSolverInterface.hpp.

◆ setMaximumSeconds()

void OsiCbcSolverInterface::setMaximumSeconds ( double value )

inline

Set the CbcModel::CbcMaximumSeconds maximum number of seconds.

Definition at line 702 of file OsiCbcSolverInterface.hpp.

◆ getMaximumSeconds()

double OsiCbcSolverInterface::getMaximumSeconds ( ) const

inline

Get the CbcModel::CbcMaximumSeconds maximum number of seconds.

Definition at line 707 of file OsiCbcSolverInterface.hpp.

◆ isNodeLimitReached()

bool OsiCbcSolverInterface::isNodeLimitReached ( ) const

inline

Node limit reached?

Definition at line 712 of file OsiCbcSolverInterface.hpp.

◆ isSolutionLimitReached()

bool OsiCbcSolverInterface::isSolutionLimitReached ( ) const

inline

Solution limit reached?

Definition at line 717 of file OsiCbcSolverInterface.hpp.

◆ getNodeCount()

int OsiCbcSolverInterface::getNodeCount ( ) const

inline

Get how many Nodes it took to solve the problem.

Definition at line 722 of file OsiCbcSolverInterface.hpp.

◆ status()

int OsiCbcSolverInterface::status ( ) const

inline

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

Definition at line 727 of file OsiCbcSolverInterface.hpp.

◆ passInMessageHandler()

virtual void OsiCbcSolverInterface::passInMessageHandler ( CoinMessageHandler * handler )

virtual

Pass in a message handler.

It is the client's responsibility to destroy a message handler installed by this routine; it will not be destroyed when the solver interface is destroyed.

◆ clone()

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

virtual

Clone.

◆ operator=()

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

Assignment operator.

◆ applyRowCut()

virtual void OsiCbcSolverInterface::applyRowCut ( const OsiRowCut & rc )

protectedvirtual

Apply a row cut (append to constraint matrix).

◆ applyColCut()

virtual void OsiCbcSolverInterface::applyColCut ( const OsiColCut & cc )

protectedvirtual

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

Friends And Related Function Documentation

◆ OsiCbcSolverInterfaceUnitTest

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

friend

A function that tests the methods in the OsiCbcSolverInterface class.

Member Data Documentation

◆ modelPtr_

CbcModel* OsiCbcSolverInterface::modelPtr_

mutableprotected

Cbc model represented by this class instance.

Definition at line 781 of file OsiCbcSolverInterface.hpp.

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

/home/ted/Projects/Cbc/Cbc/src/OsiCbc/OsiCbcSolverInterface.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ OsiCbcSolverInterface() [1/2]

◆ OsiCbcSolverInterface() [2/2]

◆ ~OsiCbcSolverInterface()

Member Function Documentation

◆ initialSolve()

◆ resolve()

◆ branchAndBound()

◆ setIntParam()

◆ setDblParam()

◆ setStrParam()

◆ getIntParam()

◆ getDblParam()

◆ getStrParam()

◆ setHintParam()

◆ getHintParam() [1/2]

◆ getHintParam() [2/2]

◆ isAbandoned()

◆ isProvenOptimal()

◆ isProvenPrimalInfeasible()

◆ isProvenDualInfeasible()

◆ isPrimalObjectiveLimitReached()

◆ isDualObjectiveLimitReached()

◆ isIterationLimitReached()

◆ getEmptyWarmStart()

◆ getWarmStart()

◆ setWarmStart()

◆ markHotStart()

◆ solveFromHotStart()

◆ unmarkHotStart()

◆ getNumCols()

◆ getNumRows()

◆ getNumElements()

◆ getColLower()

◆ getColUpper()

◆ getRowSense()

◆ getRightHandSide()

◆ getRowRange()

◆ getRowLower()

◆ getRowUpper()

◆ getObjCoefficients()

◆ getObjSense()

◆ isContinuous()

◆ getMatrixByRow()

◆ getMatrixByCol()

◆ getInfinity()

◆ getColSolution()

◆ getRowPrice()

◆ getReducedCost()

◆ getRowActivity()

◆ getObjValue()

◆ getIterationCount()

◆ getDualRays()

◆ getPrimalRays()

◆ dfltRowColName()

◆ getObjName()

◆ setObjName()

◆ getRowName()

◆ getRowNames()

◆ setRowName()

◆ setRowNames()

◆ deleteRowNames()

◆ getColName()

◆ getColNames()

◆ setColName()

◆ setColNames()

◆ deleteColNames()

◆ setObjCoeff()

◆ setColLower()

◆ setColUpper()

◆ setColBounds()

◆ setColSetBounds()

◆ setRowLower()

◆ setRowUpper()

◆ setRowBounds()