CoinSnapshot Class Reference

NON Abstract Base Class for interfacing with cut generators or branching code or . More...

#include <CoinSnapshot.hpp>

Collaboration diagram for CoinSnapshot:

Classes
struct	coinOwned
	To say whether arrays etc are owned by CoinSnapshot. More...
Public Member Functions
Problem query methods
The Matrix pointers may be NULL
int	getNumCols () const
	Get number of columns.
int	getNumRows () const
	Get number of rows.
int	getNumElements () const
	Get number of nonzero elements.
int	getNumIntegers () const
	Get number of integer variables.
const double *	getColLower () const
	Get pointer to array[getNumCols()] of column lower bounds.
const double *	getColUpper () const
	Get pointer to array[getNumCols()] of column upper bounds.
const double *	getRowLower () const
	Get pointer to array[getNumRows()] of row lower bounds.
const double *	getRowUpper () const
	Get pointer to array[getNumRows()] of row upper bounds.
const double *	getRightHandSide () const
	Get pointer to array[getNumRows()] of row right-hand sides This gives same results as OsiSolverInterface for useful cases If getRowUpper()[i] != infinity then getRightHandSide()[i] == getRowUpper()[i] else getRightHandSide()[i] == getRowLower()[i].
const double *	getObjCoefficients () const
	Get pointer to array[getNumCols()] of objective function coefficients.
double	getObjSense () const
	Get objective function sense (1 for min (default), -1 for max).
bool	isContinuous (int colIndex) const
	Return true if variable is continuous.
bool	isBinary (int colIndex) const
	Return true if variable is binary.
bool	isInteger (int colIndex) const
	Return true if column is integer.
bool	isIntegerNonBinary (int colIndex) const
	Return true if variable is general integer.
bool	isFreeBinary (int colIndex) const
	Return true if variable is binary and not fixed at either bound.
const char *	getColType () const
	Get colType array ('B', 'I', or 'C' for Binary, Integer and Continuous).
const CoinPackedMatrix *	getMatrixByRow () const
	Get pointer to row-wise copy of current matrix.
const CoinPackedMatrix *	getMatrixByCol () const
	Get pointer to column-wise copy of current matrix.
const CoinPackedMatrix *	getOriginalMatrixByRow () const
	Get pointer to row-wise copy of "original" matrix.
const CoinPackedMatrix *	getOriginalMatrixByCol () const
	Get pointer to column-wise copy of "original" matrix.
Solution query methods

const double *	getColSolution () const
	Get pointer to array[getNumCols()] of primal variable values.
const double *	getRowPrice () const
	Get pointer to array[getNumRows()] of dual variable values.
const double *	getReducedCost () const
	Get a pointer to array[getNumCols()] of reduced costs.
const double *	getRowActivity () const
	Get pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector).
const double *	getDoNotSeparateThis () const
	Get pointer to array[getNumCols()] of primal variable values which should not be separated (for debug).
Other scalar get methods

double	getInfinity () const
	Get solver's value for infinity.
double	getObjValue () const
	Get objective function value - includinbg any offset i.e.
double	getObjOffset () const
	Get objective offset i.e. sum c sub j * x subj -objValue = objOffset.
double	getDualTolerance () const
	Get dual tolerance.
double	getPrimalTolerance () const
	Get primal tolerance.
double	getIntegerTolerance () const
	Get integer tolerance.
double	getIntegerUpperBound () const
	Get integer upper bound i.e. best solution * getObjSense.
double	getIntegerLowerBound () const
	Get integer lower bound i.e. best possible solution * getObjSense.
Method to input a problem

void	loadProblem (const CoinPackedMatrix &matrix, const double collb, const double colub, const double obj, const double rowlb, const double *rowub, bool makeRowCopy=false)
	Load in an problem by copying the arguments (the constraints on the rows are given by lower and upper bounds).
Methods to set data

void	setNumCols (int value)
	Set number of columns.
void	setNumRows (int value)
	Set number of rows.
void	setNumElements (int value)
	Set number of nonzero elements.
void	setNumIntegers (int value)
	Set number of integer variables.
void	setColLower (const double *array, bool copyIn=true)
	Set pointer to array[getNumCols()] of column lower bounds.
void	setColUpper (const double *array, bool copyIn=true)
	Set pointer to array[getNumCols()] of column upper bounds.
void	setRowLower (const double *array, bool copyIn=true)
	Set pointer to array[getNumRows()] of row lower bounds.
void	setRowUpper (const double *array, bool copyIn=true)
	Set pointer to array[getNumRows()] of row upper bounds.
void	setRightHandSide (const double *array, bool copyIn=true)
	Set pointer to array[getNumRows()] of row right-hand sides This gives same results as OsiSolverInterface for useful cases If getRowUpper()[i] != infinity then getRightHandSide()[i] == getRowUpper()[i] else getRightHandSide()[i] == getRowLower()[i].
void	createRightHandSide ()
	Create array[getNumRows()] of row right-hand sides using existing information This gives same results as OsiSolverInterface for useful cases If getRowUpper()[i] != infinity then getRightHandSide()[i] == getRowUpper()[i] else getRightHandSide()[i] == getRowLower()[i].
void	setObjCoefficients (const double *array, bool copyIn=true)
	Set pointer to array[getNumCols()] of objective function coefficients.
void	setObjSense (double value)
	Set objective function sense (1 for min (default), -1 for max).
void	setColType (const char *array, bool copyIn=true)
	Set colType array ('B', 'I', or 'C' for Binary, Integer and Continuous).
void	setMatrixByRow (const CoinPackedMatrix *matrix, bool copyIn=true)
	Set pointer to row-wise copy of current matrix.
void	createMatrixByRow ()
	Create row-wise copy from MatrixByCol.
void	setMatrixByCol (const CoinPackedMatrix *matrix, bool copyIn=true)
	Set pointer to column-wise copy of current matrix.
void	setOriginalMatrixByRow (const CoinPackedMatrix *matrix, bool copyIn=true)
	Set pointer to row-wise copy of "original" matrix.
void	setOriginalMatrixByCol (const CoinPackedMatrix *matrix, bool copyIn=true)
	Set pointer to column-wise copy of "original" matrix.
void	setColSolution (const double *array, bool copyIn=true)
	Set pointer to array[getNumCols()] of primal variable values.
void	setRowPrice (const double *array, bool copyIn=true)
	Set pointer to array[getNumRows()] of dual variable values.
void	setReducedCost (const double *array, bool copyIn=true)
	Set a pointer to array[getNumCols()] of reduced costs.
void	setRowActivity (const double *array, bool copyIn=true)
	Set pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector).
void	setDoNotSeparateThis (const double *array, bool copyIn=true)
	Set pointer to array[getNumCols()] of primal variable values which should not be separated (for debug).
void	setInfinity (double value)
	Set solver's value for infinity.
void	setObjValue (double value)
	Set objective function value (including any rhs offset).
void	setObjOffset (double value)
	Set objective offset i.e. sum c sub j * x subj -objValue = objOffset.
void	setDualTolerance (double value)
	Set dual tolerance.
void	setPrimalTolerance (double value)
	Set primal tolerance.
void	setIntegerTolerance (double value)
	Set integer tolerance.
void	setIntegerUpperBound (double value)
	Set integer upper bound i.e. best solution * getObjSense.
void	setIntegerLowerBound (double value)
	Set integer lower bound i.e. best possible solution * getObjSense.
Constructors and destructors

	CoinSnapshot ()
	Default Constructor.
	CoinSnapshot (const CoinSnapshot &)
	Copy constructor.
CoinSnapshot &	operator= (const CoinSnapshot &rhs)
	Assignment operator.
virtual	~CoinSnapshot ()
	Destructor.
Private Member Functions
private functions

void	gutsOfDestructor (int type)
	Does main work of destructor - type (or'ed) 1 - NULLify pointers 2 - delete pointers 4 - initialize scalars (tolerances etc) 8 - initialize scalars (objValue etc0.
void	gutsOfCopy (const CoinSnapshot &rhs)
	Does main work of copy.
Private Attributes
Private member data

double	objSense_
	objective function sense (1 for min (default), -1 for max)
double	infinity_
	solver's value for infinity
double	objValue_
	objective function value (including any rhs offset)
double	objOffset_
	objective offset i.e. sum c sub j * x subj -objValue = objOffset
double	dualTolerance_
	dual tolerance
double	primalTolerance_
	primal tolerance
double	integerTolerance_
	integer tolerance
double	integerUpperBound_
	integer upper bound i.e. best solution * getObjSense
double	integerLowerBound_
	integer lower bound i.e. best possible solution * getObjSense
const double *	colLower_
	pointer to array[getNumCols()] of column lower bounds
const double *	colUpper_
	pointer to array[getNumCols()] of column upper bounds
const double *	rowLower_
	pointer to array[getNumRows()] of row lower bounds
const double *	rowUpper_
	pointer to array[getNumRows()] of row upper bounds
const double *	rightHandSide_
	pointer to array[getNumRows()] of rhs side values
const double *	objCoefficients_
	pointer to array[getNumCols()] of objective function coefficients
const char *	colType_
	colType array ('B', 'I', or 'C' for Binary, Integer and Continuous)
const CoinPackedMatrix *	matrixByRow_
	pointer to row-wise copy of current matrix
const CoinPackedMatrix *	matrixByCol_
	pointer to column-wise copy of current matrix
const CoinPackedMatrix *	originalMatrixByRow_
	pointer to row-wise copy of "original" matrix
const CoinPackedMatrix *	originalMatrixByCol_
	pointer to column-wise copy of "original" matrix
const double *	colSolution_
	pointer to array[getNumCols()] of primal variable values
const double *	rowPrice_
	pointer to array[getNumRows()] of dual variable values
const double *	reducedCost_
	a pointer to array[getNumCols()] of reduced costs
const double *	rowActivity_
	pointer to array[getNumRows()] of row activity levels (constraint matrix times the solution vector).
const double *	doNotSeparateThis_
	pointer to array[getNumCols()] of primal variable values which should not be separated (for debug)
int	numCols_
	number of columns
int	numRows_
	number of rows
int	numElements_
	number of nonzero elements
int	numIntegers_
	number of integer variables
coinOwned	owned_
	objective function sense (1 for min (default), -1 for max)

Detailed Description

NON Abstract Base Class for interfacing with cut generators or branching code or .

It is designed to be snapshot of a problem at a node in tree

The class may or may not own the arrays - see owned_

Querying a problem that has no data associated with it will result in zeros for the number of rows and columns, and NULL pointers from the methods that return arrays.

Definition at line 22 of file CoinSnapshot.hpp.

Constructor & Destructor Documentation

CoinSnapshot::CoinSnapshot ( )

Default Constructor.

CoinSnapshot::CoinSnapshot ( const CoinSnapshot & )

Copy constructor.

virtual CoinSnapshot::~CoinSnapshot ( ) [virtual]

Destructor.

Member Function Documentation

int CoinSnapshot::getNumCols ( ) const [inline]

Get number of columns.

Definition at line 33 of file CoinSnapshot.hpp.

int CoinSnapshot::getNumRows ( ) const [inline]

Get number of rows.

Definition at line 37 of file CoinSnapshot.hpp.

int CoinSnapshot::getNumElements ( ) const [inline]

Get number of nonzero elements.

Definition at line 41 of file CoinSnapshot.hpp.

int CoinSnapshot::getNumIntegers ( ) const [inline]

Get number of integer variables.

Definition at line 45 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getColLower ( ) const [inline]

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

Definition at line 49 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getColUpper ( ) const [inline]

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

Definition at line 53 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getRowLower ( ) const [inline]

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

Definition at line 57 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getRowUpper ( ) const [inline]

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

Definition at line 61 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getRightHandSide ( ) const [inline]

Get pointer to array[getNumRows()] of row right-hand sides This gives same results as OsiSolverInterface for useful cases If getRowUpper()[i] != infinity then getRightHandSide()[i] == getRowUpper()[i] else getRightHandSide()[i] == getRowLower()[i].

Definition at line 71 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getObjCoefficients ( ) const [inline]

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

Definition at line 75 of file CoinSnapshot.hpp.

double CoinSnapshot::getObjSense ( ) const [inline]

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

Definition at line 79 of file CoinSnapshot.hpp.

bool CoinSnapshot::isContinuous ( int colIndex ) const [inline]

Return true if variable is continuous.

Definition at line 83 of file CoinSnapshot.hpp.

bool CoinSnapshot::isBinary ( int colIndex ) const [inline]

Return true if variable is binary.

Definition at line 87 of file CoinSnapshot.hpp.

bool CoinSnapshot::isInteger ( int colIndex ) const [inline]

Return true if column is integer.

Definition at line 91 of file CoinSnapshot.hpp.

bool CoinSnapshot::isIntegerNonBinary ( int colIndex ) const [inline]

Return true if variable is general integer.

Definition at line 95 of file CoinSnapshot.hpp.

bool CoinSnapshot::isFreeBinary ( int colIndex ) const [inline]

Return true if variable is binary and not fixed at either bound.

Definition at line 99 of file CoinSnapshot.hpp.

const char* CoinSnapshot::getColType ( ) const [inline]

Get colType array ('B', 'I', or 'C' for Binary, Integer and Continuous).

Definition at line 103 of file CoinSnapshot.hpp.

const CoinPackedMatrix* CoinSnapshot::getMatrixByRow ( ) const [inline]

Get pointer to row-wise copy of current matrix.

Definition at line 107 of file CoinSnapshot.hpp.

const CoinPackedMatrix* CoinSnapshot::getMatrixByCol ( ) const [inline]

Get pointer to column-wise copy of current matrix.

Definition at line 111 of file CoinSnapshot.hpp.

const CoinPackedMatrix* CoinSnapshot::getOriginalMatrixByRow ( ) const [inline]

Get pointer to row-wise copy of "original" matrix.

Definition at line 115 of file CoinSnapshot.hpp.

const CoinPackedMatrix* CoinSnapshot::getOriginalMatrixByCol ( ) const [inline]

Get pointer to column-wise copy of "original" matrix.

Definition at line 119 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getColSolution ( ) const [inline]

Get pointer to array[getNumCols()] of primal variable values.

Definition at line 126 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getRowPrice ( ) const [inline]

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

Definition at line 130 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getReducedCost ( ) const [inline]

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

Definition at line 134 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getRowActivity ( ) const [inline]

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

Definition at line 138 of file CoinSnapshot.hpp.

const double* CoinSnapshot::getDoNotSeparateThis ( ) const [inline]

Get pointer to array[getNumCols()] of primal variable values which should not be separated (for debug).

Definition at line 142 of file CoinSnapshot.hpp.

double CoinSnapshot::getInfinity ( ) const [inline]

Get solver's value for infinity.

Definition at line 149 of file CoinSnapshot.hpp.

double CoinSnapshot::getObjValue ( ) const [inline]

Get objective function value - includinbg any offset i.e.

sum c sub j * x subj - objValue = objOffset

Definition at line 154 of file CoinSnapshot.hpp.

double CoinSnapshot::getObjOffset ( ) const [inline]

Get objective offset i.e. sum c sub j * x subj -objValue = objOffset.

Definition at line 158 of file CoinSnapshot.hpp.

double CoinSnapshot::getDualTolerance ( ) const [inline]

Get dual tolerance.

Definition at line 162 of file CoinSnapshot.hpp.

double CoinSnapshot::getPrimalTolerance ( ) const [inline]

Get primal tolerance.

Definition at line 166 of file CoinSnapshot.hpp.

double CoinSnapshot::getIntegerTolerance ( ) const [inline]

Get integer tolerance.

Definition at line 170 of file CoinSnapshot.hpp.

double CoinSnapshot::getIntegerUpperBound ( ) const [inline]

Get integer upper bound i.e. best solution * getObjSense.

Definition at line 174 of file CoinSnapshot.hpp.

double CoinSnapshot::getIntegerLowerBound ( ) const [inline]

Get integer lower bound i.e. best possible solution * getObjSense.

Definition at line 178 of file CoinSnapshot.hpp.

void CoinSnapshot::loadProblem	(	const CoinPackedMatrix &	matrix,
		const double *	collb,
		const double *	colub,
		const double *	obj,
		const double *	rowlb,
		const double *	rowub,
		bool	makeRowCopy = `false`
	)

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

If a pointer is NULL 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

All solution type arrays will be deleted

void CoinSnapshot::setNumCols ( int value ) [inline]

Set number of columns.

Definition at line 211 of file CoinSnapshot.hpp.

void CoinSnapshot::setNumRows ( int value ) [inline]

Set number of rows.

Definition at line 215 of file CoinSnapshot.hpp.

void CoinSnapshot::setNumElements ( int value ) [inline]

Set number of nonzero elements.

Definition at line 219 of file CoinSnapshot.hpp.

void CoinSnapshot::setNumIntegers ( int value ) [inline]

Set number of integer variables.

Definition at line 223 of file CoinSnapshot.hpp.

void CoinSnapshot::setColLower	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setColUpper	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setRowLower	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setRowUpper	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setRightHandSide	(	const double *	array,
		bool	copyIn = `true`
	)

Set pointer to array[getNumRows()] of row right-hand sides This gives same results as OsiSolverInterface for useful cases If getRowUpper()[i] != infinity then getRightHandSide()[i] == getRowUpper()[i] else getRightHandSide()[i] == getRowLower()[i].

void CoinSnapshot::createRightHandSide ( )

Create array[getNumRows()] of row right-hand sides using existing information This gives same results as OsiSolverInterface for useful cases If getRowUpper()[i] != infinity then getRightHandSide()[i] == getRowUpper()[i] else getRightHandSide()[i] == getRowLower()[i].

void CoinSnapshot::setObjCoefficients	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setObjSense ( double value ) [inline]

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

Definition at line 261 of file CoinSnapshot.hpp.

void CoinSnapshot::setColType	(	const char *	array,
		bool	copyIn = `true`
	)

Set colType array ('B', 'I', or 'C' for Binary, Integer and Continuous).

void CoinSnapshot::setMatrixByRow	(	const CoinPackedMatrix *	matrix,
		bool	copyIn = `true`
	)

Set pointer to row-wise copy of current matrix.

void CoinSnapshot::createMatrixByRow ( )

Create row-wise copy from MatrixByCol.

void CoinSnapshot::setMatrixByCol	(	const CoinPackedMatrix *	matrix,
		bool	copyIn = `true`
	)

Set pointer to column-wise copy of current matrix.

void CoinSnapshot::setOriginalMatrixByRow	(	const CoinPackedMatrix *	matrix,
		bool	copyIn = `true`
	)

Set pointer to row-wise copy of "original" matrix.

void CoinSnapshot::setOriginalMatrixByCol	(	const CoinPackedMatrix *	matrix,
		bool	copyIn = `true`
	)

Set pointer to column-wise copy of "original" matrix.

void CoinSnapshot::setColSolution	(	const double *	array,
		bool	copyIn = `true`
	)

Set pointer to array[getNumCols()] of primal variable values.

void CoinSnapshot::setRowPrice	(	const double *	array,
		bool	copyIn = `true`
	)

Set pointer to array[getNumRows()] of dual variable values.

void CoinSnapshot::setReducedCost	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setRowActivity	(	const double *	array,
		bool	copyIn = `true`
	)

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

void CoinSnapshot::setDoNotSeparateThis	(	const double *	array,
		bool	copyIn = `true`
	)

Set pointer to array[getNumCols()] of primal variable values which should not be separated (for debug).

void CoinSnapshot::setInfinity ( double value ) [inline]

Set solver's value for infinity.

Definition at line 298 of file CoinSnapshot.hpp.

void CoinSnapshot::setObjValue ( double value ) [inline]

Set objective function value (including any rhs offset).

Definition at line 302 of file CoinSnapshot.hpp.

void CoinSnapshot::setObjOffset ( double value ) [inline]

Set objective offset i.e. sum c sub j * x subj -objValue = objOffset.

Definition at line 306 of file CoinSnapshot.hpp.

void CoinSnapshot::setDualTolerance ( double value ) [inline]

Set dual tolerance.

Definition at line 310 of file CoinSnapshot.hpp.

void CoinSnapshot::setPrimalTolerance ( double value ) [inline]

Set primal tolerance.

Definition at line 314 of file CoinSnapshot.hpp.

void CoinSnapshot::setIntegerTolerance ( double value ) [inline]

Set integer tolerance.

Definition at line 318 of file CoinSnapshot.hpp.

void CoinSnapshot::setIntegerUpperBound ( double value ) [inline]

Set integer upper bound i.e. best solution * getObjSense.

Definition at line 322 of file CoinSnapshot.hpp.

void CoinSnapshot::setIntegerLowerBound ( double value ) [inline]

Set integer lower bound i.e. best possible solution * getObjSense.

Definition at line 326 of file CoinSnapshot.hpp.

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

Assignment operator.

void CoinSnapshot::gutsOfDestructor ( int type ) [private]

Does main work of destructor - type (or'ed) 1 - NULLify pointers 2 - delete pointers 4 - initialize scalars (tolerances etc) 8 - initialize scalars (objValue etc0.

void CoinSnapshot::gutsOfCopy ( const CoinSnapshot & rhs ) [private]

Does main work of copy.