shark::IndexedIterator< Iterator > Class Template Reference

creates an Indexed Iterator, an Iterator which also carries index information using index() More...

#include <shark/Core/utility/Iterators.h>

+ Inheritance diagram for shark::IndexedIterator< Iterator >:

Public Member Functions

 IndexedIterator ()
 
template<class I >
 IndexedIterator (IndexedIterator< I > const &iterator)
 Copy-Constructs this iterator from some other IndexedIterator convertible to this. More...
 
template<class IteratorT >
 IndexedIterator (IteratorT const &iterator, std::size_t startIndex)
 Constructs the iterator from another iterator plus a starting index. More...
 
std::size_t index () const
 

Friends

class SHARK_ITERATOR_CORE_ACCESS
 

Detailed Description

template<class Iterator>
class shark::IndexedIterator< Iterator >

creates an Indexed Iterator, an Iterator which also carries index information using index()

The underlying Iterator must be a random access iterator

Definition at line 46 of file Iterators.h.

Constructor & Destructor Documentation

◆ IndexedIterator() [1/3]

template<class Iterator>
shark::IndexedIterator< Iterator >::IndexedIterator ( )
inline

Definition at line 54 of file Iterators.h.

◆ IndexedIterator() [2/3]

template<class Iterator>
template<class I >
shark::IndexedIterator< Iterator >::IndexedIterator ( IndexedIterator< I > const &  iterator)
inline

Copy-Constructs this iterator from some other IndexedIterator convertible to this.

Definition at line 59 of file Iterators.h.

◆ IndexedIterator() [3/3]

template<class Iterator>
template<class IteratorT >
shark::IndexedIterator< Iterator >::IndexedIterator ( IteratorT const &  iterator,
std::size_t  startIndex 
)
inline

Constructs the iterator from another iterator plus a starting index.

Definition at line 64 of file Iterators.h.

Member Function Documentation

◆ index()

template<class Iterator>
std::size_t shark::IndexedIterator< Iterator >::index ( ) const
inline

Definition at line 67 of file Iterators.h.

Friends And Related Function Documentation

◆ SHARK_ITERATOR_CORE_ACCESS

template<class Iterator>
friend class SHARK_ITERATOR_CORE_ACCESS
friend

Definition at line 78 of file Iterators.h.


The documentation for this class was generated from the following file: