Dune Core Modules (unstable)

Dune::VariableBlockVector< B, A >::RealIterator< T, R > Class Template Reference

Iterator class for sequential access. More...

#include <dune/istl/vbvector.hh>

Public Types

typedef RealIterator< T, R > 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 std::ptrdiff_t DifferenceType
 The type of the difference between two positions.
 
typedef R Reference
 The type of the reference to the values accessed.
 

Public Member Functions

 RealIterator ()
 constructor, no arguments
 
 RealIterator (window_type *_p, size_type _i)
 constructor
 
void increment ()
 prefix increment
 
void decrement ()
 prefix decrement
 
bool equals (const RealIterator &it) const
 equality
 
window_type & dereference () const
 dereferencing
 
size_type index () const
 Return the index of the entry this iterator is pointing to.
 
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 B, class A = std::allocator<B>>
template<class T, class R>
class Dune::VariableBlockVector< B, A >::RealIterator< T, R >

Iterator class for sequential access.

Member Typedef Documentation

◆ DerivedType

typedef RealIterator< T, R > Dune::RandomAccessIteratorFacade< RealIterator< T, R > , T , R, 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.
// 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: iteratorfacades.hh:492
R Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:497
window_type & dereference() const
dereferencing
Definition: vbvector.hh:612
bool equals(const RealIterator &it) const
equality
Definition: vbvector.hh:606
void decrement()
prefix decrement
Definition: vbvector.hh:600
void increment()
prefix increment
Definition: vbvector.hh:594

For an elaborate explanation see the STL Documentation

Member Function Documentation

◆ operator[]()

Reference Dune::RandomAccessIteratorFacade< RealIterator< T, R > , T , R, 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.80.0 (Apr 27, 22:29, 2024)