Detailed Description

Cbc Solver Interface.

Instantiation of OsiCbcSolverInterface for the Model Algorithm.

Definition at line 30 of file OsiCbcSolverInterface_2_10.hpp.

#include <OsiCbcSolverInterface_2_10.hpp>

Inheritance diagram for OsiCbcSolverInterface:

Public Member Functions
Solve methods
virtual void	initialSolve ()

virtual void	resolve ()

virtual void	branchAndBound ()

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

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

Methods returning info on how the solution process terminated
virtual bool	isAbandoned () const

virtual bool	isProvenOptimal () const

virtual bool	isProvenPrimalInfeasible () const

virtual bool	isProvenDualInfeasible () const

virtual bool	isPrimalObjectiveLimitReached () const

virtual bool	isDualObjectiveLimitReached () const

virtual bool	isIterationLimitReached () const

WarmStart related methods
virtual CoinWarmStart *	getEmptyWarmStart () const

virtual CoinWarmStart *	getWarmStart () const

virtual bool	setWarmStart (const CoinWarmStart *warmstart)

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

virtual void	solveFromHotStart ()

virtual void	unmarkHotStart ()

Methods related to querying the input data
virtual int	getNumCols () const

virtual int	getNumRows () const

virtual int	getNumElements () const

virtual const double *	getColLower () const

virtual const double *	getColUpper () const

virtual const char *	getRowSense () const

virtual const double *	getRightHandSide () const

virtual const double *	getRowRange () const

virtual const double *	getRowLower () const

virtual const double *	getRowUpper () const

virtual const double *	getObjCoefficients () const

virtual double	getObjSense () const

virtual bool	isContinuous (int colNumber) const

virtual const CoinPackedMatrix *	getMatrixByRow () const

virtual const CoinPackedMatrix *	getMatrixByCol () const

virtual double	getInfinity () const

Methods related to querying the solution
virtual const double *	getColSolution () const

virtual const double *	getRowPrice () const

virtual const double *	getReducedCost () const

virtual const double *	getRowActivity () const

virtual double	getObjValue () const

virtual int	getIterationCount () const

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

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

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

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

virtual void	setObjName (std::string name)

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

virtual const OsiNameVec &	getRowNames ()

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

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

virtual void	deleteRowNames (int tgtStart, int len)

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

virtual const OsiNameVec &	getColNames ()

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

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

virtual void	deleteColNames (int tgtStart, int len)

Changing bounds on variables and constraints
virtual void	setObjCoeff (int elementIndex, double elementValue)

virtual void	setColLower (int elementIndex, double elementValue)

virtual void	setColUpper (int elementIndex, double elementValue)

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

virtual void	setColSetBounds (const int indexFirst, const int indexLast, const double *boundList)

virtual void	setRowLower (int elementIndex, double elementValue)

virtual void	setRowUpper (int elementIndex, double elementValue)

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

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

virtual void	setRowSetBounds (const int indexFirst, const int indexLast, const double *boundList)

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

Integrality related changing methods
virtual void	setContinuous (int index)

virtual void	setInteger (int index)

virtual void	setContinuous (const int *indices, int len)

virtual void	setInteger (const int *indices, int len)

virtual void	setObjSense (double s)

virtual void	setColSolution (const double *colsol)

virtual void	setRowPrice (const double *rowprice)

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)

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)

virtual void	applyRowCuts (int numberCuts, const OsiRowCut **cuts)

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)

virtual void	assignProblem (CoinPackedMatrix &matrix, double &collb, double &colub, double &obj, double &rowlb, double &rowub)

virtual void	loadProblem (const CoinPackedMatrix &matrix, const double collb, const double colub, const double obj, const char rowsen, const double rowrhs, const double rowrng)

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

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)

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)

virtual int	readMps (const char filename, const char extension="mps")

virtual void	writeMps (const char filename, const char extension="mps", double objSense=0.0) const

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

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)

void	setLanguage (CoinMessages::Language language)

Cbc specific public interfaces
CbcModel *	getModelPtr () const

OsiSolverInterface *	getRealSolverPtr () const

void	setCutoff (double value)

double	getCutoff () const

void	setMaximumNodes (int value)

int	getMaximumNodes () const

void	setMaximumSolutions (int value)

int	getMaximumSolutions () const

void	setMaximumSeconds (double value)

double	getMaximumSeconds () const

bool	isNodeLimitReached () const

bool	isSolutionLimitReached () const

int	getNodeCount () const

int	status () const

virtual void	passInMessageHandler (CoinMessageHandler *handler)

Constructors and destructors
	OsiCbcSolverInterface (OsiSolverInterface solver=NULL, CbcStrategy strategy=NULL)

virtual OsiSolverInterface *	clone (bool copyData=true) const

	OsiCbcSolverInterface (const OsiCbcSolverInterface &)

OsiCbcSolverInterface &	operator= (const OsiCbcSolverInterface &rhs)

virtual	~OsiCbcSolverInterface ()

Protected Member Functions
Protected methods
virtual void	applyRowCut (const OsiRowCut &rc)

virtual void	applyColCut (const OsiColCut &cc)

Protected Attributes
Protected member data
CbcModel *	modelPtr_

Constructor & Destructor Documentation

◆ OsiCbcSolverInterface() [1/2]

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

Default Constructor.

Definition at line 472 of file OsiCbcSolverInterface_2_10.cpp.

◆ OsiCbcSolverInterface() [2/2]

OsiCbcSolverInterface::OsiCbcSolverInterface ( const OsiCbcSolverInterface & rhs )

Copy constructor.

Definition at line 507 of file OsiCbcSolverInterface_2_10.cpp.

◆ ~OsiCbcSolverInterface()

OsiCbcSolverInterface::~OsiCbcSolverInterface ( )

virtual

Destructor.

Definition at line 520 of file OsiCbcSolverInterface_2_10.cpp.

Member Function Documentation

◆ addCol() [1/2]

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

virtual

Definition at line 301 of file OsiCbcSolverInterface_2_10.cpp.

◆ addCol() [2/2]

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.

Definition at line 309 of file OsiCbcSolverInterface_2_10.cpp.

◆ addCols()

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

virtual

Definition at line 318 of file OsiCbcSolverInterface_2_10.cpp.

◆ addRow() [1/2]

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

virtual

Definition at line 340 of file OsiCbcSolverInterface_2_10.cpp.

◆ addRow() [2/2]

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

virtual

Definition at line 333 of file OsiCbcSolverInterface_2_10.cpp.

◆ addRows() [1/2]

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

virtual

Definition at line 356 of file OsiCbcSolverInterface_2_10.cpp.

◆ addRows() [2/2]

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

virtual

Definition at line 348 of file OsiCbcSolverInterface_2_10.cpp.

◆ applyColCut()

void OsiCbcSolverInterface::applyColCut ( const OsiColCut & cc )

protectedvirtual

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

Definition at line 565 of file OsiCbcSolverInterface_2_10.cpp.

◆ applyRowCut()

void OsiCbcSolverInterface::applyRowCut ( const OsiRowCut & rc )

protectedvirtual

Apply a row cut (append to constraint matrix).

Definition at line 543 of file OsiCbcSolverInterface_2_10.cpp.

◆ applyRowCuts() [1/2]

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

Definition at line 559 of file OsiCbcSolverInterface_2_10.cpp.

◆ applyRowCuts() [2/2]

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.

Definition at line 551 of file OsiCbcSolverInterface_2_10.cpp.

◆ assignProblem() [1/2]

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.

Definition at line 409 of file OsiCbcSolverInterface_2_10.cpp.

◆ assignProblem() [2/2]

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.

Definition at line 386 of file OsiCbcSolverInterface_2_10.cpp.

◆ branchAndBound()

void OsiCbcSolverInterface::branchAndBound ( )

virtual

Invoke solver's built-in enumeration algorithm.

Definition at line 798 of file OsiCbcSolverInterface_2_10.cpp.

◆ clone()

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

virtual

Clone.

Definition at line 494 of file OsiCbcSolverInterface_2_10.cpp.

◆ deleteColNames()

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

virtual

Delete len column names starting at index tgtStart.

Definition at line 861 of file OsiCbcSolverInterface_2_10.cpp.

◆ deleteCols()

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

virtual

Definition at line 327 of file OsiCbcSolverInterface_2_10.cpp.

◆ deleteRowNames()

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

virtual

Delete len row names starting at index tgtStart.

Definition at line 850 of file OsiCbcSolverInterface_2_10.cpp.

◆ deleteRows()

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

virtual

Definition at line 365 of file OsiCbcSolverInterface_2_10.cpp.

◆ dfltRowColName()

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

virtual

Generate a standard name of the form Rnnnnnnn or Cnnnnnnn.

Definition at line 814 of file OsiCbcSolverInterface_2_10.cpp.

◆ getColLower()

const double * OsiCbcSolverInterface::getColLower ( ) const

virtual

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

Definition at line 752 of file OsiCbcSolverInterface_2_10.cpp.

◆ getColName()

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

virtual

Return the name of the column.

Definition at line 834 of file OsiCbcSolverInterface_2_10.cpp.

◆ getColNames()

const OsiSolverInterface::OsiNameVec & OsiCbcSolverInterface::getColNames ( )

virtual

Return a pointer to a vector of column names.

Definition at line 839 of file OsiCbcSolverInterface_2_10.cpp.

◆ getColSolution()

const double * OsiCbcSolverInterface::getColSolution ( ) const

virtual

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

Definition at line 596 of file OsiCbcSolverInterface_2_10.cpp.

◆ getColUpper()

const double * OsiCbcSolverInterface::getColUpper ( ) const

virtual

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

Definition at line 757 of file OsiCbcSolverInterface_2_10.cpp.

◆ getCutoff()

double OsiCbcSolverInterface::getCutoff ( ) const

inline

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

Definition at line 672 of file OsiCbcSolverInterface_2_10.hpp.

◆ getDblParam()

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

Definition at line 98 of file OsiCbcSolverInterface_2_10.cpp.

◆ getDualRays()

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

Definition at line 252 of file OsiCbcSolverInterface_2_10.cpp.

◆ getEmptyWarmStart()

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.

Definition at line 174 of file OsiCbcSolverInterface_2_10.cpp.

◆ getHintParam() [1/2]

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

virtual

Get a hint parameter.

Definition at line 729 of file OsiCbcSolverInterface_2_10.cpp.

◆ getHintParam() [2/2]

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

virtual

Get a hint parameter.

Definition at line 720 of file OsiCbcSolverInterface_2_10.cpp.

◆ getInfinity()

double OsiCbcSolverInterface::getInfinity ( ) const

virtual

Get solver's value for infinity.

Definition at line 782 of file OsiCbcSolverInterface_2_10.cpp.

◆ getIntParam()

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

Definition at line 90 of file OsiCbcSolverInterface_2_10.cpp.

◆ getIterationCount()

int OsiCbcSolverInterface::getIterationCount ( ) const

virtual

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

Definition at line 787 of file OsiCbcSolverInterface_2_10.cpp.

◆ getMatrixByCol()

const CoinPackedMatrix * OsiCbcSolverInterface::getMatrixByCol ( ) const

virtual

Get pointer to column-wise copy of matrix.

Definition at line 246 of file OsiCbcSolverInterface_2_10.cpp.

◆ getMatrixByRow()

const CoinPackedMatrix * OsiCbcSolverInterface::getMatrixByRow ( ) const

virtual

Get pointer to row-wise copy of matrix.

Definition at line 241 of file OsiCbcSolverInterface_2_10.cpp.

◆ getMaximumNodes()

int OsiCbcSolverInterface::getMaximumNodes ( ) const

inline

Get the CbcModel::CbcMaxNumNode maximum node limit.

Definition at line 678 of file OsiCbcSolverInterface_2_10.hpp.

◆ getMaximumSeconds()

double OsiCbcSolverInterface::getMaximumSeconds ( ) const

inline

Get the CbcModel::CbcMaximumSeconds maximum number of seconds.

Definition at line 690 of file OsiCbcSolverInterface_2_10.hpp.

◆ getMaximumSolutions()

int OsiCbcSolverInterface::getMaximumSolutions ( ) const

inline

Get the CbcModel::CbcMaxNumSol maximum number of solutions.

Definition at line 684 of file OsiCbcSolverInterface_2_10.hpp.

◆ getModelPtr()

CbcModel * OsiCbcSolverInterface::getModelPtr ( ) const

inline

Get pointer to Cbc model.

Definition at line 663 of file OsiCbcSolverInterface_2_10.hpp.

◆ getNodeCount()

int OsiCbcSolverInterface::getNodeCount ( ) const

inline

Get how many Nodes it took to solve the problem.

Definition at line 699 of file OsiCbcSolverInterface_2_10.hpp.

◆ getNumCols()

int OsiCbcSolverInterface::getNumCols ( ) const

virtual

Get number of columns.

Definition at line 737 of file OsiCbcSolverInterface_2_10.cpp.

◆ getNumElements()

int OsiCbcSolverInterface::getNumElements ( ) const

virtual

Get number of nonzero elements.

Definition at line 747 of file OsiCbcSolverInterface_2_10.cpp.

◆ getNumRows()

int OsiCbcSolverInterface::getNumRows ( ) const

virtual

Get number of rows.

Definition at line 742 of file OsiCbcSolverInterface_2_10.cpp.

◆ getObjCoefficients()

const double * OsiCbcSolverInterface::getObjCoefficients ( ) const

virtual

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

Definition at line 772 of file OsiCbcSolverInterface_2_10.cpp.

◆ getObjName()

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

virtual

Return the name of the objective function.

Definition at line 819 of file OsiCbcSolverInterface_2_10.cpp.

◆ getObjSense()

double OsiCbcSolverInterface::getObjSense ( ) const

virtual

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

Definition at line 777 of file OsiCbcSolverInterface_2_10.cpp.

◆ getObjValue()

double OsiCbcSolverInterface::getObjValue ( ) const

virtual

Get objective function value.

Definition at line 623 of file OsiCbcSolverInterface_2_10.cpp.

◆ getPrimalRays()

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

Definition at line 258 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRealSolverPtr()

OsiSolverInterface * OsiCbcSolverInterface::getRealSolverPtr ( ) const

inline

Get pointer to underlying solver.

Definition at line 666 of file OsiCbcSolverInterface_2_10.hpp.

◆ getReducedCost()

const double * OsiCbcSolverInterface::getReducedCost ( ) const

virtual

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

Definition at line 610 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRightHandSide()

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

Definition at line 220 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowActivity()

const double * OsiCbcSolverInterface::getRowActivity ( ) const

virtual

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

Definition at line 618 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowLower()

const double * OsiCbcSolverInterface::getRowLower ( ) const

virtual

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

Definition at line 762 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowName()

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

virtual

Return the name of the row.

Definition at line 824 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowNames()

const OsiSolverInterface::OsiNameVec & OsiCbcSolverInterface::getRowNames ( )

virtual

Return a pointer to a vector of row names.

Definition at line 829 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowPrice()

const double * OsiCbcSolverInterface::getRowPrice ( ) const

virtual

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

Definition at line 603 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowRange()

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

Definition at line 225 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowSense()

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

Definition at line 215 of file OsiCbcSolverInterface_2_10.cpp.

◆ getRowUpper()

const double * OsiCbcSolverInterface::getRowUpper ( ) const

virtual

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

Definition at line 767 of file OsiCbcSolverInterface_2_10.cpp.

◆ getStrParam()

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

Definition at line 106 of file OsiCbcSolverInterface_2_10.cpp.

◆ getWarmStart()

CoinWarmStart * OsiCbcSolverInterface::getWarmStart ( ) const

virtual

Get warmstarting information.

Definition at line 179 of file OsiCbcSolverInterface_2_10.cpp.

◆ initialSolve()

void OsiCbcSolverInterface::initialSolve ( )

virtual

Solve initial LP relaxation.

Definition at line 50 of file OsiCbcSolverInterface_2_10.cpp.

◆ isAbandoned()

bool OsiCbcSolverInterface::isAbandoned ( ) const

virtual

Are there a numerical difficulties?

Definition at line 122 of file OsiCbcSolverInterface_2_10.cpp.

◆ isContinuous()

bool OsiCbcSolverInterface::isContinuous ( int colNumber ) const

virtual

Return true if column is continuous.

Definition at line 232 of file OsiCbcSolverInterface_2_10.cpp.

◆ isDualObjectiveLimitReached()

bool OsiCbcSolverInterface::isDualObjectiveLimitReached ( ) const

virtual

Is the given dual objective limit reached?

Definition at line 158 of file OsiCbcSolverInterface_2_10.cpp.

◆ isIterationLimitReached()

bool OsiCbcSolverInterface::isIterationLimitReached ( ) const

virtual

Iteration limit reached?

Definition at line 163 of file OsiCbcSolverInterface_2_10.cpp.

◆ isNodeLimitReached()

bool OsiCbcSolverInterface::isNodeLimitReached ( ) const

inline

Node limit reached?

Definition at line 693 of file OsiCbcSolverInterface_2_10.hpp.

◆ isPrimalObjectiveLimitReached()

bool OsiCbcSolverInterface::isPrimalObjectiveLimitReached ( ) const

virtual

Is the given primal objective limit reached?

Definition at line 153 of file OsiCbcSolverInterface_2_10.cpp.

◆ isProvenDualInfeasible()

bool OsiCbcSolverInterface::isProvenDualInfeasible ( ) const

virtual

Is dual infeasiblity proven?

Definition at line 146 of file OsiCbcSolverInterface_2_10.cpp.

◆ isProvenOptimal()

bool OsiCbcSolverInterface::isProvenOptimal ( ) const

virtual

Is optimality proven?

Definition at line 130 of file OsiCbcSolverInterface_2_10.cpp.

◆ isProvenPrimalInfeasible()

bool OsiCbcSolverInterface::isProvenPrimalInfeasible ( ) const

virtual

Is primal infeasiblity proven?

Definition at line 138 of file OsiCbcSolverInterface_2_10.cpp.

◆ isSolutionLimitReached()

bool OsiCbcSolverInterface::isSolutionLimitReached ( ) const

inline

Solution limit reached?

Definition at line 696 of file OsiCbcSolverInterface_2_10.hpp.

◆ loadProblem() [1/4]

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

Definition at line 397 of file OsiCbcSolverInterface_2_10.cpp.

◆ loadProblem() [2/4]

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

Definition at line 375 of file OsiCbcSolverInterface_2_10.cpp.

◆ loadProblem() [3/4]

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

Definition at line 434 of file OsiCbcSolverInterface_2_10.cpp.

◆ loadProblem() [4/4]

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

Definition at line 421 of file OsiCbcSolverInterface_2_10.cpp.

◆ markHotStart()

void OsiCbcSolverInterface::markHotStart ( )

virtual

Create a hotstart point of the optimization process.

Definition at line 195 of file OsiCbcSolverInterface_2_10.cpp.

◆ newLanguage()

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

Set language.

◆ operator=()

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

Assignment operator.

Definition at line 529 of file OsiCbcSolverInterface_2_10.cpp.

◆ passInMessageHandler()

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.

Definition at line 897 of file OsiCbcSolverInterface_2_10.cpp.

◆ readMps()

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)

Definition at line 589 of file OsiCbcSolverInterface_2_10.cpp.

◆ resolve()

void OsiCbcSolverInterface::resolve ( )

virtual

Resolve an LP relaxation after problem modification.

Definition at line 56 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColBounds()

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

virtual

Set a single column lower and upper bound.

Definition at line 653 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColLower()

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

virtual

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

Definition at line 638 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColName()

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

virtual

Set a column name.

Definition at line 890 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColNames()

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

virtual

Set multiple column names.

Definition at line 855 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColSetBounds()

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

Definition at line 658 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColSolution()

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.

Definition at line 287 of file OsiCbcSolverInterface_2_10.cpp.

◆ setColUpper()

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

virtual

Set a single column upper bound
Use DBL_MAX for infinity.

Definition at line 646 of file OsiCbcSolverInterface_2_10.cpp.

◆ setContinuous() [1/2]

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

virtual

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

Definition at line 276 of file OsiCbcSolverInterface_2_10.cpp.

◆ setContinuous() [2/2]

void OsiCbcSolverInterface::setContinuous ( int index )

virtual

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

Definition at line 264 of file OsiCbcSolverInterface_2_10.cpp.

◆ setCutoff()

void OsiCbcSolverInterface::setCutoff ( double value )

inline

Set cutoff bound on the objective function.

Definition at line 669 of file OsiCbcSolverInterface_2_10.hpp.

◆ setDblParam()

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

Definition at line 73 of file OsiCbcSolverInterface_2_10.cpp.

◆ setHintParam()

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

virtual

Definition at line 711 of file OsiCbcSolverInterface_2_10.cpp.

◆ setInteger() [1/2]

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

virtual

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

Definition at line 282 of file OsiCbcSolverInterface_2_10.cpp.

◆ setInteger() [2/2]

void OsiCbcSolverInterface::setInteger ( int index )

virtual

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

Definition at line 270 of file OsiCbcSolverInterface_2_10.cpp.

◆ setIntParam()

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

Definition at line 65 of file OsiCbcSolverInterface_2_10.cpp.

◆ setLanguage()

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

inline

Definition at line 655 of file OsiCbcSolverInterface_2_10.hpp.

◆ setMaximumNodes()

void OsiCbcSolverInterface::setMaximumNodes ( int value )

inline

Set the CbcModel::CbcMaxNumNode maximum node limit.

Definition at line 675 of file OsiCbcSolverInterface_2_10.hpp.

◆ setMaximumSeconds()

void OsiCbcSolverInterface::setMaximumSeconds ( double value )

inline

Set the CbcModel::CbcMaximumSeconds maximum number of seconds.

Definition at line 687 of file OsiCbcSolverInterface_2_10.hpp.

◆ setMaximumSolutions()

void OsiCbcSolverInterface::setMaximumSolutions ( int value )

inline

Set the CbcModel::CbcMaxNumSol maximum number of solutions.

Definition at line 681 of file OsiCbcSolverInterface_2_10.hpp.

◆ setObjCoeff()

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

virtual

Set an objective function coefficient.

Definition at line 630 of file OsiCbcSolverInterface_2_10.cpp.

◆ setObjName()

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

virtual

Set the name of the objective function.

Definition at line 873 of file OsiCbcSolverInterface_2_10.cpp.

◆ setObjSense()

void OsiCbcSolverInterface::setObjSense ( double s )

virtual

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

Definition at line 792 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowBounds()

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

virtual

Set a single row lower and upper bound.

Definition at line 681 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowLower()

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

virtual

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

Definition at line 668 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowName()

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

virtual

Set a row name.

Definition at line 881 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowNames()

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

virtual

Set multiple row names.

Definition at line 844 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowPrice()

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.

Definition at line 292 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowSetBounds()

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

Definition at line 693 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowSetTypes()

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

Definition at line 701 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowType()

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

virtual

Set the type of a single row

Definition at line 687 of file OsiCbcSolverInterface_2_10.cpp.

◆ setRowUpper()

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

virtual

Set a single row upper bound
Use DBL_MAX for infinity.

Definition at line 675 of file OsiCbcSolverInterface_2_10.cpp.

◆ setStrParam()

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

Definition at line 81 of file OsiCbcSolverInterface_2_10.cpp.

◆ setWarmStart()

bool OsiCbcSolverInterface::setWarmStart ( const CoinWarmStart * warmstart )

virtual

Set warmstarting information.

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

Definition at line 186 of file OsiCbcSolverInterface_2_10.cpp.

◆ solveFromHotStart()

void OsiCbcSolverInterface::solveFromHotStart ( )

virtual

Optimize starting from the hotstart.

Definition at line 200 of file OsiCbcSolverInterface_2_10.cpp.

◆ status()

int OsiCbcSolverInterface::status ( ) const

inline

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

Definition at line 702 of file OsiCbcSolverInterface_2_10.hpp.

◆ unmarkHotStart()

void OsiCbcSolverInterface::unmarkHotStart ( )

virtual

Delete the snapshot.

Definition at line 205 of file OsiCbcSolverInterface_2_10.cpp.

◆ writeMps()

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

Definition at line 450 of file OsiCbcSolverInterface_2_10.cpp.

◆ writeMpsNative()

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

Definition at line 458 of file OsiCbcSolverInterface_2_10.cpp.

Member Data Documentation

◆ modelPtr_

CbcModel* OsiCbcSolverInterface::modelPtr_

mutableprotected

Cbc model represented by this class instance.

Definition at line 754 of file OsiCbcSolverInterface_2_10.hpp.

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

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ OsiCbcSolverInterface() [1/2]

◆ OsiCbcSolverInterface() [2/2]

◆ ~OsiCbcSolverInterface()

Member Function Documentation

◆ addCol() [1/2]

◆ addCol() [2/2]

◆ addCols()

◆ addRow() [1/2]

◆ addRow() [2/2]

◆ addRows() [1/2]

◆ addRows() [2/2]

◆ applyColCut()

◆ applyRowCut()

◆ applyRowCuts() [1/2]

◆ applyRowCuts() [2/2]

◆ assignProblem() [1/2]

◆ assignProblem() [2/2]

◆ branchAndBound()

◆ clone()

◆ deleteColNames()

◆ deleteCols()

◆ deleteRowNames()

◆ deleteRows()

◆ dfltRowColName()

◆ getColLower()

◆ getColName()

◆ getColNames()

◆ getColSolution()

◆ getColUpper()

◆ getCutoff()

◆ getDblParam()

◆ getDualRays()

◆ getEmptyWarmStart()

◆ getHintParam() [1/2]

◆ getHintParam() [2/2]

◆ getInfinity()

◆ getIntParam()

◆ getIterationCount()

◆ getMatrixByCol()

◆ getMatrixByRow()

◆ getMaximumNodes()

◆ getMaximumSeconds()

◆ getMaximumSolutions()

◆ getModelPtr()

◆ getNodeCount()

◆ getNumCols()

◆ getNumElements()

◆ getNumRows()

◆ getObjCoefficients()

◆ getObjName()

◆ getObjSense()

◆ getObjValue()

◆ getPrimalRays()

◆ getRealSolverPtr()

◆ getReducedCost()

◆ getRightHandSide()

◆ getRowActivity()

◆ getRowLower()

◆ getRowName()

◆ getRowNames()

◆ getRowPrice()

◆ getRowRange()

◆ getRowSense()

◆ getRowUpper()

◆ getStrParam()

◆ getWarmStart()

◆ initialSolve()

◆ isAbandoned()

◆ isContinuous()

◆ isDualObjectiveLimitReached()

◆ isIterationLimitReached()

◆ isNodeLimitReached()

◆ isPrimalObjectiveLimitReached()

◆ isProvenDualInfeasible()

◆ isProvenOptimal()