OpenMS
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Friends | List of all members
ConstRefVector< ContainerT > Class Template Reference
Datastructures

This vector holds pointer to the elements of another container. More...

#include <OpenMS/DATASTRUCTURES/ConstRefVector.h>

Collaboration diagram for ConstRefVector< ContainerT >:
[legend]

Classes

class  ConstRefVectorConstIterator
 ConstIterator for the ConstRefVector. More...
 
class  ConstRefVectorIterator
 Mutable iterator for the ConstRefVector. More...
 

Public Types

typedef ContainerT ContainerType
 Type definitions.
 
typedef ContainerType::value_type ValueType
 
typedef ConstRefVectorIterator< const ValueType > Iterator
 
typedef ConstRefVectorConstIterator< const ValueType > ConstIterator
 
typedef std::reverse_iterator< Iterator > ReverseIterator
 
typedef std::reverse_iterator< ConstIterator > ConstReverseIterator
 
typedef ValueType value_type
 STL-compliance type definitions.
 
typedef ContainerType::size_type size_type
 
typedef ContainerType::difference_type difference_type
 
typedef ContainerType::reference reference
 
typedef ContainerType::const_reference const_reference
 
typedef ContainerType::pointer pointer
 
typedef Iterator iterator
 
typedef ConstIterator const_iterator
 
typedef ReverseIterator reverse_iterator
 
typedef ConstReverseIterator const_reverse_iterator
 

Public Member Functions

void push_back (const ValueType &x)
 See std::vector documentation.
 
void pop_back ()
 See std::vector documentation.
 
size_type size () const
 See std::vector documentation.
 
size_type capacity () const
 See std::vector documentation.
 
void reserve (size_type n)
 See std::vector documentation.
 
size_type max_size () const
 See std::vector documentation.
 
Iterator begin ()
 See std::vector documentation.
 
Iterator end ()
 See std::vector documentation.
 
ConstIterator begin () const
 See std::vector documentation.
 
ConstIterator end () const
 See std::vector documentation.
 
ReverseIterator rbegin ()
 See std::vector documentation.
 
ReverseIterator rend ()
 See std::vector documentation.
 
ConstReverseIterator rbegin () const
 See std::vector documentation.
 
ConstReverseIterator rend () const
 See std::vector documentation.
 
void resize (size_type new_size)
 See std::vector documentation.
 
void resize (size_type new_size, const ValueType &t)
 See std::vector documentation.
 
const_reference front () const
 See std::vector documentation.
 
const_reference back () const
 See std::vector documentation.
 
void clear ()
 See std::vector documentation.
 
bool empty () const
 See std::vector documentation.
 
const_reference operator[] (size_type n) const
 See std::vector documentation.
 
bool operator== (const ConstRefVector &array) const
 See std::vector documentation.
 
bool operator!= (const ConstRefVector &array) const
 See std::vector documentation.
 
bool operator< (const ConstRefVector &array) const
 Comparison of container sizes.
 
bool operator> (const ConstRefVector &array) const
 Comparison of container sizes.
 
bool operator<= (const ConstRefVector &array) const
 Comparison of container sizes.
 
bool operator>= (const ConstRefVector &array) const
 Comparison of container sizes.
 
void swap (ConstRefVector &array)
 See std::vector documentation.
 
Iterator insert (Iterator pos, const ValueType &element)
 See std::vector documentation.
 
void insert (Iterator pos, size_type n, const ValueType &element)
 See std::vector documentation.
 
template<class InputIterator >
void insert (Iterator pos, InputIterator f, InputIterator l)
 See std::vector documentation.
 
Iterator erase (Iterator pos)
 See std::vector documentation.
 
Iterator erase (Iterator first, Iterator last)
 See std::vector documentation.
 
Constructors and Destructor
 ConstRefVector ()
 See std::vector documentation.
 
 ConstRefVector (size_type n)
 See std::vector documentation.
 
 ConstRefVector (size_type n, const ValueType &element)
 See std::vector documentation.
 
 ConstRefVector (const ConstRefVector &p)
 See std::vector documentation.
 
template<class InputIterator >
 ConstRefVector (InputIterator f, InputIterator l)
 See std::vector documentation.
 
 ConstRefVector (ContainerType &p)
 See std::vector documentation.
 
 ~ConstRefVector ()
 See std::vector documentation.
 
ConstRefVector & operator= (const ConstRefVector &rhs)
 See std::vector documentation.
 
template<class InputIterator >
void assign (InputIterator f, InputIterator l)
 See std::vector documentation.
 
void assign (size_type n, const ValueType &x)
 See std::vector documentation.
 
void sortByIntensity (bool reverse=false)
 Sorting.
 
void sortByPosition ()
 Lexicographically sorts the elements by their position.
 

Friends

void swap (ConstRefVector &a1, ConstRefVector &a2)
 See std::vector documentation.
 

Generic sorting function templates.

Any element comparator can be given as template argument. You can also give the comparator as an argument to the function template (this is useful if the comparator is not default constructed, but keep in mind that STL copies comparators a lot).

Thus your can e.g. write elements.sortByComparator < DFeature<1>::IntensityLess > (), if elements have type ConstRefVector < 1, DFeature <1> >.

std::vector< const ValueType * > vector_
 the internal vector of ValueType pointers
 
size_type capacity_
 the current capacity
 
const ContainerType * base_container_ptr_
 Pointer to the base container.
 
template<typename ComparatorType >
void sortByComparator (ComparatorType const &comparator=ComparatorType())
 

Detailed Description

template<typename ContainerT>
class OpenMS::ConstRefVector< ContainerT >

This vector holds pointer to the elements of another container.

If you for example want to sort the elements of a constant container, you would have to copy the whole container.
To avoid copy actions this class only holds pointer to the constant elements of a container.
You can insert new elements, but it is not possible to change existing ones.

The following code demonstrates the use of this class:

FeatureMap<> map;
map.resize(10); //...fill map with data
//Create pointer vector to the map
ConstRefVector<FeatureMap<> > ref_vector(map);
//Sort the pointer vector without changing the original data
ref_vector.sortByIntensity();
OpenMS::ConstRefVector
This vector holds pointer to the elements of another container.
Definition ConstRefVector.h:44
OpenMS::ExposedVector::resize
void resize(const size_t new_size)
Definition ExposedVector.h:132
OpenMS::FeatureMap
A container for features.
Definition FeatureMap.h:82
Improvement:
Check if we can omit the iterator template arguments (Clemens)

Member Typedef Documentation

◆ const_iterator

template<typename ContainerT >
typedef ConstIterator const_iterator

◆ const_reference

template<typename ContainerT >
typedef ContainerType::const_reference const_reference

◆ const_reverse_iterator

template<typename ContainerT >
typedef ConstReverseIterator const_reverse_iterator

◆ ConstIterator

template<typename ContainerT >
typedef ConstRefVectorConstIterator<const ValueType> ConstIterator

◆ ConstReverseIterator

template<typename ContainerT >
typedef std::reverse_iterator<ConstIterator> ConstReverseIterator

◆ ContainerType

template<typename ContainerT >
typedef ContainerT ContainerType

Type definitions.

Wrapped container type

◆ difference_type

template<typename ContainerT >
typedef ContainerType::difference_type difference_type

◆ Iterator

template<typename ContainerT >
typedef ConstRefVectorIterator<const ValueType> Iterator

◆ iterator

template<typename ContainerT >
typedef Iterator iterator

◆ pointer

template<typename ContainerT >
typedef ContainerType::pointer pointer

◆ reference

template<typename ContainerT >
typedef ContainerType::reference reference

◆ reverse_iterator

template<typename ContainerT >
typedef ReverseIterator reverse_iterator

◆ ReverseIterator

template<typename ContainerT >
typedef std::reverse_iterator<Iterator> ReverseIterator

◆ size_type

template<typename ContainerT >
typedef ContainerType::size_type size_type

◆ value_type

template<typename ContainerT >
typedef ValueType value_type

STL-compliance type definitions.

◆ ValueType

template<typename ContainerT >
typedef ContainerType::value_type ValueType

Constructor & Destructor Documentation

◆ ConstRefVector() [1/6]

template<typename ContainerT >
ConstRefVector ( )
inline

See std::vector documentation.

◆ ConstRefVector() [2/6]

template<typename ContainerT >
ConstRefVector ( size_type  n)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ ConstRefVector() [3/6]

template<typename ContainerT >
ConstRefVector ( size_type  n,
const ValueType &  element 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ ConstRefVector() [4/6]

template<typename ContainerT >
ConstRefVector ( const ConstRefVector< ContainerT > &  p)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::begin(), ConstRefVector< ContainerT >::end(), and ConstRefVector< ContainerT >::vector_.

◆ ConstRefVector() [5/6]

template<typename ContainerT >
template<class InputIterator >
ConstRefVector ( InputIterator  f,
InputIterator  l 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ ConstRefVector() [6/6]

template<typename ContainerT >
ConstRefVector ( ContainerType &  p)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ ~ConstRefVector()

template<typename ContainerT >
~ConstRefVector ( )
inline

See std::vector documentation.

Member Function Documentation

◆ assign() [1/2]

template<typename ContainerT >
template<class InputIterator >
void assign ( InputIterator  f,
InputIterator  l 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::clear(), ConstRefVector< ContainerT >::end(), and ConstRefVector< ContainerT >::insert().

◆ assign() [2/2]

template<typename ContainerT >
void assign ( size_type  n,
const ValueType &  x 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::clear(), ConstRefVector< ContainerT >::end(), and ConstRefVector< ContainerT >::insert().

◆ back()

template<typename ContainerT >
const_reference back ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::end().

◆ begin() [1/2]

template<typename ContainerT >
Iterator begin ( )
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::front(), ConstRefVector< ContainerT >::operator=(), ConstRefVector< ContainerT >::rend(), and ConstRefVector< ContainerT >::rend().

◆ begin() [2/2]

template<typename ContainerT >
ConstIterator begin ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ capacity()

template<typename ContainerT >
size_type capacity ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::capacity_, and ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::reserve().

◆ clear()

template<typename ContainerT >
void clear ( )
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::assign(), ConstRefVector< ContainerT >::assign(), and ConstRefVector< ContainerT >::operator=().

◆ empty()

template<typename ContainerT >
bool empty ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ end() [1/2]

template<typename ContainerT >
Iterator end ( )
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::assign(), ConstRefVector< ContainerT >::assign(), ConstRefVector< ContainerT >::back(), ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::operator=(), ConstRefVector< ContainerT >::rbegin(), and ConstRefVector< ContainerT >::rbegin().

◆ end() [2/2]

template<typename ContainerT >
ConstIterator end ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ erase() [1/2]

template<typename ContainerT >
Iterator erase ( Iterator  first,
Iterator  last 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::ConstRefVectorConstIterator< ValueT >::position_, and ConstRefVector< ContainerT >::vector_.

◆ erase() [2/2]

template<typename ContainerT >
Iterator erase ( Iterator  pos)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::ConstRefVectorConstIterator< ValueT >::position_, and ConstRefVector< ContainerT >::vector_.

◆ front()

template<typename ContainerT >
const_reference front ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::begin().

◆ insert() [1/3]

template<typename ContainerT >
Iterator insert ( Iterator  pos,
const ValueType &  element 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::ConstRefVectorConstIterator< ValueT >::position_, and ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::assign(), and ConstRefVector< ContainerT >::assign().

◆ insert() [2/3]

template<typename ContainerT >
template<class InputIterator >
void insert ( Iterator  pos,
InputIterator  f,
InputIterator  l 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::ConstRefVectorConstIterator< ValueT >::position_, and ConstRefVector< ContainerT >::vector_.

◆ insert() [3/3]

template<typename ContainerT >
void insert ( Iterator  pos,
size_type  n,
const ValueType &  element 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::ConstRefVectorConstIterator< ValueT >::position_, and ConstRefVector< ContainerT >::vector_.

◆ max_size()

template<typename ContainerT >
size_type max_size ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ operator!=()

template<typename ContainerT >
bool operator!= ( const ConstRefVector< ContainerT > &  array) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::operator==().

◆ operator<()

template<typename ContainerT >
bool operator< ( const ConstRefVector< ContainerT > &  array) const
inline

Comparison of container sizes.

References ConstRefVector< ContainerT >::size().

Referenced by ConstRefVector< ContainerT >::operator<=().

◆ operator<=()

template<typename ContainerT >
bool operator<= ( const ConstRefVector< ContainerT > &  array) const
inline

Comparison of container sizes.

References ConstRefVector< ContainerT >::operator<(), and ConstRefVector< ContainerT >::operator==().

◆ operator=()

template<typename ContainerT >
ConstRefVector & operator= ( const ConstRefVector< ContainerT > &  rhs)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::base_container_ptr_, ConstRefVector< ContainerT >::begin(), ConstRefVector< ContainerT >::clear(), ConstRefVector< ContainerT >::end(), ConstRefVector< ContainerT >::reserve(), ConstRefVector< ContainerT >::size(), and ConstRefVector< ContainerT >::vector_.

◆ operator==()

template<typename ContainerT >
bool operator== ( const ConstRefVector< ContainerT > &  array) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::base_container_ptr_, ConstRefVector< ContainerT >::size(), and ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::operator!=(), ConstRefVector< ContainerT >::operator<=(), and ConstRefVector< ContainerT >::operator>=().

◆ operator>()

template<typename ContainerT >
bool operator> ( const ConstRefVector< ContainerT > &  array) const
inline

Comparison of container sizes.

References ConstRefVector< ContainerT >::size().

Referenced by ConstRefVector< ContainerT >::operator>=().

◆ operator>=()

template<typename ContainerT >
bool operator>= ( const ConstRefVector< ContainerT > &  array) const
inline

Comparison of container sizes.

References ConstRefVector< ContainerT >::operator==(), and ConstRefVector< ContainerT >::operator>().

◆ operator[]()

template<typename ContainerT >
const_reference operator[] ( size_type  n) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ pop_back()

template<typename ContainerT >
void pop_back ( )
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ push_back()

template<typename ContainerT >
void push_back ( const ValueType &  x)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

◆ rbegin() [1/2]

template<typename ContainerT >
ReverseIterator rbegin ( )
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::end().

◆ rbegin() [2/2]

template<typename ContainerT >
ConstReverseIterator rbegin ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::end().

◆ rend() [1/2]

template<typename ContainerT >
ReverseIterator rend ( )
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::begin().

◆ rend() [2/2]

template<typename ContainerT >
ConstReverseIterator rend ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::begin().

◆ reserve()

template<typename ContainerT >
void reserve ( size_type  n)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::capacity(), ConstRefVector< ContainerT >::capacity_, and ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::operator=().

◆ resize() [1/2]

template<typename ContainerT >
void resize ( size_type  new_size)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::capacity_, and ConstRefVector< ContainerT >::vector_.

◆ resize() [2/2]

template<typename ContainerT >
void resize ( size_type  new_size,
const ValueType &  t 
)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::capacity_, and ConstRefVector< ContainerT >::vector_.

◆ size()

template<typename ContainerT >
size_type size ( ) const
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

Referenced by ConstRefVector< ContainerT >::operator<(), ConstRefVector< ContainerT >::operator=(), ConstRefVector< ContainerT >::operator==(), and ConstRefVector< ContainerT >::operator>().

◆ sortByComparator()

template<typename ContainerT >
template<typename ComparatorType >
void sortByComparator ( ComparatorType const &  comparator = ComparatorType())
inline

References ConstRefVector< ContainerT >::vector_.

◆ sortByIntensity()

template<typename ContainerT >
void sortByIntensity ( bool  reverse = false)
inline

Sorting.

These simplified sorting methods are supported for convenience.

Note
To use these methods, the ValueType must provide an interface similar to Peak1D or Peak2D. Sorts the elements by intensity

References ConstRefVector< ContainerT >::vector_.

◆ sortByPosition()

template<typename ContainerT >
void sortByPosition ( )
inline

Lexicographically sorts the elements by their position.

References ConstRefVector< ContainerT >::vector_.

◆ swap()

template<typename ContainerT >
void swap ( ConstRefVector< ContainerT > &  array)
inline

See std::vector documentation.

References ConstRefVector< ContainerT >::vector_.

Friends And Related Symbol Documentation

◆ swap

template<typename ContainerT >
void swap ( ConstRefVector< ContainerT > &  a1,
ConstRefVector< ContainerT > &  a2 
)
friend

See std::vector documentation.

Member Data Documentation

◆ base_container_ptr_

template<typename ContainerT >
const ContainerType* base_container_ptr_
protected

Pointer to the base container.

Referenced by ConstRefVector< ContainerT >::operator=(), and ConstRefVector< ContainerT >::operator==().

◆ capacity_

template<typename ContainerT >
size_type capacity_
protected

the current capacity

Referenced by ConstRefVector< ContainerT >::capacity(), ConstRefVector< ContainerT >::reserve(), ConstRefVector< ContainerT >::resize(), and ConstRefVector< ContainerT >::resize().

◆ vector_

template<typename ContainerT >
std::vector<const ValueType*> vector_
protected

the internal vector of ValueType pointers

Referenced by ConstRefVector< ContainerT >::begin(), ConstRefVector< ContainerT >::begin(), ConstRefVector< ContainerT >::capacity(), ConstRefVector< ContainerT >::clear(), ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::ConstRefVector(), ConstRefVector< ContainerT >::empty(), ConstRefVector< ContainerT >::end(), ConstRefVector< ContainerT >::end(), ConstRefVector< ContainerT >::erase(), ConstRefVector< ContainerT >::erase(), ConstRefVector< ContainerT >::insert(), ConstRefVector< ContainerT >::insert(), ConstRefVector< ContainerT >::insert(), ConstRefVector< ContainerT >::max_size(), ConstRefVector< ContainerT >::operator=(), ConstRefVector< ContainerT >::operator==(), ConstRefVector< ContainerT >::operator[](), ConstRefVector< ContainerT >::pop_back(), ConstRefVector< ContainerT >::push_back(), ConstRefVector< ContainerT >::reserve(), ConstRefVector< ContainerT >::resize(), ConstRefVector< ContainerT >::resize(), ConstRefVector< ContainerT >::size(), ConstRefVector< ContainerT >::sortByComparator(), ConstRefVector< ContainerT >::sortByIntensity(), ConstRefVector< ContainerT >::sortByPosition(), and ConstRefVector< ContainerT >::swap().