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

#include <lprowset.h>

Inheritance diagram for LPRowSet:

[legend]

Public Member Functions
Access / modification
int	num () const
	returns the number of LPRows in LPRowSet.

int	max () const
	returns the maximum number of LPRows that fit.

const Vector &	lhs () const
	returns the vector of lhs values.

Vector &	lhs_w ()
	returns the vector of lhs values.

Real	lhs (int i) const
	returns the lhs of the `i` 'th LPRow.

Real &	lhs_w (int i)
	returns the lhs of the `i` 'th LPRow.

Real	lhs (const DataKey &k) const
	returns the lhs of the LPRow with DataKey `k` in LPRowSet.

Real &	lhs_w (const DataKey &k)
	returns the lhs of the LPRow with DataKey `k` in LPRowSet.

const Vector &	rhs () const
	returns the vector of rhs values.

Vector &	rhs_w ()
	returns the vector of rhs values (writeable).

Real	rhs (int i) const
	returns the rhs of the `i` 'th LPRow.

Real &	rhs_w (int i)
	returns the rhs of the `i` 'th LPRow (writeable).

Real	rhs (const DataKey &k) const
	returns the rhs of the LPRow with DataKey `k` in LPRowSet.

Real &	rhs_w (const DataKey &k)
	returns the rhs of the LPRow with DataKey `k` in LPRowSet (writeable).

SVector &	rowVector_w (int i)
	returns a writable rowVector of the `i` 'th LPRow.

const SVector &	rowVector (int i) const
	returns the rowVector of the `i` 'th LPRow.

SVector &	rowVector_w (const DataKey &k)
	returns a writable rowVector of the LPRow with DataKey `k`.

const SVector &	rowVector (const DataKey &k) const
	returns the rowVector of the LPRow with DataKey `k`.

LPRow::Type	type (int i) const
	returns the inequalitiy type of the `i` 'th LPRow.

LPRow::Type	type (const DataKey &k) const
	returns the inequality type of the LPRow with DataKey `k`.

void	setType (int i, LPRow::Type type)
	changes the inequality type of row `i` to `type`.

Real	value (int i) const
	returns the value of the `i'th` LPRow.

Real	value (const DataKey &k) const
	returns the value of the LPRow with DataKey `k`.

DataKey	key (int i) const
	returns the DataKey of the `i` 'th LPRow in LPRowSet.

int	number (const DataKey &k) const
	returns the number of the LPRow with DataKey `k` in LPRowSet.

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

Extension
Extension methods come with two signatures, one of them providing a parameter to return the assigned DataKey(s). See DataSet for a more detailed description. All extension methods will automatically rearrange or allocate more memory if required.
void	add (const LPRow &row)

void	add (DataKey &pkey, const LPRow &prow)
	adds `row` to LPRowSet.

void	add (Real plhs, const SVector &prowVector, Real prhs)
	adds LPRow consisting of left hand side `lhs`, row vector `rowVector`, and right hand side `rhs` to LPRowSet.

void	add (DataKey &key, Real lhs, const SVector &rowVector, Real rhs)
	adds LPRow consisting of left hand side `lhs`, row vector `rowVector`, and right hand side `rhs` to LPRowSet, with DataKey `key`.

void	add (const LPRowSet &set)

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

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

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

void	add2 (const DataKey &k, int n, const int idx[], const Real val[])
	adds `n` nonzero (`idx`, `val`)-pairs to rowVector with DataKey `k`.

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

SVector &	create (int pnonzeros=0, Real plhs=0, Real prhs=1)
	creates new LPRow with specified parameters and returns a reference to its row vector.

SVector &	create (DataKey &nkey, int nonzeros=0, Real lhs=0, Real rhs=1)
	creates new LPRow with specified parameters and returns a reference to its row vector.

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

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

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

void	remove (const int nums[], int n)
	removes `n` LPRows with row numbers given by `nums`.

void	remove (const int nums[], int n, int *perm)
	removes `n` LPRows with row numbers given by `nums`, Stores permutation of row indices in `perm`.

void	clear ()
	removes all LPRows.

Memory Management
For a description of the memory management methods, see the documentation of SVSet, which has been used for implementating LPRowSet.
void	reMax (int newmax=0)
	reallocates memory to be able to store `newmax` LPRows.

int	memSize () const
	returns number of used nonzero entries.

int	memMax () const
	returns length of nonzero memory.

void	memRemax (int newmax)
	reallocates memory to be able to store `newmax` nonzeros.

void	memPack ()
	garbage collection in nonzero memory.

Consistency check
bool	isConsistent () const
	check consistency.

Construction / Destruction
	LPRowSet (int pmax=-1, int pmemmax=-1)
	default constructor.

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

	LPRowSet (const LPRowSet &rs)
	copy constructor.

	~LPRowSet ()
	destructor

Protected Member Functions
Helpers
const SVSet *	rowSet () 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	left
	vector of left hand sides (lower bounds) of LPRows.

DVector	right
	vector of right hand sides (upper bounds) of LPRows.

Additional Inherited Members

Detailed Description

Set of LP rows.

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

See Also: DataSet, DataKey

Definition at line 47 of file lprowset.h.

Constructor & Destructor Documentation

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

explicit

default constructor.

The user can specify the initial maximum number of rows 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 rows to the LPRowSet, which may result in automated memory realllocation.

Definition at line 390 of file lprowset.h.

References LPRowSet::isConsistent().

LPRowSet ( const LPRowSet & rs )

copy constructor.

Definition at line 411 of file lprowset.h.

References LPRowSet::isConsistent().

~LPRowSet ( )

destructor

Definition at line 420 of file lprowset.h.

Member Function Documentation

void add ( const LPRow & row )

Definition at line 238 of file lprowset.h.

Referenced by LPRowSet::add(), SPxLP::doAddCol(), SPxLP::doAddCols(), SPxLP::doAddRow(), SPxLP::doAddRows(), SPxLP::getRows(), SPxLP::readLPF(), and soplex::readRows().

void add	(	DataKey &	pkey,
		const LPRow &	prow
	)

adds row to LPRowSet.

Definition at line 244 of file lprowset.h.

References LPRowSet::add(), LPRow::lhs(), LPRow::rhs(), and LPRow::rowVector().

void add	(	Real	plhs,
		const SVector &	prowVector,
		Real	prhs
	)

adds LPRow consisting of left hand side lhs, row vector rowVector, and right hand side rhs to LPRowSet.

Definition at line 250 of file lprowset.h.

References LPRowSet::add().

void add	(	DataKey &	key,
		Real	lhs,
		const SVector &	rowVector,
		Real	rhs
	)

adds LPRow consisting of left hand side lhs, row vector rowVector, and right hand side rhs to LPRowSet, with DataKey key.

Definition at line 28 of file lprowset.cpp.

References SVSet::add(), Vector::dim(), LPRowSet::left, LPRowSet::num(), DVector::reDim(), and LPRowSet::right.

void add ( const LPRowSet & set )

Definition at line 40 of file lprowset.cpp.

References SVSet::add(), Vector::dim(), LPRowSet::left, LPRowSet::lhs(), LPRowSet::num(), DVector::reDim(), LPRowSet::rhs(), and LPRowSet::right.

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

adds all LPRows of set to LPRowSet.

Definition at line 58 of file lprowset.cpp.

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

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

adds n nonzero (idx, val)-pairs to rowVector with DataKey k.

Definition at line 278 of file lprowset.h.

References SVSet::add2(), and LPRowSet::rowVector_w().

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

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

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

Definition at line 284 of file lprowset.h.

References SVSet::add2(), and LPRowSet::rowVector_w().

void clear ( )

removes all LPRows.

Definition at line 127 of file lprowset.cpp.

References SVSet::clear(), LPRowSet::left, LPRowSet::num(), DVector::reDim(), and LPRowSet::right.

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

SVector& create	(	int	pnonzeros = `0`,
		Real	plhs = `0`,
		Real	prhs = `1`
	)

creates new LPRow with specified parameters and returns a reference to its row vector.

Definition at line 290 of file lprowset.h.

SVector & create	(	DataKey &	nkey,
		int	nonzeros = `0`,
		Real	lhs = `0`,
		Real	rhs = `1`
	)

creates new LPRow with specified parameters and returns a reference to its row vector.

Definition at line 68 of file lprowset.cpp.

References SVSet::create(), Vector::dim(), LPRowSet::left, LPRowSet::num(), DVector::reDim(), and LPRowSet::right.

bool has ( const DataKey & k ) const

does DataKey k belong to LPRowSet ?

Definition at line 222 of file lprowset.h.

References SVSet::has().

bool isConsistent ( ) const

check consistency.

Definition at line 162 of file lprowset.cpp.

References Vector::dim(), DVector::isConsistent(), SVSet::isConsistent(), LPRowSet::left, MSGinconsistent, LPRowSet::num(), and LPRowSet::right.

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

DataKey key ( int i ) const

returns the DataKey of the i 'th LPRow in LPRowSet.

Definition at line 210 of file lprowset.h.

References SVSet::key().

Referenced by LPRowSet::add(), and SPxLP::rId().

const Vector& lhs ( ) const

returns the vector of lhs values.

Definition at line 86 of file lprowset.h.

References LPRowSet::left.

Referenced by LPRowSet::add(), SPxLP::lhs(), soplex::readRanges(), soplex::readRhs(), LPRowSet::setType(), LPRowSet::type(), and LPRowSet::value().

Real lhs ( int i ) const

returns the lhs of the i 'th LPRow.

Definition at line 96 of file lprowset.h.

References LPRowSet::left.

Real lhs ( const DataKey & k ) const

returns the lhs of the LPRow with DataKey k in LPRowSet.

Definition at line 106 of file lprowset.h.

References LPRowSet::left, and LPRowSet::number().

Vector& lhs_w ( )

returns the vector of lhs values.

Definition at line 91 of file lprowset.h.

References LPRowSet::left.

Referenced by SPxLP::changeLhs(), SPxLP::lhs_w(), soplex::readRanges(), soplex::readRhs(), and LPRowSet::setType().

Real& lhs_w ( int i )

returns the lhs of the i 'th LPRow.

Definition at line 101 of file lprowset.h.

References LPRowSet::left.

Real& lhs_w ( const DataKey & k )

returns the lhs of the LPRow with DataKey k in LPRowSet.

Definition at line 111 of file lprowset.h.

References LPRowSet::left, and LPRowSet::number().

int max ( ) const

returns the maximum number of LPRows that fit.

Definition at line 81 of file lprowset.h.

References SVSet::max().

Referenced by LPRowSet::reMax().

int memMax ( ) const

returns length of nonzero memory.

Definition at line 355 of file lprowset.h.

References SVSet::memMax().

void memPack ( )

garbage collection in nonzero memory.

Definition at line 367 of file lprowset.h.

References SVSet::memPack().

void memRemax ( int newmax )

reallocates memory to be able to store newmax nonzeros.

Definition at line 361 of file lprowset.h.

References SVSet::memRemax().

int memSize ( ) const

returns number of used nonzero entries.

Definition at line 349 of file lprowset.h.

References SVSet::memSize().

int num ( ) const

returns the number of LPRows in LPRowSet.

Definition at line 76 of file lprowset.h.

References SVSet::num().

Referenced by LPRowSet::add(), LPRowSet::clear(), LPRowSet::create(), SPxLP::doAddRows(), LPRowSet::isConsistent(), SPxLP::nRows(), soplex::readCols(), SPxLP::readLPF(), SPxLP::readMPS(), soplex::readRows(), and LPRowSet::remove().

int number ( const DataKey & k ) const

returns the number of the LPRow with DataKey k in LPRowSet.

Definition at line 216 of file lprowset.h.

References SVSet::number().

Referenced by LPRowSet::lhs(), LPRowSet::lhs_w(), SPxLP::number(), LPRowSet::remove(), LPRowSet::rhs(), LPRowSet::rhs_w(), LPRowSet::type(), and LPRowSet::value().

LPRowSet& operator= ( const LPRowSet & rs )

assignment operator.

Definition at line 397 of file lprowset.h.

References LPRowSet::isConsistent(), LPRowSet::left, SVSet::operator=(), and LPRowSet::right.

Referenced by SPxLP::operator=().

void reMax ( int newmax = 0 )

reallocates memory to be able to store newmax LPRows.

Definition at line 341 of file lprowset.h.

References LPRowSet::left, LPRowSet::max(), SVSet::reMax(), DVector::reSize(), and LPRowSet::right.

void remove ( int i )

removes i 'th LPRow.

Definition at line 84 of file lprowset.cpp.

References LPRowSet::left, LPRowSet::num(), DVector::reDim(), SVSet::remove(), and LPRowSet::right.

Referenced by SPxLP::doRemoveRow(), and SPxLP::doRemoveRows().

void remove ( const DataKey & k )

removes LPRow with DataKey k.

Definition at line 309 of file lprowset.h.

References LPRowSet::number().

void remove ( int perm[] )

removes multiple LPRows.

Definition at line 93 of file lprowset.cpp.

References LPRowSet::left, LPRowSet::num(), DVector::reDim(), SVSet::remove(), and LPRowSet::right.

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

removes n LPRows with row numbers given by nums.

Definition at line 319 of file lprowset.h.

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

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

removes n LPRows with row numbers given by nums, Stores permutation of row indices in perm.

Definition at line 110 of file lprowset.cpp.

References LPRowSet::left, LPRowSet::num(), DVector::reDim(), SVSet::remove(), and LPRowSet::right.

const Vector& rhs ( ) const

returns the vector of rhs values.

Definition at line 116 of file lprowset.h.

References LPRowSet::right.

Referenced by LPRowSet::add(), soplex::readRanges(), soplex::readRhs(), SPxLP::rhs(), LPRowSet::setType(), LPRowSet::type(), and LPRowSet::value().

Real rhs ( int i ) const

returns the rhs of the i 'th LPRow.

Definition at line 126 of file lprowset.h.

References LPRowSet::right.

Real rhs ( const DataKey & k ) const

returns the rhs of the LPRow with DataKey k in LPRowSet.

Definition at line 136 of file lprowset.h.

References LPRowSet::number(), and LPRowSet::right.

Vector& rhs_w ( )

returns the vector of rhs values (writeable).

Definition at line 121 of file lprowset.h.

References LPRowSet::right.

Referenced by SPxLP::changeRhs(), soplex::readRanges(), soplex::readRhs(), SPxLP::rhs_w(), and LPRowSet::setType().

Real& rhs_w ( int i )

returns the rhs of the i 'th LPRow (writeable).

Definition at line 131 of file lprowset.h.

References LPRowSet::right.

Real& rhs_w ( const DataKey & k )

returns the rhs of the LPRow with DataKey k in LPRowSet (writeable).

Definition at line 141 of file lprowset.h.

References LPRowSet::number(), and LPRowSet::right.

const SVSet* rowSet ( ) const

protected

return the complete SVSet.

Definition at line 64 of file lprowset.h.

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

const SVector& rowVector ( int i ) const

returns the rowVector of the i 'th LPRow.

Definition at line 151 of file lprowset.h.

References SVSet::operator[]().

Referenced by SPxLP::doAddRows(), and SPxLP::rowVector().

const SVector& rowVector ( const DataKey & k ) const

returns the rowVector of the LPRow with DataKey k.

Definition at line 161 of file lprowset.h.

References SVSet::operator[]().

SVector& rowVector_w ( int i )

returns a writable rowVector of the i 'th LPRow.

Definition at line 146 of file lprowset.h.

References SVSet::operator[]().

Referenced by LPRowSet::add2(), SPxLP::rowVector_w(), and LPRowSet::xtend().

SVector& rowVector_w ( const DataKey & k )

returns a writable rowVector of the LPRow with DataKey k.

Definition at line 156 of file lprowset.h.

References SVSet::operator[]().

void setType	(	int	i,
		LPRow::Type	type
	)

changes the inequality type of row i to type.

Definition at line 135 of file lprowset.cpp.

References LPRow::EQUAL, LPRow::GREATER_EQUAL, soplex::infinity, LPRow::LESS_EQUAL, LPRowSet::lhs(), LPRowSet::lhs_w(), MSG_ERROR, LPRow::RANGE, LPRowSet::rhs(), LPRowSet::rhs_w(), and soplex::spxout.

LPRow::Type type ( int i ) const

returns the inequalitiy type of the i 'th LPRow.

Definition at line 167 of file lprowset.h.

References LPRow::EQUAL, LPRow::GREATER_EQUAL, soplex::infinity, LPRow::LESS_EQUAL, LPRowSet::lhs(), LPRow::RANGE, and LPRowSet::rhs().

Referenced by SPxLP::number(), SPxLP::rowType(), and LPRowSet::type().

LPRow::Type type ( const DataKey & k ) const

returns the inequality type of the LPRow with DataKey k.

Definition at line 179 of file lprowset.h.

References LPRowSet::number(), and LPRowSet::type().

Real value ( int i ) const

returns the value of the i'th LPRow.

Definition at line 188 of file lprowset.h.

References soplex::infinity, LPRowSet::lhs(), and LPRowSet::rhs().

Referenced by LPRowSet::value().

Real value ( const DataKey & k ) const

returns the value of the LPRow with DataKey k.

The value of a row depends on its type: if the inequality is of type "greater or equal", the value is the lhs of the row. Otherwise, the value is the rhs.

Definition at line 204 of file lprowset.h.

References LPRowSet::number(), and LPRowSet::value().