This class holds a column in a compressed form. More...

#include <BCP_matrix.hpp>

Inheritance diagram for BCP_col:

Collaboration diagram for BCP_col:

Public Member Functions
Query methods
double	Objective () const
	Return the objective coefficient.

double	LowerBound () const
	Return the lower bound.

double	UpperBound () const
	Return the upper bound.

General modifying methods
void	Objective (const double obj)
	Set the objective coefficient to the given value.

void	LowerBound (const double lb)
	Set the lower bound to the given value.

void	UpperBound (const double ub)
	Set the upper bound to the given value.

BCP_col &	operator= (const BCP_col &x)
	Assignment operator: copy over the contents of `x`.

void	assign (const int size, int &ElementIndices, double &ElementValues, const double Obj, const double LB, const double UB)
	Set the objective coefficient, lower and upper bounds to the given values.

void	copy (const int size, const int ElementIndices, const double ElementValues, const double Obj, const double LB, const double UB)
	Copy the arguments into the appropriate data members.

void	copy (BCP_vec< int >::const_iterator firstind, BCP_vec< int >::const_iterator lastind, BCP_vec< double >::const_iterator firstval, BCP_vec< double >::const_iterator lastval, const double Obj, const double LB, const double UB)
	Same as the other `copy()` method, except that instead of using vectors the indices (values) are given in `[firstind,lastind)` (`[firstval,lastval)`).

Constructors / Destructor
	BCP_col ()
	The default constructor creates an empty column with 0 as objective coefficient, 0.0 as lower and +infinity as upper bound.

	BCP_col (const BCP_col &x)
	The copy constructor makes a copy of `x`.

	BCP_col (BCP_vec< int >::const_iterator firstind, BCP_vec< int >::const_iterator lastind, BCP_vec< double >::const_iterator firstval, BCP_vec< double >::const_iterator lastval, const double Obj, const double LB, const double UB)
	This constructor acts exactly like the `copy` method with the same argument list.

	BCP_col (const int size, int &ElementIndices, double &ElementValues, const double Obj, const double LB, const double UB)
	This constructor acts exactly like the `assign` method with the same argument list.

	BCP_col (const CoinPackedVectorBase &vec, const double Obj, const double LB, const double UB)

	~BCP_col ()
	The destructor deletes all data members.

Public Member Functions inherited from CoinPackedVector
virtual int	getNumElements () const

virtual const int *	getIndices () const

virtual const double *	getElements () const

int *	getIndices ()

int	getVectorNumElements () const

const int *	getVectorIndices () const

const double *	getVectorElements () const

double *	getElements ()

const int *	getOriginalPosition () const

void	clear ()

CoinPackedVector &	operator= (const CoinPackedVector &)

CoinPackedVector &	operator= (const CoinPackedVectorBase &rhs)

void	assignVector (int size, int &inds, double &elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setVector (int size, const int inds, const double elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setConstant (int size, const int *inds, double elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setFull (int size, const double *elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setFullNonZero (int size, const double *elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setElement (int index, double element)

void	insert (int index, double element)

void	append (const CoinPackedVectorBase &caboose)

void	swap (int i, int j)

void	truncate (int newSize)

void	operator+= (double value)

void	operator-= (double value)

void	operator*= (double value)

void	operator/= (double value)

void	sort (const CoinCompare3 &tc)

void	sortIncrIndex ()

void	sortDecrIndex ()

void	sortIncrElement ()

void	sortDecrElement ()

void	sortOriginalOrder ()

void	reserve (int n)

int	capacity () const

	CoinPackedVector (bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int size, const int inds, const double elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int capacity, int size, int &inds, double &elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int size, const int *inds, double element, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int size, const double *elements, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (const CoinPackedVector &)

	CoinPackedVector (const CoinPackedVectorBase &rhs)

virtual	~CoinPackedVector ()

virtual int	getNumElements () const

virtual const int *	getIndices () const

virtual const double *	getElements () const

int *	getIndices ()

int	getVectorNumElements () const

const int *	getVectorIndices () const

const double *	getVectorElements () const

double *	getElements ()

const int *	getOriginalPosition () const

void	clear ()

CoinPackedVector &	operator= (const CoinPackedVector &)

CoinPackedVector &	operator= (const CoinPackedVectorBase &rhs)

void	assignVector (int size, int &inds, double &elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setVector (int size, const int inds, const double elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setConstant (int size, const int *inds, double elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setFull (int size, const double *elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setFullNonZero (int size, const double *elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

void	setElement (int index, double element)

void	insert (int index, double element)

void	append (const CoinPackedVectorBase &caboose)

void	swap (int i, int j)

void	truncate (int newSize)

void	operator+= (double value)

void	operator-= (double value)

void	operator*= (double value)

void	operator/= (double value)

void	sort (const CoinCompare3 &tc)

void	sortIncrIndex ()

void	sortDecrIndex ()

void	sortIncrElement ()

void	sortDecrElement ()

void	sortOriginalOrder ()

void	reserve (int n)

int	capacity () const

	CoinPackedVector (bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int size, const int inds, const double elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int capacity, int size, int &inds, double &elems, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int size, const int *inds, double element, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (int size, const double *elements, bool testForDuplicateIndex=COIN_DEFAULT_VALUE_FOR_DUPLICATE)

	CoinPackedVector (const CoinPackedVector &)

	CoinPackedVector (const CoinPackedVectorBase &rhs)

virtual	~CoinPackedVector ()

Public Member Functions inherited from CoinPackedVectorBase
virtual int	getNumElements () const=0

virtual const int *	getIndices () const=0

virtual const double *	getElements () const=0

void	setTestForDuplicateIndex (bool test) const

void	setTestForDuplicateIndexWhenTrue (bool test) const

bool	testForDuplicateIndex () const

void	setTestsOff () const

double *	denseVector (int denseSize) const

double	operator[] (int i) const

int	getMaxIndex () const

int	getMinIndex () const

void	duplicateIndex (const char methodName=NULL, const char className=NULL) const

bool	isExistingIndex (int i) const

int	findIndex (int i) const

bool	operator== (const CoinPackedVectorBase &rhs) const

bool	operator!= (const CoinPackedVectorBase &rhs) const

int	compare (const CoinPackedVectorBase &rhs) const

bool	isEquivalent (const CoinPackedVectorBase &rhs, const FloatEqual &eq) const

bool	isEquivalent (const CoinPackedVectorBase &rhs) const

double	dotProduct (const double *dense) const

double	oneNorm () const

double	normSquare () const

double	twoNorm () const

double	infNorm () const

double	sum () const

virtual int	getNumElements () const=0

virtual const int *	getIndices () const=0

virtual const double *	getElements () const=0

void	setTestForDuplicateIndex (bool test) const

void	setTestForDuplicateIndexWhenTrue (bool test) const

bool	testForDuplicateIndex () const

void	setTestsOff () const

double *	denseVector (int denseSize) const

double	operator[] (int i) const

int	getMaxIndex () const

int	getMinIndex () const

void	duplicateIndex (const char methodName=NULL, const char className=NULL) const

bool	isExistingIndex (int i) const

int	findIndex (int i) const

bool	operator== (const CoinPackedVectorBase &rhs) const

bool	operator!= (const CoinPackedVectorBase &rhs) const

int	compare (const CoinPackedVectorBase &rhs) const

bool	isEquivalent (const CoinPackedVectorBase &rhs, const FloatEqual &eq) const

bool	isEquivalent (const CoinPackedVectorBase &rhs) const

double	dotProduct (const double *dense) const

double	oneNorm () const

double	normSquare () const

double	twoNorm () const

double	infNorm () const

double	sum () const

virtual	~CoinPackedVectorBase ()

Protected Attributes
Data members
double	_Objective
	The objective function coefficient corresponding to the column.

double	_LowerBound
	The lower bound corresponding to the column.

double	_UpperBound
	The upper bound corresponding to the column.

Additional Inherited Members
Protected Member Functions inherited from CoinPackedVectorBase
void	findMaxMinIndices () const

std::set< int > *	indexSet (const char methodName=NULL, const char className=NULL) const

void	clearIndexSet () const

void	clearBase () const

void	copyMaxMinIndex (const CoinPackedVectorBase &x) const

	CoinPackedVectorBase ()

void	findMaxMinIndices () const

std::set< int > *	indexSet (const char methodName=NULL, const char className=NULL) const

void	clearIndexSet () const

void	clearBase () const

void	copyMaxMinIndex (const CoinPackedVectorBase &x) const

Detailed Description

This class holds a column in a compressed form.

That is, it is a packed vector with an objective coefficient, lower and upper bound.

Definition at line 26 of file BCP_matrix.hpp.

Constructor & Destructor Documentation

◆ BCP_col() [1/5]

BCP_col::BCP_col ( )

inline

The default constructor creates an empty column with 0 as objective coefficient, 0.0 as lower and +infinity as upper bound.

Definition at line 113 of file BCP_matrix.hpp.

◆ BCP_col() [2/5]

BCP_col::BCP_col ( const BCP_col & x )

inline

The copy constructor makes a copy of x.

Definition at line 116 of file BCP_matrix.hpp.

◆ BCP_col() [3/5]

BCP_col::BCP_col	(	BCP_vec< int >::const_iterator	firstind,
		BCP_vec< int >::const_iterator	lastind,
		BCP_vec< double >::const_iterator	firstval,
		BCP_vec< double >::const_iterator	lastval,
		const double	Obj,
		const double	LB,
		const double	UB
	)

inline

This constructor acts exactly like the copy method with the same argument list.

Definition at line 121 of file BCP_matrix.hpp.

◆ BCP_col() [4/5]

BCP_col::BCP_col	(	const int	size,
		int *&	ElementIndices,
		double *&	ElementValues,
		const double	Obj,
		const double	LB,
		const double	UB
	)

inline

This constructor acts exactly like the assign method with the same argument list.

Definition at line 131 of file BCP_matrix.hpp.

◆ BCP_col() [5/5]

BCP_col::BCP_col	(	const CoinPackedVectorBase &	vec,
		const double	Obj,
		const double	LB,
		const double	UB
	)

inline

Definition at line 137 of file BCP_matrix.hpp.

◆ ~BCP_col()

BCP_col::~BCP_col ( )

inline

The destructor deletes all data members.

Definition at line 143 of file BCP_matrix.hpp.

Member Function Documentation

◆ Objective() [1/2]

double BCP_col::Objective ( ) const

inline

Return the objective coefficient.

Definition at line 44 of file BCP_matrix.hpp.

◆ LowerBound() [1/2]

double BCP_col::LowerBound ( ) const

inline

Return the lower bound.

Definition at line 46 of file BCP_matrix.hpp.

◆ UpperBound() [1/2]

double BCP_col::UpperBound ( ) const

inline

Return the upper bound.

Definition at line 48 of file BCP_matrix.hpp.

◆ Objective() [2/2]

void BCP_col::Objective ( const double obj )

inline

Set the objective coefficient to the given value.

Definition at line 55 of file BCP_matrix.hpp.

◆ LowerBound() [2/2]

void BCP_col::LowerBound ( const double lb )

inline

Set the lower bound to the given value.

Definition at line 57 of file BCP_matrix.hpp.

◆ UpperBound() [2/2]

void BCP_col::UpperBound ( const double ub )

inline

Set the upper bound to the given value.

Definition at line 59 of file BCP_matrix.hpp.

◆ operator=()

BCP_col & BCP_col::operator= ( const BCP_col & x )

inline

Assignment operator: copy over the contents of x.

Definition at line 62 of file BCP_matrix.hpp.

◆ assign()

void BCP_col::assign	(	const int	size,
		int *&	ElementIndices,
		double *&	ElementValues,
		const double	Obj,
		const double	LB,
		const double	UB
	)

inline

Set the objective coefficient, lower and upper bounds to the given values.

Also invokes the assign method of the underlying packed vector.

Definition at line 73 of file BCP_matrix.hpp.

◆ copy() [1/2]

void BCP_col::copy	(	const int	size,
		const int *	ElementIndices,
		const double *	ElementValues,
		const double	Obj,
		const double	LB,
		const double	UB
	)

inline

Copy the arguments into the appropriate data members.

Definition at line 83 of file BCP_matrix.hpp.

◆ copy() [2/2]

void BCP_col::copy	(	BCP_vec< int >::const_iterator	firstind,
		BCP_vec< int >::const_iterator	lastind,
		BCP_vec< double >::const_iterator	firstval,
		BCP_vec< double >::const_iterator	lastval,
		const double	Obj,
		const double	LB,
		const double	UB
	)

inline

Same as the other copy() method, except that instead of using vectors the indices (values) are given in [firstind,lastind) ([firstval,lastval)).

Definition at line 95 of file BCP_matrix.hpp.

Member Data Documentation

◆ _Objective

double BCP_col::_Objective

protected

The objective function coefficient corresponding to the column.

Definition at line 32 of file BCP_matrix.hpp.

◆ _LowerBound

double BCP_col::_LowerBound

protected

The lower bound corresponding to the column.

Definition at line 34 of file BCP_matrix.hpp.

◆ _UpperBound

double BCP_col::_UpperBound

protected

The upper bound corresponding to the column.

Definition at line 36 of file BCP_matrix.hpp.

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

/builddir/build/BUILD/Bcp-1.4.4/src/include/BCP_matrix.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BCP_col() [1/5]

◆ BCP_col() [2/5]

◆ BCP_col() [3/5]

◆ BCP_col() [4/5]

◆ BCP_col() [5/5]

◆ ~BCP_col()

Member Function Documentation

◆ Objective() [1/2]

◆ LowerBound() [1/2]

◆ UpperBound() [1/2]

◆ Objective() [2/2]

◆ LowerBound() [2/2]

◆ UpperBound() [2/2]

◆ operator=()

◆ assign()

◆ copy() [1/2]

◆ copy() [2/2]

Member Data Documentation

◆ _Objective

◆ _LowerBound

◆ _UpperBound