DUNE PDELab (git)

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

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

#include <dune/common/arraylist.hh>

Public Types

typedef A::value_type MemberType
 The member 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.
 
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::value_type const & Reference
 The type of the reference to the values accessed.
 

Public Member Functions

bool equals (const ConstArrayListIterator< MemberType, N, A > &other) const
 Compares to iterators. More...
 
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
 
reference elementAt (size_type i) const
 Get the value of the list at an arbitrary position. More...
 
reference dereference () const
 Access the element at the current position. More...
 
Reference operator* () const
 Dereferencing operator.
 
Reference operator[] (DifferenceType n) const
 Get the element n positions from the current one. More...
 
DerivedTypeoperator++ ()
 Preincrement operator.
 
DerivedType operator++ (int)
 Postincrement operator.
 
DerivedTypeoperator-- ()
 Predecrement operator.
 
DerivedType operator-- (int)
 Postdecrement operator.
 

Static Public Attributes

static constexpr int chunkSize_ = (N > 0) ? N : 1
 The number of elements in one chunk of the list. More...
 

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

◆ 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
A::difference_type DifferenceType
The type of the difference between two positions.
Definition: iteratorfacades.hh:493
A::value_type const & Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:498
void increment()
Increment the iterator.
Definition: arraylist.hh:603
reference elementAt(size_type i) const
Get the value of the list at an arbitrary position.
Definition: arraylist.hh:627
reference dereference() const
Access the element at the current position.
Definition: arraylist.hh:639
void decrement()
decrement the iterator.
Definition: arraylist.hh:615
void advance(difference_type n)
Definition: arraylist.hh:564
bool equals(const ConstArrayListIterator< MemberType, N, A > &other) const
Compares to iterators.
Definition: arraylist.hh:589
difference_type distanceTo(const ConstArrayListIterator< T, N, A > &other) const
Definition: arraylist.hh:653

For an elaborate explanation see the STL Documentation

Member Function Documentation

◆ 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.

Member Data Documentation

◆ chunkSize_

template<class T , int N, class A >
constexpr int Dune::ConstArrayListIterator< T, N, A >::chunkSize_ = (N > 0) ? N : 1
staticconstexpr

The number of elements in one chunk of the list.

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


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 23, 23:29, 2024)