Dune Core Modules (unstable)

Generic iterator class for dense vector and matrix implementations. More...

#include <dune/common/densevector.hh>

Public Types

typedef std::ptrdiff_t DifferenceType
 The type of the difference between two positions.
 
typedef C::size_type SizeType
 The type to index the underlying container.
 
typedef DenseIterator< C, T, T & > DerivedType
 The type of derived iterator. More...
 
typedef T Value
 The type of value accessed through the iterator.
 
typedef T * Pointer
 The pointer to the Value.
 
typedef T & Reference
 The type of the reference to the values accessed.
 

Public Member Functions

SizeType index () const
 return index
 
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<class C, class T, class R = T&>
class Dune::DenseIterator< C, T, R >

Generic iterator class for dense vector and matrix implementations.

provides sequential access to DenseVector, FieldVector and FieldMatrix

Member Typedef Documentation

◆ DerivedType

typedef DenseIterator< C, T, T & > Dune::RandomAccessIteratorFacade< DenseIterator< C, T, T & > , T , T & , std::ptrdiff_t >::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;
// Access the value at some other location
Reference elementAt(n) const;
// 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-
void advance(DifferenceType n);
// calculate the distance to another iterator.
// One should incorporate an assertion whether
// the same containers are referenced
DifferenceType distanceTo(j) const;
std::ptrdiff_t DifferenceType
The type of the difference between two positions.
Definition: densevector.hh:142
T & Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:497

For an elaborate explanation see the STL Documentation

Member Function Documentation

◆ operator[]()

Reference Dune::RandomAccessIteratorFacade< DenseIterator< C, T, T & > , T , T & , std::ptrdiff_t >::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:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Jun 16, 22:32, 2024)