Regina Calculation Engine
|
A vector of objects with fast, space-efficient reverse lookup of array indices. More...
#include <utilities/nmarkedvector.h>
Public Member Functions | |
NMarkedVector () | |
Constructs a new empty vector. More... | |
const std::vector< T * > & | operator() () const |
Casts this vector to a const std::vector, thus providing access to the entire const functionality of std::vector. More... | |
void | push_back (T *item) |
Pushes the given item onto the end of this vector. More... | |
std::vector< T * >::iterator | erase (typename std::vector< T * >::iterator pos) |
Erases the item at the given position in this vector. More... | |
std::vector< T * >::iterator | erase (typename std::vector< T * >::iterator first, typename std::vector< T * >::iterator last) |
Erases all items in the given range in this vector. More... | |
void | swap (NMarkedVector< T > &other) |
Swaps the contents of this and the given vector. More... | |
A vector of objects with fast, space-efficient reverse lookup of array indices.
This class derives from std::vector, and so provides fast forward lookups from array indices to objects. What NMarkedVector provides in addition to this is fast reverse lookups from objects back to array indices.
The way this class is able to provide fast constant-time reverse lookups without consuming a great deal of space is by storing array indices inside the objects themselves. As a result, there are two significant constraints:
int
or predefined types such as std::string
.Using this class is fairly simple. The class provides a restricted subset of the std::vector functionality, including iterator, const_iterator, begin, end, size, empty, front, back, operator [], and clear (this subset may grow over time if required). In addition, any const method of std::vector can be accessed through an explicit cast to const std::vector&. To perform a reverse lookup (find the index at which an array is stored), simply call the object's inherited method NMarkedElement::markedIndex().
Note that, like its parent std::vector, this class performs no memory management. In particular, elements (which are pointers to real objects) are not destroyed when they are removed from a vector or when the vector is eventually destroyed.
|
inline |
Constructs a new empty vector.
|
inline |
Erases the item at the given position in this vector.
The item will not be destroyed, and the (now irrelevant) index stored inside it will not be modified.
pos | an iterator pointing to the element to erase. |
|
inline |
Erases all items in the given range in this vector.
The items will not be destroyed, and the (now irrelevant) indices stored inside them will not be modified.
first | an iterator pointing to the first element to erase. |
last | an iterator pointing just beyond the last element to erase. |
|
inline |
Casts this vector to a const std::vector, thus providing access to the entire const functionality of std::vector.
|
inline |
Pushes the given item onto the end of this vector.
The array index stored inside item will be modified accordingly.
The caller retains reponsibility for the ownership of item. This class will make no attempt to deallocate item when it is removed or when this vector is eventually destroyed.
item | the item to add to this vector. |
|
inline |
Swaps the contents of this and the given vector.
other | the vector whose contents are to be swapped with this. |