DUNE-FEM (unstable)
Dune::ArrayListIterator< T, N, A > Class Template Reference
A 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 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 |
Compares two iterators. More... | |
bool | equals (const ConstArrayListIterator< MemberType, N, A > &other) const |
Compares 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 |
ArrayListIterator () | |
Standard constructor. | |
Reference | operator* () const |
Dereferencing operator. | |
Reference | operator[] (DifferenceType n) const |
Get the element n positions from the current one. More... | |
DerivedType & | operator++ () |
Preincrement operator. | |
DerivedType | operator++ (int) |
Postincrement operator. | |
DerivedType & | operator-- () |
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::ArrayListIterator< T, N, A >
class Dune::ArrayListIterator< T, N, A >
A random access iterator for the Dune::ArrayList class.
Member Typedef Documentation
◆ 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
DifferenceType distanceTo(j) const;
A::difference_type DifferenceType
The type of the difference between two positions.
Definition: iteratorfacades.hh:493
A::value_type & Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:498
bool equals(const ArrayListIterator< MemberType, N, A > &other) const
Compares two iterators.
Definition: arraylist.hh:571
void increment()
Increment the iterator.
Definition: arraylist.hh:597
void decrement()
decrement the iterator.
Definition: arraylist.hh:609
reference elementAt(size_type i) const
Get the value of the list at an arbitrary position.
Definition: arraylist.hh:621
reference dereference() const
Access the element at the current position.
Definition: arraylist.hh:633
difference_type distanceTo(const ArrayListIterator< T, N, A > &other) const
Definition: arraylist.hh:645
For an elaborate explanation see the STL Documentation
Member Function Documentation
◆ operator[]()
|
inlineinherited |
Get the element n positions from the current one.
- Parameters
-
n The distance to the element.
- Returns
- The element at that distance.
◆ position()
template<class T , int N, class A >
|
inline |
- Todo:
- Please doc me!
Member Data Documentation
◆ chunkSize_
template<class T , int N, class A >
|
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:
- dune/common/arraylist.hh
|
Legal Statements / Impressum |
Hosted by TU Dresden |
generated with Hugo v0.111.3
(Nov 12, 23:30, 2024)