|
|
|
SoPlex Doxygen Documentation
|
Sparse vectors.Class SVector provides packed sparse vectors. Such are a sparse vectors, with a storage scheme that keeps all data in one contiguous block of memory. This is best suited for using them for parallel computing on a distributed memory multiprocessor.
More...
#include <svector.h>
|
|
| void | add (int i, Real v) |
| | append one nonzero
|
| |
| void | add (const SVector &sv) |
| | append nonzeros of sv.
|
| |
| void | add (int n, const int i[], const Real v[]) |
| | append n nonzeros.
|
| |
| void | add (int n, const Element e[]) |
| | append n nonzeros.
|
| |
| void | remove (int n, int m) |
| | remove nonzeros n thru m.
|
| |
| void | remove (int n) |
| | remove n 'th nonzero.
|
| |
| void | clear () |
| | remove all indices.
|
| |
| void | sort () |
| | sort nonzeros to increasing indices.
|
| |
|
| int | size () const |
| | number of used indices.
|
| |
| int | max () const |
| | maximal number indices.
|
| |
| int | dim () const |
| | dimension of the vector: maximal index + 1
|
| |
| int | number (int i) const |
| | Number of index i.
|
| |
| Real | operator[] (int i) const |
| | get value to index i.
|
| |
| Element & | element (int n) |
| | get reference to the n 'th nonzero element.
|
| |
| const Element & | element (int n) const |
| | get n 'th nonzero element.
|
| |
| int & | index (int n) |
| | get reference to index of n 'th nonzero.
|
| |
| int | index (int n) const |
| | get index of n 'th nonzero.
|
| |
| Real & | value (int n) |
| | get reference to value of n 'th nonzero.
|
| |
| Real | value (int n) const |
| | get value of n 'th nonzero.
|
| |
|
| Real | maxAbs () const |
| | infinity norm.
|
| |
| Real | minAbs () const |
| | the absolut smalest element in the vector.
|
| |
| Real | length () const |
| | eucledian norm.
|
| |
| Real | length2 () const |
| | squared eucledian norm.
|
| |
| SVector & | operator*= (Real x) |
| | scale with x.
|
| |
| Real | operator* (const Vector &w) const |
| | inner product.
|
| |
|
| SVector & | operator= (const SSVector &sv) |
| | assignment operator from semi sparse vector.
|
| |
| SVector & | operator= (const SVector &sv) |
| | assignment operator.
|
| |
| SVector & | operator= (const Vector &sv) |
| | assignment operator from vector.
|
| |
| | SVector (int n=0, Element *p_mem=0) |
| | default constructor.
|
| |
| | ~SVector () |
| | destructor
|
| |
|
| Element * | mem () const |
| | get pointer to internal memory.
|
| |
| void | set_size (int s) |
| | set the size of the Vector,
|
| |
| void | set_max (int m) |
| | set the maximum number of nonzeros in the Vector.
|
| |
| void | setMem (int n, Element *elmem) |
| | set the memory area where the nonzeros will be stored.
|
| |
|
| bool | isConsistent () const |
| | consistency check.
|
| |
Sparse vectors.
Class SVector provides packed sparse vectors. Such are a sparse vectors, with a storage scheme that keeps all data in one contiguous block of memory. This is best suited for using them for parallel computing on a distributed memory multiprocessor.
SVector does not provide any memory management (this will be done by class DSVector). This means, that the constructor of SVector expects memory where to save the nonzeros. Further, adding nonzeros to an SVector may fail if no more memory is available for saving them (see also DSVector).
When nonzeros are added to an SVector, they are appended to the set of nonzeros, i.e., they recieve numbers size(), size()+1 ... . An SVector can hold atmost max() nonzeros, where max() is given in the constructor. When removing nonzeros, the remaining nonzeros are renumbered. However, only the numbers greater than the number of the first removed nonzero are affected.
The following mathematical operations are provided by class SVector (SVector a, b, c; Real x):
| Operation | Description | |
-= | subtraction | a -= b |
+= | addition | a += b |
* | skalar product | x = a * b |
*= | scaling | a *= x |
| maxAbs() | infinity norm | a.maxAbs() ==  |
| length() | eucledian norm | a.length() ==  |
| length2() | square norm | a.length2() ==  |
Operators += and -= should be used with caution, since no efficient implementation is available. One should think of assigning the left handside vector to a dense Vector first and perform the addition on it. The same applies to the scalar product *.
There are two numberings of the nonzeros of an SVector. First, an SVector is supposed to act like a linear algebra Vector. An index refers to this view of an SVector: operator[]() is provided which returns the value at the given index of the vector, i.e., 0 for all indices which are not in the set of nonzeros. The other view of SVectors is that of a set of nonzeros. The nonzeros are numbered from 0 to size()-1. The methods index(int n) and value(int n) allow to access the index and value of the n 'th nonzero. n is referred to as the number of a nonzero.
- Todo:
- SVector should get a new implementation. The trick to shift the storage by one element and then store the actual and maximum size of the vector in m_elem[-1] is ugly. Also there maybe a lot of memory lost due to padding the Element structure. A better idea seems to be class SVector { int size; int used; int* idx; Real* val; }; which for several reasons could be faster or slower. If SVector is changed, also DSVector and SVSet have to be modified.
Definition at line 94 of file svector.h.
default constructor.
The constructor expects one memory block where to store the nonzero elements. This must be passed to the constructor, where the number of Elements needs that fit into the memory must be given and a pointer to the beginning of the memory block. Once this memory has been passed, it shall not be modified until the SVector is no longer used. Note that when a memory block for n, say, Elements has been passed, only n-1 are available for actually storing nonzeros. The remaining one is used for bookkeeping purposes.
Definition at line 334 of file svector.h.
References SVector::setMem().
| void add |
( |
int |
i, |
|
|
Real |
v |
|
) |
| |
append one nonzero
Definition at line 135 of file svector.h.
References SVector::Element::idx, SVector::m_elem, SVector::max(), SVector::set_size(), SVector::size(), and SVector::Element::val.
Referenced by DSVector::add(), SVector::add(), SVSet::add2(), SPxMainSM::FreeZeroObjVariablePS::execute(), and UnitVector::UnitVector().
| void add |
( |
int |
n, |
|
|
const int |
i[], |
|
|
const Real |
v[] |
|
) |
| |
| void add |
( |
int |
n, |
|
|
const Element |
e[] |
|
) |
| |
| const Element& element |
( |
int |
n | ) |
const |
get reference to index of n 'th nonzero.
Definition at line 248 of file svector.h.
References SVector::Element::idx, SVector::m_elem, and SVector::size().
Referenced by SPxLP::added2Set(), SPxScaler::applyScaling(), Vector::assign(), SSVector::assign(), SPxLP::changeCol(), SPxLP::changeRow(), SPxScaler::computeScalingVecs(), SPxLP::doAddCol(), SPxLP::doAddCols(), SPxLP::doAddRow(), SPxLP::doAddRows(), SPxLP::doRemoveCol(), SPxLP::doRemoveCols(), SPxLP::doRemoveRow(), SPxLP::doRemoveRows(), SPxMainSM::duplicateCols(), SPxMainSM::duplicateRows(), SPxMainSM::DuplicateRowsPS::DuplicateRowsPS(), SPxMainSM::ForceConstraintPS::execute(), SPxMainSM::FreeZeroObjVariablePS::execute(), SPxMainSM::fixColumn(), SPxMainSM::ForceConstraintPS::ForceConstraintPS(), SPxSolver::fpsolve(), SPxMainSM::FreeZeroObjVariablePS::FreeZeroObjVariablePS(), SPxWeightST::generate(), SPxMainSM::handleExtremes(), CLUFactor::initFactorMatrix(), SPxLP::isConsistent(), Vector_exact::multAdd(), SSVector::multAdd(), Vector::operator*(), Vector_exact::operator+=(), Vector::operator+=(), Vector_exact::operator-=(), Vector::operator-=(), soplex::operator<<(), Vector_exact::operator=(), SPxBasis::printMatrixMTX(), SoPlex::qualConstraintViolation(), SPxSolver::qualConstraintViolation(), SPxSolver::qualSlackViolation(), SPxLP::readLPF(), SPxMainSM::removeRowSingleton(), SPxVectorST::setupWeights(), SPxMainSM::simplifyCols(), SPxMainSM::simplifyDual(), SPxMainSM::simplifyRows(), SPxSolver::solve(), and SPxLP::writeMPS().
| bool isConsistent |
( |
| ) |
const |
maximal number indices.
Definition at line 192 of file svector.h.
References SVector::m_elem.
Referenced by SVector::add(), SVSet::create(), SVSet::deleteVec(), SVector::element(), UnitVector::isConsistent(), SVector::isConsistent(), SVSet::isConsistent(), DSVector::makeMem(), SVector::operator=(), SVSet::operator=(), and SVSet::xtend().
| int number |
( |
int |
i | ) |
const |
Number of index i.
- Returns
- The number of the first index
i. If no index i is available in the IdxSet, -1 is returned. Otherwise, index(number(i)) == i holds.
Definition at line 208 of file svector.h.
References SVector::Element::idx, SVector::m_elem, and SVector::size().
Referenced by SPxLP::changeCol(), SPxLP::changeElement(), SPxLP::changeRow(), SPxLP::doRemoveCol(), SPxLP::doRemoveRow(), SPxMainSM::handleExtremes(), SPxLP::isConsistent(), SVector::operator[](), and SPxLP::readLPF().
| Real operator[] |
( |
int |
i | ) |
const |
| void remove |
( |
int |
n, |
|
|
int |
m |
|
) |
| |
remove nonzeros n thru m.
Definition at line 47 of file svector.cpp.
References SVector::m_elem, SVector::set_size(), and SVector::size().
Referenced by SPxLP::changeCol(), SPxLP::changeElement(), SPxLP::changeRow(), SPxLP::doRemoveCol(), SPxLP::doRemoveCols(), SPxLP::doRemoveRow(), SPxLP::doRemoveRows(), SPxMainSM::handleExtremes(), and SPxLP::readLPF().
set the size of the Vector,
Definition at line 352 of file svector.h.
References SVector::Element::idx, and SVector::m_elem.
Referenced by SVector::add(), SVector::clear(), SVSet::deleteVec(), SPxLP::doAddCols(), SPxLP::doAddRows(), SVSet::memPack(), SVector::operator=(), SVSet::operator=(), SVector::remove(), DSVector::setMax(), SVector::setMem(), and SVSet::xtend().
| void setMem |
( |
int |
n, |
|
|
Element * |
elmem |
|
) |
| |
set the memory area where the nonzeros will be stored.
Definition at line 364 of file svector.h.
References SVector::m_elem, SVector::set_max(), SVector::set_size(), and SVector::Element::val.
Referenced by DSVector::allocMem(), SVSet::create(), SVSet::deleteVec(), SVSet::memPack(), SVSet::operator=(), DSVector::setMax(), SVector::SVector(), and SVSet::xtend().
number of used indices.
Definition at line 183 of file svector.h.
References SVector::Element::idx, and SVector::m_elem.
Referenced by DSVector::add(), SVector::add(), SVSet::add(), SVSet::add2(), SPxLP::added2Set(), SPxScaler::applyScaling(), Vector::assign(), SSVector::assign(), SSVector::assign2product1(), SSVector::assign2productAndSetup(), SSVector::assign2productFull(), SSVector::assign2productShort(), SPxBasis::change(), SPxLP::changeCol(), SPxLP::changeRow(), SPxScaler::computeScalingVecs(), SVSet::create(), SVSet::deleteVec(), SVector::dim(), SPxLP::doAddCol(), SPxLP::doAddCols(), SPxLP::doAddRow(), SPxLP::doAddRows(), SPxLP::doRemoveCol(), SPxLP::doRemoveCols(), SPxLP::doRemoveRow(), SPxLP::doRemoveRows(), DSVector::DSVector(), SPxMainSM::duplicateCols(), SPxMainSM::duplicateRows(), SPxMainSM::DuplicateRowsPS::DuplicateRowsPS(), SVector::element(), SPxMainSM::ForceConstraintPS::execute(), SPxMainSM::FreeZeroObjVariablePS::execute(), SPxMainSM::fixColumn(), SPxMainSM::ForceConstraintPS::ForceConstraintPS(), SPxSolver::fpsolve(), SPxMainSM::FreeZeroObjVariablePS::FreeZeroObjVariablePS(), SPxWeightST::generate(), SPxMainSM::handleExtremes(), SVector::index(), CLUFactor::initFactorMatrix(), UnitVector::isConsistent(), SVector::isConsistent(), SPxLP::isConsistent(), SVector::length2(), SLUFactor::load(), DSVector::makeMem(), SVector::maxAbs(), SPxScaler::maxColRatio(), SPxScaler::maxRowRatio(), SVSet::memPack(), SVector::minAbs(), Vector_exact::multAdd(), Vector::multAdd(), SSVector::multAdd(), SPxLP::nNzos(), SVector::number(), Vector::operator*(), SVector::operator*(), SVector::operator*=(), Vector_exact::operator+=(), Vector::operator+=(), Vector_exact::operator-=(), Vector::operator-=(), soplex::operator<<(), Vector_exact::operator=(), DSVector::operator=(), SVector::operator=(), SVSet::operator=(), SPxBasis::printMatrixMTX(), SoPlex::qualConstraintViolation(), SPxSolver::qualConstraintViolation(), SPxSolver::qualSlackViolation(), SPxLP::readLPF(), SVector::remove(), SPxMainSM::removeEmpty(), SPxMainSM::removeRowSingleton(), DSVector::setMax(), SPxVectorST::setupWeights(), SPxWeightST::setupWeights(), SPxMainSM::simplifyCols(), SPxMainSM::simplifyDual(), SPxMainSM::simplifyRows(), SVector::sort(), SVector::value(), SPxLP::writeMPS(), and SVSet::xtend().
get reference to value of n 'th nonzero.
Definition at line 262 of file svector.h.
References SVector::m_elem, SVector::size(), and SVector::Element::val.
Referenced by SPxLP::added2Set(), SPxScaler::applyScaling(), Vector::assign(), SSVector::assign(), SPxLP::changeElement(), SPxScaler::computeScalingVecs(), SPxLP::doAddCol(), SPxLP::doAddCols(), SPxLP::doAddRow(), SPxLP::doAddRows(), SPxMainSM::duplicateCols(), SPxMainSM::duplicateRows(), SPxMainSM::ForceConstraintPS::execute(), SPxMainSM::FreeZeroObjVariablePS::execute(), SPxMainSM::fixColumn(), SPxSolver::fpsolve(), SPxMainSM::FreeZeroObjVariablePS::FreeZeroObjVariablePS(), SPxWeightST::generate(), SPxMainSM::handleExtremes(), CLUFactor::initFactorMatrix(), SPxLP::isConsistent(), SLUFactor::load(), SPxScaler::maxColRatio(), SPxScaler::maxRowRatio(), Vector_exact::multAdd(), SSVector::multAdd(), Vector::operator*(), Vector_exact::operator+=(), Vector::operator+=(), Vector_exact::operator-=(), Vector::operator-=(), soplex::operator<<(), Vector_exact::operator=(), SPxBasis::printMatrixMTX(), SoPlex::qualConstraintViolation(), SPxSolver::qualConstraintViolation(), SPxSolver::qualSlackViolation(), SPxLP::readLPF(), SPxMainSM::removeRowSingleton(), SPxVectorST::setupWeights(), SPxMainSM::simplifyCols(), SPxMainSM::simplifyDual(), SPxMainSM::simplifyRows(), and SPxLP::writeMPS().
| Real value |
( |
int |
n | ) |
const |
| std::ostream& operator<< |
( |
std::ostream & |
os, |
|
|
const SVector & |
v |
|
) |
| |
|
friend |
Array of Elements.
An SVector keeps its data in an array of Elements. The size and maximum number of elements allowed is stored in the -1st Element in its members idx and val, respectively.
Definition at line 126 of file svector.h.
Referenced by SVector::add(), SVector::dim(), SVector::element(), SVector::index(), SVector::isConsistent(), SVector::length2(), SVector::max(), SVector::maxAbs(), SVector::mem(), SVector::minAbs(), Vector::multAdd(), SVector::number(), SVector::operator*(), SVector::operator*=(), SVector::operator=(), SVector::operator[](), SVector::remove(), SVector::set_max(), SVector::set_size(), SVector::setMem(), SVector::size(), SVector::sort(), and SVector::value().
|
