dune-common  2.6-git
Public Types | Public Member Functions | List of all members
Dune::GenericIterator< C, T, R, D, IteratorFacade > Class Template Reference

Generic class for stl-conforming iterators for container classes with operator[]. More...

#include <dune/common/genericiterator.hh>

Inheritance diagram for Dune::GenericIterator< C, T, R, D, IteratorFacade >:
Inheritance graph

Public Types

typedef C Container
 The type of container we are an iterator for. More...
 
typedef T Value
 The value type of the iterator. More...
 
typedef D DifferenceType
 The type of the difference between two positions. More...
 
typedef R Reference
 The type of the reference to the values accessed. More...
 
typedef GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacadeDerivedType
 The type of derived iterator. More...
 
typedef T * Pointer
 The pointer to the Value. More...
 

Public Member Functions

 GenericIterator ()
 
 GenericIterator (Container &cont, DifferenceType pos)
 Constructor. More...
 
 GenericIterator (const MutableIterator &other)
 Copy constructor. More...
 
 GenericIterator (const ConstIterator &other)
 Copy constructor. More...
 
bool equals (const MutableIterator &other) const
 
bool equals (const ConstIterator &other) const
 
Reference dereference () const
 
void increment ()
 
void decrement ()
 
Reference elementAt (DifferenceType i) const
 
void advance (DifferenceType n)
 
DifferenceType distanceTo (const MutableIterator &other) const
 
DifferenceType distanceTo (const ConstIterator &other) const
 
Reference operator* () const
 Dereferencing operator. More...
 
Pointer operator-> () const
 
Reference operator[] (DifferenceType n) const
 Get the element n positions from the current one. More...
 
DerivedTypeoperator++ ()
 Preincrement operator. More...
 
DerivedType operator++ (int)
 Postincrement operator. More...
 
DerivedTypeoperator+= (DifferenceType n)
 
DerivedType operator+ (DifferenceType n) const
 
DerivedTypeoperator-- ()
 Predecrement operator. More...
 
DerivedType operator-- (int)
 Postdecrement operator. More...
 
DerivedTypeoperator-= (DifferenceType n)
 
DerivedType operator- (DifferenceType n) const
 

Detailed Description

template<class C, class T, class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
class Dune::GenericIterator< C, T, R, D, IteratorFacade >

Generic class for stl-conforming iterators for container classes with operator[].

If template parameter C has a const qualifier we are a const iterator, otherwise we are a mutable iterator.

Member Typedef Documentation

◆ Container

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
typedef C Dune::GenericIterator< C, T, R, D, IteratorFacade >::Container

The type of container we are an iterator for.

The container type must provide an operator[] method.

If C has a const qualifier we are a const iterator, otherwise we are a mutable iterator.

◆ DerivedType

typedef GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::DerivedType
inherited

The type of derived iterator.

The iterator has to define following functions have to be present:

// Access the value referred to.
// Access the value at some other location
// Compare for equality with j
bool equals(j);
// position the iterator at the next element.
void increment()
// position the iterator at the previous element.
void decrement()
// advance the iterator by a number of positions-
// calculate the distance to another iterator.
// One should incorporate an assertion whether
// the same containers are referenced

For an elaborate explanation see the STL Documentation

◆ DifferenceType

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
typedef D Dune::GenericIterator< C, T, R, D, IteratorFacade >::DifferenceType

The type of the difference between two positions.

◆ Pointer

typedef T * Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::Pointer
inherited

The pointer to the Value.

◆ Reference

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
typedef R Dune::GenericIterator< C, T, R, D, IteratorFacade >::Reference

The type of the reference to the values accessed.

◆ Value

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
typedef T Dune::GenericIterator< C, T, R, D, IteratorFacade >::Value

The value type of the iterator.

This is the return type when dereferencing the iterator.

Constructor & Destructor Documentation

◆ GenericIterator() [1/4]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
Dune::GenericIterator< C, T, R, D, IteratorFacade >::GenericIterator ( )
inline

◆ GenericIterator() [2/4]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
Dune::GenericIterator< C, T, R, D, IteratorFacade >::GenericIterator ( Container cont,
DifferenceType  pos 
)
inline

Constructor.

Parameters
contReference to the container we are an iterator for
posThe position the iterator will be positioned to (e.g. 0 for an iterator returned by Container::begin() or the size of the container for an iterator returned by Container::end()

◆ GenericIterator() [3/4]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
Dune::GenericIterator< C, T, R, D, IteratorFacade >::GenericIterator ( const MutableIterator other)
inline

Copy constructor.

This is somehow hard to understand, therefore play with the cases:

  1. if we are mutable this is the only valid copy constructor, as the argument is a mutable iterator
  2. if we are a const iterator the argument is a mutable iterator => This is the needed conversion to initialize a const iterator from a mutable one.

◆ GenericIterator() [4/4]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
Dune::GenericIterator< C, T, R, D, IteratorFacade >::GenericIterator ( const ConstIterator other)
inline

Copy constructor.

Warning
Calling this method results in a compiler error, if this is a mutable iterator.

This is somehow hard to understand, therefore play with the cases:

  1. if we are mutable the arguments is a const iterator and therefore calling this method is mistake in the user's code and results in a (probably not understandable) compiler error
  2. If we are a const iterator this is the default copy constructor as the argument is a const iterator too.

Member Function Documentation

◆ advance()

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
void Dune::GenericIterator< C, T, R, D, IteratorFacade >::advance ( DifferenceType  n)
inline

◆ decrement()

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
void Dune::GenericIterator< C, T, R, D, IteratorFacade >::decrement ( )
inline

◆ dereference()

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
Reference Dune::GenericIterator< C, T, R, D, IteratorFacade >::dereference ( ) const
inline

◆ distanceTo() [1/2]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
DifferenceType Dune::GenericIterator< C, T, R, D, IteratorFacade >::distanceTo ( const ConstIterator other) const
inline

◆ distanceTo() [2/2]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
DifferenceType Dune::GenericIterator< C, T, R, D, IteratorFacade >::distanceTo ( const MutableIterator other) const
inline

◆ elementAt()

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
Reference Dune::GenericIterator< C, T, R, D, IteratorFacade >::elementAt ( DifferenceType  i) const
inline

◆ equals() [1/2]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
bool Dune::GenericIterator< C, T, R, D, IteratorFacade >::equals ( const ConstIterator other) const
inline

◆ equals() [2/2]

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
bool Dune::GenericIterator< C, T, R, D, IteratorFacade >::equals ( const MutableIterator other) const
inline

◆ increment()

template<class C , class T , class R = T&, class D = std::ptrdiff_t, template< class, class, class, class > class IteratorFacade = RandomAccessIteratorFacade>
void Dune::GenericIterator< C, T, R, D, IteratorFacade >::increment ( )
inline

◆ operator*()

Reference Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator*
inlineinherited

Dereferencing operator.

◆ operator+()

DerivedType Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator+ ( DifferenceType  n) const
inlineinherited

◆ operator++() [1/2]

DerivedType& Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator++
inlineinherited

Preincrement operator.

◆ operator++() [2/2]

DerivedType Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator++ ( int  )
inlineinherited

Postincrement operator.

◆ operator+=()

DerivedType& Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator+= ( DifferenceType  n)
inlineinherited

◆ operator-()

DerivedType Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator- ( DifferenceType  n) const
inlineinherited

◆ operator--() [1/2]

DerivedType& Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator--
inlineinherited

Predecrement operator.

◆ operator--() [2/2]

DerivedType Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator-- ( int  )
inlineinherited

Postdecrement operator.

◆ operator-=()

DerivedType& Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator-= ( DifferenceType  n)
inlineinherited

◆ operator->()

Pointer Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator->
inlineinherited

◆ operator[]()

Reference Dune::RandomAccessIteratorFacade< GenericIterator< C, T, T &, std::ptrdiff_t, RandomAccessIteratorFacade > , T , T & , std::ptrdiff_t >::operator[] ( DifferenceType  n) const
inlineinherited

Get the element n positions from the current one.

Parameters
nThe distance to the element.
Returns
The element at that distance.

The documentation for this class was generated from the following file:
Dune::GenericIterator::equals
bool equals(const MutableIterator &other) const
Definition: genericiterator.hh:225
Dune::GenericIterator::DifferenceType
D DifferenceType
The type of the difference between two positions.
Definition: genericiterator.hh:180
Dune::GenericIterator::Reference
R Reference
The type of the reference to the values accessed.
Definition: genericiterator.hh:185
Dune::GenericIterator::decrement
void decrement()
Definition: genericiterator.hh:244
Dune::GenericIterator::increment
void increment()
Definition: genericiterator.hh:239
Dune::GenericIterator::advance
void advance(DifferenceType n)
Definition: genericiterator.hh:253
Dune::GenericIterator::elementAt
Reference elementAt(DifferenceType i) const
Definition: genericiterator.hh:249
Dune::GenericIterator::distanceTo
DifferenceType distanceTo(const MutableIterator &other) const
Definition: genericiterator.hh:257
Dune::GenericIterator::dereference
Reference dereference() const
Definition: genericiterator.hh:235