SoPlex
Sequential object-oriented simPlex
Sequential object-oriented simPlex
Set of indices. More...
#include <idxset.h>
Public Member Functions | |
Construction / destruction | |
| IdxSet (int n, int imem[], int l=0) | |
| constructor. More... | |
| IdxSet () | |
| default constructor. More... | |
| virtual | ~IdxSet () |
| destructor. More... | |
| IdxSet & | operator= (const IdxSet &set) |
| assignment operator. More... | |
| IdxSet (const IdxSet &) | |
| copy constructor. More... | |
Access | |
| int | index (int n) const |
access n 'th index. More... | |
| int | size () const |
| returns the number of used indices. More... | |
| int | max () const |
| returns the maximal number of indices which can be stored in IdxSet. More... | |
| int | dim () const |
| returns the maximal index. More... | |
| int | pos (int i) const |
returns the position of index i. More... | |
Modification | |
| void | add (int n) |
appends n uninitialized indices. More... | |
| void | add (const IdxSet &set) |
appends all indices of set. More... | |
| void | add (int n, const int i[]) |
appends n indices in i. More... | |
| void | addIdx (int i) |
appends index i. More... | |
| void | remove (int n, int m) |
removes indices at position numbers n through m. More... | |
| void | remove (int n) |
removes n 'th index. More... | |
| void | clear () |
| removes all indices. More... | |
Consistency check | |
| bool | isConsistent () const |
| consistency check. More... | |
Protected Attributes | |
Data | |
| int | num |
| number of used indices More... | |
| int | len |
| length of array idx More... | |
| int * | idx |
| array of indices More... | |
| bool | freeArray |
| true iff idx should be freed inside of this object More... | |
Set of indices.
Class IdxSet provides a set of indices. At construction it must be given an array of int where to store the indice and its length. The array will from then on be managed by the IdxSet.
Indices are implicitely numbered from 0 thru size()-1. They can be accessed (and altered) via method index() with the desired index number as argument. Range checking is performed in the debug version.
Indices may be added or removed from the set, by calling add() or remove() methods, respectively. However, no IdxSet can hold more then max() indices, i.e. the number given at the constructor.
When removing indices, the remaining ones are renumbered. However, all indices before the first removed index keep their number unchanged.
The internal structure of an IdxSet consists of an array idx storing the indices, its length len, and the actually used number of indices num. The class IdxSet doesn't allocate memory for the idx array. Instead, the user has to provide an adequate buffer to the constructor.
An IdxSet cannot be extended to fit more than max() elements. If necessary, the user must explicitely provide the IdxSet with a suitable memory. Alternatively, one can use DIdxSets which provide the required memory managemant.
| IdxSet | ( | int | n, |
| int | imem[], | ||
| int | l = 0 |
||
| ) |
constructor.
The constructur receives the index memory imem to use for saving its indices. This must be large enough to fit n indices. l can be given to construct an IdxSet initialized to the l first indices in imem.
Definition at line 89 of file idxset.h.
References IdxSet::isConsistent().
| IdxSet | ( | ) |
default constructor.
The default constructor creates an index set with an empty index space. You cannot store any indices in an IdxSet created with the default constructor.
Definition at line 100 of file idxset.h.
References IdxSet::isConsistent().
|
virtual |
destructor.
Definition at line 107 of file idxset.h.
References IdxSet::freeArray, IdxSet::idx, and soplex::spx_free().
copy constructor.
Definition at line 110 of file idxset.cpp.
References IdxSet::freeArray, IdxSet::idx, IdxSet::isConsistent(), IdxSet::len, IdxSet::max(), IdxSet::num, IdxSet::size(), and soplex::spx_alloc().
| void add | ( | const IdxSet & | set | ) |
appends all indices of set.
Definition at line 165 of file idxset.h.
References IdxSet::add(), IdxSet::idx, and IdxSet::size().
| void add | ( | int | n | ) |
appends n uninitialized indices.
Definition at line 158 of file idxset.h.
References IdxSet::max(), IdxSet::num, and IdxSet::size().
Referenced by DIdxSet::add(), IdxSet::add(), and SSVectorBase< R >::setValue().
| void add | ( | int | n, |
| const int | i[] | ||
| ) |
appends n indices in i.
Definition at line 50 of file idxset.cpp.
References IdxSet::add(), IdxSet::idx, IdxSet::max(), and IdxSet::size().
| void addIdx | ( | int | i | ) |
appends index i.
Definition at line 174 of file idxset.h.
References IdxSet::idx, IdxSet::max(), IdxSet::num, and IdxSet::size().
Referenced by SSVectorBase< R >::add(), and DIdxSet::addIdx().
| void clear | ( | ) |
removes all indices.
Definition at line 193 of file idxset.h.
References IdxSet::num.
Referenced by SSVectorBase< R >::clear(), and SSVectorBase< R >::setup().
| int dim | ( | ) | const |
returns the maximal index.
Definition at line 30 of file idxset.cpp.
References IdxSet::idx, and IdxSet::size().
Referenced by SSVectorBase< R >::isConsistent().
| int index | ( | int | n | ) | const |
access n 'th index.
Definition at line 127 of file idxset.h.
References IdxSet::idx, and IdxSet::size().
Referenced by SSVectorBase< R >::index(), and IdxSet::isConsistent().
| bool isConsistent | ( | ) | const |
consistency check.
Definition at line 126 of file idxset.cpp.
References IdxSet::idx, IdxSet::index(), IdxSet::len, IdxSet::size(), and SPX_MSG_INCONSISTENT.
Referenced by IdxSet::IdxSet(), SSVectorBase< R >::isConsistent(), and IdxSet::operator=().
| int max | ( | ) | const |
returns the maximal number of indices which can be stored in IdxSet.
Definition at line 138 of file idxset.h.
References IdxSet::len.
Referenced by DIdxSet::add(), IdxSet::add(), DIdxSet::addIdx(), IdxSet::addIdx(), IdxSet::IdxSet(), SSVectorBase< R >::isConsistent(), IdxSet::operator=(), SSVectorBase< R >::operator=(), DIdxSet::setMax(), SSVectorBase< R >::setSize(), and SSVectorBase< R >::setup_and_assign().
assignment operator.
The assignment operator copies all nonzeros of the right handside IdxSet to the left one. This implies, that the latter must have enough index memory.
Definition at line 80 of file idxset.cpp.
References IdxSet::freeArray, IdxSet::idx, IdxSet::isConsistent(), IdxSet::len, IdxSet::max(), IdxSet::num, IdxSet::size(), soplex::spx_alloc(), and soplex::spx_free().
Referenced by DIdxSet::DIdxSet(), DIdxSet::operator=(), SSVectorBase< R >::operator=(), SSVectorBase< R >::setup_and_assign(), and SSVectorBase< R >::SSVectorBase().
| int pos | ( | int | i | ) | const |
returns the position of index i.
Finds the position of the first index i in the IdxSet. If no index i is available in the IdxSet, -1 is returned. Otherwise, index(pos(i)) == i holds.
Definition at line 41 of file idxset.cpp.
References IdxSet::idx, and IdxSet::size().
Referenced by SSVectorBase< R >::pos().
| void remove | ( | int | n | ) |
removes n 'th index.
Definition at line 183 of file idxset.h.
References IdxSet::idx, IdxSet::num, and IdxSet::size().
| void remove | ( | int | n, |
| int | m | ||
| ) |
removes indices at position numbers n through m.
Definition at line 60 of file idxset.cpp.
References IdxSet::idx, IdxSet::num, and IdxSet::size().
Referenced by SSVectorBase< R >::clearIdx(), SSVectorBase< R >::clearNum(), and SSVectorBase< R >::reDim().
| int size | ( | ) | const |
returns the number of used indices.
Definition at line 133 of file idxset.h.
References IdxSet::num.
Referenced by DIdxSet::add(), IdxSet::add(), DIdxSet::addIdx(), IdxSet::addIdx(), DIdxSet::DIdxSet(), IdxSet::dim(), IdxSet::IdxSet(), IdxSet::index(), IdxSet::isConsistent(), IdxSet::operator=(), DIdxSet::operator=(), IdxSet::pos(), SSVectorBase< R >::reDim(), IdxSet::remove(), SSVectorBase< R >::setMax(), DIdxSet::setMax(), and SSVectorBase< R >::size().
|
protected |
true iff idx should be freed inside of this object
Definition at line 75 of file idxset.h.
Referenced by IdxSet::IdxSet(), IdxSet::operator=(), and IdxSet::~IdxSet().
|
protected |
array of indices
Definition at line 74 of file idxset.h.
Referenced by IdxSet::add(), IdxSet::addIdx(), SSVectorBase< R >::altIndexMem(), SSVectorBase< R >::assign2product1(), SSVectorBase< R >::assign2productAndSetup(), SSVectorBase< R >::assign2productFull(), SSVectorBase< R >::assign2productShort(), SSVectorBase< R >::clear(), DIdxSet::DIdxSet(), IdxSet::dim(), IdxSet::IdxSet(), IdxSet::index(), SSVectorBase< R >::indexMem(), IdxSet::isConsistent(), SSVectorBase< R >::length2(), SSVectorBase< R >::maxAbs(), IdxSet::operator=(), SSVectorBase< R >::operator=(), IdxSet::pos(), IdxSet::remove(), SSVectorBase< R >::setMax(), DIdxSet::setMax(), SSVectorBase< R >::setup(), SSVectorBase< R >::setup_and_assign(), SSVectorBase< R >::SSVectorBase(), SSVectorBase< R >::value(), DIdxSet::~DIdxSet(), IdxSet::~IdxSet(), and SSVectorBase< R >::~SSVectorBase().
|
protected |
length of array idx
Definition at line 73 of file idxset.h.
Referenced by DIdxSet::DIdxSet(), IdxSet::IdxSet(), IdxSet::isConsistent(), IdxSet::max(), IdxSet::operator=(), SSVectorBase< R >::setMax(), DIdxSet::setMax(), and SSVectorBase< R >::SSVectorBase().
|
protected |
number of used indices
Definition at line 72 of file idxset.h.
Referenced by IdxSet::add(), IdxSet::addIdx(), SSVectorBase< R >::assign2productAndSetup(), IdxSet::clear(), SSVectorBase< R >::clear(), IdxSet::IdxSet(), SSVectorBase< R >::length2(), SSVectorBase< R >::maxAbs(), IdxSet::operator=(), SSVectorBase< R >::operator=(), IdxSet::remove(), SSVectorBase< R >::setSize(), SSVectorBase< R >::setup(), SSVectorBase< R >::setup_and_assign(), and IdxSet::size().