Dune::ConstArrayListIterator< T, N, A > Class Template Reference
[Common]

#include <arraylist.hh>

Inheritance diagram for Dune::ConstArrayListIterator< T, N, A >:

Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A >, const A::value_type, A::const_reference, A::difference_type > List of all members.

Detailed Description

template<class T, int N, class A>
class Dune::ConstArrayListIterator< T, N, A >

A constant random access iterator for the Dune::ArrayList class.


Public Types

enum  { chunkSize_ = (N > 0)? N : 1 }
typedef A::value_type MemberType
 The member type.
typedef ConstArrayListIterator<
T, N, A > 
DerivedType
 The type of derived iterator.
typedef const A::value_type Value
 The type of value accessed through the iterator.
typedef const A::value_type * Pointer
 The pointer to the Value.
typedef A::difference_type DifferenceType
 The type of the difference between two positions.
typedef A::const_reference Reference
 The type of the reference to the values accessed.

Public Member Functions

bool equals (const ConstArrayListIterator< MemberType, N, A > &other) const
 Comares to iterators.
void increment ()
 Increment the iterator.
void decrement ()
 decrement the iterator.
void advance (difference_type n)
difference_type distanceTo (const ConstArrayListIterator< T, N, A > &other) const
const MemberTypeelementAt (size_type i) const
 Get the value of the list at an arbitrary position.
const MemberTypedereference () const
 Access the element at the current position.
Reference operator * () const
 Dereferencing operator.
Reference operator[] (DifferenceType n) const
 Get the element n positions from the current one.
DerivedTypeoperator++ ()
 Preincrement operator.
DerivedType operator++ (int)
 Postincrement operator.
DerivedTypeoperator-- ()
 Predecrement operator.
DerivedType operator-- (int)
 Postdecrement operator.

Member Typedef Documentation

typedef ConstArrayListIterator< T, N, A > Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::const_reference , A::difference_type >::DerivedType [inherited]

The type of derived iterator.

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

 // Access the value referred to.
 Reference dereference() const;

 // Compare for equality with j
 equals(i);

 // 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-
 void advance(DifferenceType n);
 // calculate the distance to another iterator.
 // One should incorporate an assertion wether
 // the same containers are referenced
 DifferenceType distanceTo(j) const;

For an elaborate explanation see the STL Documentation


Member Enumeration Documentation

template<class T, int N, class A>
anonymous enum

Enumerator:
chunkSize_  The number of elements in one chunk of the list.

This has to be at least one. The default is 100.


Member Function Documentation

Reference Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::const_reference , A::difference_type >::operator[] ( DifferenceType  n  )  const [inline, inherited]

Get the element n positions from the current one.

Parameters:
n The distance to the element.
Returns:
The element at that distance.


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

Generated on 9 Apr 2008 with Doxygen (ver 1.5.2) [logfile].