Dune Core Modules (2.8.0)

The iterator over the pairs. More...

#include <dune/common/parallel/indexset.hh>

Public Types

enum  { chunkSize_ = (N > 0) ? N : 1 }
 
typedef A::value_type MemberType
 The member type.
 
typedef ArrayListIterator< T, N, A > DerivedType
 The type of derived iterator. More...
 
typedef A::value_type Value
 The type of value accessed through the iterator.
 
typedef 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 & Reference
 The type of the reference to the values accessed.
 

Public Member Functions

bool equals (const ArrayListIterator< MemberType, N, A > &other) const
 Comares two iterators. More...
 
bool equals (const ConstArrayListIterator< MemberType, N, A > &other) const
 Comares two iterators. More...
 
void increment ()
 Increment the iterator.
 
void decrement ()
 decrement the iterator.
 
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...
 
void eraseToHere ()
 Erase all entries before the current position and the one at the current position. More...
 
size_type position ()
 
void advance (difference_type n)
 
difference_type distanceTo (const ArrayListIterator< T, N, A > &other) const
 
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.
 

Detailed Description

template<typename TG, typename TL, int N = 100>
class Dune::ParallelIndexSet< TG, TL, N >::iterator

The iterator over the pairs.

Member Typedef Documentation

◆ DerivedType

typedef ArrayListIterator< T, N, A > Dune::RandomAccessIteratorFacade< ArrayListIterator< T, N, A > , A::value_type , A::value_type & , 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:490
A::value_type & Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:495
bool equals(const ArrayListIterator< MemberType, N, A > &other) const
Comares two iterators.
Definition: arraylist.hh:585
void increment()
Increment the iterator.
Definition: arraylist.hh:611
void decrement()
decrement the iterator.
Definition: arraylist.hh:623
reference elementAt(size_type i) const
Get the value of the list at an arbitrary position.
Definition: arraylist.hh:635
void advance(difference_type n)
Definition: arraylist.hh:572
reference dereference() const
Access the element at the current position.
Definition: arraylist.hh:647
difference_type distanceTo(const ArrayListIterator< T, N, A > &other) const
Definition: arraylist.hh:659

For an elaborate explanation see the STL Documentation

Member Enumeration Documentation

◆ anonymous enum

template<class T , int N, class A >
anonymous enum
inherited
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

◆ operator[]()

Reference Dune::RandomAccessIteratorFacade< ArrayListIterator< T, N, A > , A::value_type , A::value_type & , 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.

◆ position()

template<class T , int N, class A >
size_type Dune::ArrayListIterator< T, N, A >::position ( )
inlineinherited
Todo:
Please doc me!

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 (Dec 22, 23:30, 2024)