Set of LP columns.Class LPColSet implements a set of LPCols. Unless for memory limitations, any number of LPCols may be added to an LPColSet. Single or multiple LPCols may be added to an LPColSet, where each method add() comes with two different signatures. One with and one without a parameter, used for returning the DataKeys assigned to the new LPCols by the set. See DataKey for a more detailed description of the concept of keys. For the concept of renumbering LPCols within an LPColSet after removal of some LPCols, see DataSet. More...

#include <lpcolset.h>

Inheritance diagram for LPColSet:

[legend]

Public Member Functions
Inquiry
int	num () const
	returns the number of LPCols currently in LPColSet.

int	max () const
	returns maximum number of LPCols currently fitting into LPColSet.

const Vector &	maxObj () const

Vector &	maxObj_w ()
	returns vector of objective values w.r.t. maximization.

Real	maxObj (int i) const

Real &	maxObj_w (int i)
	returns objective value (w.r.t. maximization) of `i` 'th LPCol in LPColSet.

Real	maxObj (const DataKey &k) const

Real &	maxObj_w (const DataKey &k)
	returns objective value (w.r.t. maximization) of LPCol with DataKey `k` in LPColSet.

const Vector &	lower () const

Vector &	lower_w ()
	returns vector of lower bound values.

Real	lower (int i) const

Real &	lower_w (int i)
	returns lower bound of `i` 'th LPCol in LPColSet.

Real	lower (const DataKey &k) const

Real &	lower_w (const DataKey &k)
	returns lower bound of LPCol with DataKey `k` in LPColSet.

const Vector &	upper () const

Vector &	upper_w ()
	returns vector of upper bound values.

Real	upper (int i) const

Real &	upper_w (int i)
	returns upper bound of `i` 'th LPCol in LPColSet.

Real	upper (const DataKey &k) const

Real &	upper_w (const DataKey &k)
	returns upper bound of LPCol with DataKey `k` in LPColSet.

SVector &	colVector_w (int i)

const SVector &	colVector (int i) const
	returns colVector of `i` 'th LPCol in LPColSet.

SVector &	colVector_w (const DataKey &k)
	returns writeable colVector of LPCol with DataKey `k` in LPColSet.

const SVector &	colVector (const DataKey &k) const
	returns colVector of LPCol with DataKey `k` in LPColSet.

DataKey	key (int i) const
	returns DataKey of `i` 'th LPCol in LPColSet.

int	number (const DataKey &k) const
	returns number of LPCol with DataKey `k` in LPColSet.

bool	has (const DataKey &k) const
	does DataKey `k` belong to LPColSet ?

Extension
All extension methods come with two signatures, one of which providing a parameter to return the assigned DataKey(s). See DataSet for a more detailed description. All extension methods are designed to automatically reallocate memory if required.
void	add (const LPCol &pcol)

void	add (DataKey &pkey, const LPCol &pcol)
	adds p pcol to LPColSet.

void	add (Real pobj, Real plower, const SVector &pcolVector, Real pupper)

void	add (DataKey &key, Real obj, Real lower, const SVector &colVector, Real upper)
	adds LPCol consisting of objective value `obj`, lower bound `lower`, column vector `colVector` and upper bound `upper` to LPColSet.

void	add (const LPColSet &set)

void	add (DataKey key[], const LPColSet &set)
	adds all LPCols of `set` to LPColSet.

void	xtend (int n, int newmax)
	extends column `n` to fit `newmax` nonzeros.

void	xtend (const DataKey &pkey, int pnewmax)
	extend column with DataKey `key` to fit `newmax` nonzeros.

void	add2 (const DataKey &k, int n, const int idx[], const Real val[])

void	add2 (int i, int n, const int idx[], const Real val[])
	adds `n` nonzero (`idx`, `val`)-pairs to `i` 'th colVector.

SVector &	create (int pnonzeros=0, Real pobj=1, Real plw=0, Real pupp=1)

SVector &	create (DataKey &nkey, int nonzeros=0, Real obj=1, Real low=0, Real up=1)
	creates new LPCol with specified arguments and returns a reference to its column vector.

Shrinking
See DataSet for a description of the renumbering of the remaining LPCols in a LPColSet after the call of a removal method.
void	remove (int i)
	removes `i` 'th LPCol.

void	remove (const DataKey &k)
	removes LPCol with DataKey `k`.

void	remove (int perm[])
	removes multiple elements.

void	remove (const int nums[], int n)
	removes LPCols with numbers `nums`, where `n` is the length of the array `nums`

void	remove (const int nums[], int n, int *perm)
	removes LPCols with numbers `nums`, where `n` is the length of the array `nums`, and stores the index permutation in array `perm`.

void	clear ()
	removes all LPCols from the set.

Memory Management
See SVSet for a description of the memory management methods.
void	reMax (int newmax=0)
	reallocates memory to be able to store `newmax` LPCols.

int	memSize () const
	returns used nonzero memory.

int	memMax () const
	returns length of nonzero memory.

void	memRemax (int newmax)
	resets length of nonzero memory.

void	memPack ()
	garbage collection in nonzero memory.

Miscellaneous
bool	isConsistent () const

Constructors / Destructors
	LPColSet (int pmax=-1, int pmemmax=-1)
	default constructor.

LPColSet &	operator= (const LPColSet &rs)
	assignment operator.

	LPColSet (const LPColSet &rs)
	copy constructor.

	~LPColSet ()
	destructor

Protected Member Functions
Protected helpers
const SVSet *	colSet () const
	return the complete SVSet.

Protected Member Functions inherited from SVSet
void	add (const SVector &svec)
	Add `svec` to the set.

void	add (DataKey &nkey, const SVector &svec)
	Add `svec` to SVSet.

void	add (const SVector svec[], int n)
	Add all `n` SVectors in the array `svec` to the set.

void	add (DataKey nkey[], const SVector svec[], int n)
	Add n SVectors to SVSet.

void	add (const SVSet &pset)
	Add all SVectors in `pset` to an SVSet.

void	add (DataKey nkey[], const SVSet &pset)
	Add all SVectors of `pset` to SVSet.

SVector *	create (int idxmax=-1)
	Creates new SVector in set.

SVector *	create (DataKey &nkey, int idxmax=-1)
	Creates new SVector in set.

void	xtend (SVector &svec, int newmax)
	Extend `svec` to fit `newmax` nonzeros.

void	add2 (SVector &svec, int idx, Real val)
	Add nonzero (`idx`, `val`) to `svec` of this SVSet.

void	add2 (SVector &svec, int n, const int idx[], const Real val[])
	Add `n` nonzeros to `svec` of this SVSet.

void	remove (const DataKey &removekey)
	removes the vector with key `removekey` from the set

void	remove (int removenum)
	removes the vector with number `removenum` from the set

void	remove (const SVector *svec)
	remove one SVector from set.

void	remove (int perm[])
	remove multiple elements.

void	remove (const DataKey keys[], int n)
	Remove `n` SVectors from set.

void	remove (const int nums[], int n)
	Remove `n` SVectors from set.

void	remove (const DataKey keys[], int n, int *perm)

void	remove (const int nums[], int n, int *perm)
	Remove `n` SVectors from set.

void	clear ()
	remove all SVectors from set.

SVector &	operator[] (int n)
	get SVector by number, writeable

const SVector &	operator[] (int n) const
	get SVector by number

SVector &	operator[] (const DataKey &k)
	get SVector by DataKey, writeable

const SVector &	operator[] (const DataKey &k) const
	get SVector by DataKey

int	num () const
	current number of SVectors.

int	max () const
	current maximum number of SVectors.

DataKey	key (int n) const
	get DataKey of vector number

DataKey	key (const SVector *svec) const
	get DataKey of SVector

int	number (const DataKey &k) const
	get vector number of DataKey

int	number (const SVector *svec) const
	get vector number of SVector

bool	has (const DataKey &k) const
	true iff SVSet contains a SVector for DataKey `k`

bool	has (int n) const
	true iff SVSet contains a SVector for vector number n

bool	has (const SVector *svec) const
	is an SVector in the set.

int	memSize () const
	used nonzero memory.

int	memMax () const
	length of nonzero memory.

void	memRemax (int newmax)
	reset length of nonzero memory.

void	memPack ()
	garbage collection in nonzero memory.

void	reMax (int newmax=0)
	reset maximum number of SVectors.

bool	isConsistent () const
	consistency check.

	SVSet (int pmax=-1, int pmemmax=-1, Real pfac=1.1, Real pmemFac=1.2)
	default constructor.

	~SVSet ()
	destructor

SVSet &	operator= (const SVSet &rhs)
	assignment operator.

	SVSet (const SVSet &old)
	copy constructor.

Private Attributes
Data
DVector	low
	vector of lower bounds.

DVector	up
	vector of upper bounds.

DVector	object
	vector of objective coefficients.

Additional Inherited Members

Detailed Description

Set of LP columns.

Class LPColSet implements a set of LPCols. Unless for memory limitations, any number of LPCols may be added to an LPColSet. Single or multiple LPCols may be added to an LPColSet, where each method add() comes with two different signatures. One with and one without a parameter, used for returning the DataKeys assigned to the new LPCols by the set. See DataKey for a more detailed description of the concept of keys. For the concept of renumbering LPCols within an LPColSet after removal of some LPCols, see DataSet.

See Also: DataSet, DataKey

Definition at line 47 of file lpcolset.h.

Constructor & Destructor Documentation

LPColSet	(	int	pmax = `-1`,
		int	pmemmax = `-1`
	)

explicit

default constructor.

The user can specify the initial maximum number of columns max and the initial maximum number of nonzero entries memmax. If these parameters are omitted, a default size is used. However, one can add an arbitrary number of columns to the LPColSet, which may result in automated memory realllocation.

Definition at line 381 of file lpcolset.h.

References LPColSet::isConsistent().

LPColSet ( const LPColSet & rs )

copy constructor.

Definition at line 402 of file lpcolset.h.

References LPColSet::isConsistent().

~LPColSet ( )

destructor

Definition at line 412 of file lpcolset.h.

Member Function Documentation

void add ( const LPCol & pcol )

Definition at line 228 of file lpcolset.h.

Referenced by LPColSet::add(), SPxLP::doAddCol(), SPxLP::doAddCols(), SPxLP::doAddRow(), SPxLP::doAddRows(), SPxLP::getCols(), soplex::readColName(), soplex::readCols(), and SPxSolver::solve().

void add	(	DataKey &	pkey,
		const LPCol &	pcol
	)

adds p pcol to LPColSet.

Definition at line 234 of file lpcolset.h.

References LPColSet::add(), LPCol::colVector(), LPCol::lower(), LPCol::obj(), and LPCol::upper().

void add	(	Real	pobj,
		Real	plower,
		const SVector &	pcolVector,
		Real	pupper
	)

Definition at line 241 of file lpcolset.h.

References LPColSet::add().

void add	(	DataKey &	key,
		Real	obj,
		Real	lower,
		const SVector &	colVector,
		Real	upper
	)

adds LPCol consisting of objective value obj, lower bound lower, column vector colVector and upper bound upper to LPColSet.

Definition at line 24 of file lpcolset.cpp.

References SVSet::add(), Vector::dim(), LPColSet::low, LPColSet::num(), DVector::reDim(), and LPColSet::up.

void add ( const LPColSet & set )

Definition at line 43 of file lpcolset.cpp.

References SVSet::add(), Vector::dim(), LPColSet::low, LPColSet::lower(), LPColSet::maxObj(), LPColSet::num(), DVector::reDim(), LPColSet::up, and LPColSet::upper().

void add	(	DataKey	key[],
		const LPColSet &	set
	)

adds all LPCols of set to LPColSet.

Definition at line 63 of file lpcolset.cpp.

References LPColSet::add(), LPColSet::key(), and LPColSet::num().

void add2	(	const DataKey &	k,
		int	n,
		const int	idx[],
		const Real	val[]
	)

Definition at line 271 of file lpcolset.h.

References SVSet::add2(), and LPColSet::colVector_w().

Referenced by SPxLP::changeCol(), SPxLP::changeElement(), SPxLP::changeRow(), and SPxLP::doAddRow().

void add2	(	int	i,
		int	n,
		const int	idx[],
		const Real	val[]
	)

adds n nonzero (idx, val)-pairs to i 'th colVector.

Definition at line 276 of file lpcolset.h.

References SVSet::add2(), and LPColSet::colVector_w().

void clear ( )

removes all LPCols from the set.

Definition at line 139 of file lpcolset.cpp.

References SVSet::clear(), LPColSet::low, LPColSet::num(), DVector::reDim(), and LPColSet::up.

Referenced by SPxLP::clear(), and SPxLP::getCols().

const SVSet* colSet ( ) const

protected

return the complete SVSet.

Definition at line 65 of file lpcolset.h.

Referenced by SPxSolver::initRep(), SPxSolver::operator=(), SPxEquiliSC::scale(), SPxGeometSC::scale(), and SPxSolver::SPxSolver().

const SVector& colVector ( int i ) const

returns colVector of i 'th LPCol in LPColSet.

Definition at line 184 of file lpcolset.h.

References SVSet::operator[]().

Referenced by SPxLP::colVector(), SPxLP::doAddCols(), and SPxSolver::solve().

const SVector& colVector ( const DataKey & k ) const

returns colVector of LPCol with DataKey k in LPColSet.

Definition at line 194 of file lpcolset.h.

References SVSet::operator[]().

SVector& colVector_w ( int i )

Definition at line 179 of file lpcolset.h.

References SVSet::operator[]().

Referenced by LPColSet::add2(), SPxLP::colVector_w(), and LPColSet::xtend().

SVector& colVector_w ( const DataKey & k )

returns writeable colVector of LPCol with DataKey k in LPColSet.

Definition at line 189 of file lpcolset.h.

References SVSet::operator[]().

SVector& create	(	int	pnonzeros = `0`,
		Real	pobj = `1`,
		Real	plw = `0`,
		Real	pupp = `1`
	)

Definition at line 282 of file lpcolset.h.

SVector & create	(	DataKey &	nkey,
		int	nonzeros = `0`,
		Real	obj = `1`,
		Real	low = `0`,
		Real	up = `1`
	)

creates new LPCol with specified arguments and returns a reference to its column vector.

Definition at line 72 of file lpcolset.cpp.

References SVSet::create(), Vector::dim(), LPColSet::low, LPColSet::num(), DVector::reDim(), and LPColSet::up.

bool has ( const DataKey & k ) const

does DataKey k belong to LPColSet ?

Definition at line 212 of file lpcolset.h.

References SVSet::has().

bool isConsistent ( ) const

Definition at line 147 of file lpcolset.cpp.

References Vector::dim(), DVector::isConsistent(), SVSet::isConsistent(), LPColSet::low, MSGinconsistent, LPColSet::num(), and LPColSet::up.

Referenced by SPxLP::doAddCols(), SPxLP::doAddRows(), SPxLP::isConsistent(), LPColSet::LPColSet(), and LPColSet::operator=().

DataKey key ( int i ) const

returns DataKey of i 'th LPCol in LPColSet.

Definition at line 200 of file lpcolset.h.

References SVSet::key().

Referenced by LPColSet::add(), SPxLP::cId(), SoPlex::getColName(), and SoPlex::getRowName().

const Vector& lower ( ) const

Definition at line 119 of file lpcolset.h.

References LPColSet::low.

Referenced by LPColSet::add(), SPxLP::lower(), and SPxLP::readLPF().

Real lower ( int i ) const

Definition at line 129 of file lpcolset.h.

References LPColSet::low.

Real lower ( const DataKey & k ) const

Definition at line 139 of file lpcolset.h.

References LPColSet::low, and LPColSet::number().

Vector& lower_w ( )

returns vector of lower bound values.

Definition at line 124 of file lpcolset.h.

References LPColSet::low.

Referenced by SPxLP::changeLower(), SPxLP::lower_w(), soplex::readBounds(), and SPxLP::readLPF().

Real& lower_w ( int i )

returns lower bound of i 'th LPCol in LPColSet.

Definition at line 134 of file lpcolset.h.

References LPColSet::low.

Real& lower_w ( const DataKey & k )

returns lower bound of LPCol with DataKey k in LPColSet.

Definition at line 144 of file lpcolset.h.

References LPColSet::low, and LPColSet::number().

int max ( ) const

returns maximum number of LPCols currently fitting into LPColSet.

Definition at line 83 of file lpcolset.h.

References SVSet::max().

Referenced by LPColSet::reMax().

const Vector& maxObj ( ) const

Definition at line 89 of file lpcolset.h.

References LPColSet::object.

Referenced by LPColSet::add(), SPxLP::getObj(), and SPxLP::maxObj().

Real maxObj ( int i ) const

Definition at line 99 of file lpcolset.h.

Real maxObj ( const DataKey & k ) const

Definition at line 109 of file lpcolset.h.

References LPColSet::number().

Vector& maxObj_w ( )

returns vector of objective values w.r.t. maximization.

Definition at line 94 of file lpcolset.h.

References LPColSet::object.

Referenced by SPxLP::changeObj(), SPxLP::changeSense(), SPxLP::doAddCol(), SPxLP::doAddCols(), SPxLP::maxObj_w(), and SPxLP::readLPF().

Real& maxObj_w ( int i )

returns objective value (w.r.t. maximization) of i 'th LPCol in LPColSet.

Definition at line 104 of file lpcolset.h.

Real& maxObj_w ( const DataKey & k )

returns objective value (w.r.t. maximization) of LPCol with DataKey k in LPColSet.

Definition at line 114 of file lpcolset.h.

References LPColSet::number().

int memMax ( ) const

returns length of nonzero memory.

Definition at line 345 of file lpcolset.h.

References SVSet::memMax().

void memPack ( )

garbage collection in nonzero memory.

Definition at line 357 of file lpcolset.h.

References SVSet::memPack().

void memRemax ( int newmax )

resets length of nonzero memory.

Definition at line 351 of file lpcolset.h.

References SVSet::memRemax().

Referenced by SPxLP::readMPS().

int memSize ( ) const

returns used nonzero memory.

Definition at line 339 of file lpcolset.h.

References SVSet::memSize().

int num ( ) const

returns the number of LPCols currently in LPColSet.

Definition at line 77 of file lpcolset.h.

References SVSet::num().

Referenced by LPColSet::add(), LPColSet::clear(), LPColSet::create(), SPxLP::doAddCols(), LPColSet::isConsistent(), SPxLP::nCols(), soplex::readCols(), SPxLP::readMPS(), LPColSet::remove(), and SPxSolver::solve().

int number ( const DataKey & k ) const

returns number of LPCol with DataKey k in LPColSet.

Definition at line 206 of file lpcolset.h.

References SVSet::number().

Referenced by LPColSet::lower(), LPColSet::lower_w(), LPColSet::maxObj(), LPColSet::maxObj_w(), SPxLP::number(), LPColSet::remove(), LPColSet::upper(), and LPColSet::upper_w().

LPColSet& operator= ( const LPColSet & rs )

assignment operator.

Definition at line 388 of file lpcolset.h.

References LPColSet::isConsistent(), LPColSet::low, LPColSet::object, SVSet::operator=(), and LPColSet::up.

Referenced by SPxLP::operator=().

void reMax ( int newmax = 0 )

reallocates memory to be able to store newmax LPCols.

Definition at line 330 of file lpcolset.h.

References LPColSet::low, LPColSet::max(), SVSet::reMax(), DVector::reSize(), and LPColSet::up.

Referenced by SPxLP::readMPS().

void remove ( int i )

removes i 'th LPCol.

Definition at line 90 of file lpcolset.cpp.

References LPColSet::low, LPColSet::num(), DVector::reDim(), SVSet::remove(), and LPColSet::up.

Referenced by SPxLP::doRemoveCol(), and SPxLP::doRemoveCols().

void remove ( const DataKey & k )

removes LPCol with DataKey k.

Definition at line 302 of file lpcolset.h.

References LPColSet::number().

void remove ( int perm[] )

removes multiple elements.

Definition at line 101 of file lpcolset.cpp.

References LPColSet::low, LPColSet::num(), DVector::reDim(), SVSet::remove(), and LPColSet::up.

void remove	(	const int	nums[],
		int	n
	)

removes LPCols with numbers nums, where n is the length of the array nums

Definition at line 311 of file lpcolset.h.

References DataArray< T >::get_ptr(), and LPColSet::num().

void remove	(	const int	nums[],
		int	n,
		int *	perm
	)

removes LPCols with numbers nums, where n is the length of the array nums, and stores the index permutation in array perm.

Definition at line 120 of file lpcolset.cpp.

References LPColSet::low, LPColSet::num(), DVector::reDim(), SVSet::remove(), and LPColSet::up.

const Vector& upper ( ) const

Definition at line 149 of file lpcolset.h.

References LPColSet::up.

Referenced by LPColSet::add(), SPxLP::readLPF(), and SPxLP::upper().

Real upper ( int i ) const

Definition at line 159 of file lpcolset.h.

References LPColSet::up.

Real upper ( const DataKey & k ) const

Definition at line 169 of file lpcolset.h.

References LPColSet::number(), and LPColSet::up.

Vector& upper_w ( )

returns vector of upper bound values.

Definition at line 154 of file lpcolset.h.

References LPColSet::up.

Referenced by SPxLP::changeUpper(), soplex::readBounds(), SPxLP::readLPF(), and SPxLP::upper_w().

Real& upper_w ( int i )

returns upper bound of i 'th LPCol in LPColSet.

Definition at line 164 of file lpcolset.h.

References LPColSet::up.

Real& upper_w ( const DataKey & k )

returns upper bound of LPCol with DataKey k in LPColSet.

Definition at line 174 of file lpcolset.h.

References LPColSet::number(), and LPColSet::up.

void xtend	(	int	n,
		int	newmax
	)

extends column n to fit newmax nonzeros.

Definition at line 259 of file lpcolset.h.

References LPColSet::colVector_w(), and SVSet::xtend().

Referenced by SPxLP::doAddRows().

void xtend	(	const DataKey &	pkey,
		int	pnewmax
	)

extend column with DataKey key to fit newmax nonzeros.

Definition at line 265 of file lpcolset.h.

References LPColSet::colVector_w(), and SVSet::xtend().

Member Data Documentation

DVector low

private

vector of lower bounds.

Definition at line 54 of file lpcolset.h.

Referenced by LPColSet::add(), LPColSet::clear(), LPColSet::create(), LPColSet::isConsistent(), LPColSet::lower(), LPColSet::lower_w(), LPColSet::operator=(), LPColSet::reMax(), and LPColSet::remove().

DVector object

private

vector of objective coefficients.

Definition at line 56 of file lpcolset.h.

Referenced by LPColSet::maxObj(), LPColSet::maxObj_w(), and LPColSet::operator=().

DVector up

private

vector of upper bounds.

Definition at line 55 of file lpcolset.h.

Referenced by LPColSet::add(), LPColSet::clear(), LPColSet::create(), LPColSet::isConsistent(), LPColSet::operator=(), LPColSet::reMax(), LPColSet::remove(), LPColSet::upper(), and LPColSet::upper_w().

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation