dune-common  2.7.1
Public Types | Public Member Functions | List of all members
Dune::ConstArrayListIterator< T, N, A > Class Template Reference

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

#include <dune/common/arraylist.hh>

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

Public Types

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

Public Member Functions

bool equals (const ConstArrayListIterator< MemberType, N, A > &other) const
 Comares to iterators. More...
 
void increment ()
 Increment the iterator. More...
 
void decrement ()
 decrement the iterator. More...
 
void advance (difference_type n)
 
difference_type distanceTo (const ConstArrayListIterator< T, N, A > &other) const
 
const_reference elementAt (size_type i) const
 Get the value of the list at an arbitrary position. More...
 
const_reference dereference () const
 Access the element at the current position. More...
 
const ConstArrayListIterator< T, N, A > & operator= (const ConstArrayListIterator< T, N, A > &other)
 
 ConstArrayListIterator ()
 
 ConstArrayListIterator (const ArrayListIterator< T, N, A > &other)
 
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 T, int N, class A>
class Dune::ConstArrayListIterator< T, N, A >

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

Member Typedef Documentation

◆ const_reference

template<class T , int N, class A >
using Dune::ConstArrayListIterator< T, N, A >::const_reference = typename A::value_type const&

◆ DerivedType

typedef ConstArrayListIterator< T, N, A > Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , 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.
// 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
void increment()
Increment the iterator.
Definition: arraylist.hh:617
const_reference elementAt(size_type i) const
Get the value of the list at an arbitrary position.
Definition: arraylist.hh:641
void decrement()
decrement the iterator.
Definition: arraylist.hh:629
void advance(difference_type n)
Definition: arraylist.hh:578
const_reference dereference() const
Access the element at the current position.
Definition: arraylist.hh:653
bool equals(const ConstArrayListIterator< MemberType, N, A > &other) const
Comares to iterators.
Definition: arraylist.hh:603
difference_type distanceTo(const ConstArrayListIterator< T, N, A > &other) const
Definition: arraylist.hh:667
A::difference_type DifferenceType
The type of the difference between two positions.
Definition: iteratorfacades.hh:490
A::value_type const & Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:495

For an elaborate explanation see the STL Documentation

◆ difference_type

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

◆ DifferenceType

typedef A::difference_type Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::DifferenceType
inherited

The type of the difference between two positions.

◆ iterator_category

using Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::iterator_category = std::random_access_iterator_tag
inherited

◆ MemberType

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

The member type.

◆ pointer

using Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::pointer = const A::value_type *
inherited

◆ Pointer

typedef const A::value_type * Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::Pointer
inherited

The pointer to the Value.

◆ reference

template<class T , int N, class A >
using Dune::ConstArrayListIterator< T, N, A >::reference = typename A::value_type &

◆ Reference

typedef A::value_type const & Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::Reference
inherited

The type of the reference to the values accessed.

◆ size_type

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

◆ Value

typedef const A::value_type Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::Value
inherited

The type of value accessed through the iterator.

◆ value_type

using Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::value_type = typename std::remove_const<const A::value_type >::type
inherited

Member Enumeration Documentation

◆ anonymous enum

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.

Constructor & Destructor Documentation

◆ ConstArrayListIterator()

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

Member Function Documentation

◆ operator*()

Reference Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator* ( ) const
inlineinherited

Dereferencing operator.

◆ operator+()

DerivedType Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator+ ( DifferenceType  n) const
inlineinherited

◆ operator++() [1/2]

DerivedType& Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator++ ( )
inlineinherited

Preincrement operator.

◆ operator++() [2/2]

DerivedType Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator++ ( int  )
inlineinherited

Postincrement operator.

◆ operator+=()

DerivedType& Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator+= ( DifferenceType  n)
inlineinherited

◆ operator-()

DerivedType Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator- ( DifferenceType  n) const
inlineinherited

◆ operator--() [1/2]

DerivedType& Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator-- ( )
inlineinherited

Predecrement operator.

◆ operator--() [2/2]

DerivedType Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator-- ( int  )
inlineinherited

Postdecrement operator.

◆ operator-=()

DerivedType& Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator-= ( DifferenceType  n)
inlineinherited

◆ operator->()

Pointer Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::operator-> ( ) const
inlineinherited

◆ operator[]()

Reference Dune::RandomAccessIteratorFacade< ConstArrayListIterator< T, N, A > , const A::value_type , A::value_type const & , A::difference_type >::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: