Dune Core Modules (2.3.1)

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

iterator class for sequential access More...

#include <dune/istl/basearray.hh>

Public Types

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

Public Member Functions

 RealIterator ()
 constructor
 
 RealIterator (B *_p, size_type *_j, size_type _i)
 constructor
 
 RealIterator (const RealIterator< ValueType > &it)
 Copy constructor from mutable iterator.
 
bool equals (const RealIterator< ValueType > &it) const
 equality
 
bool equals (const RealIterator< const ValueType > &it) const
 equality
 
size_type index () const
 return index corresponding to pointer
 
void setindex (size_type k)
 Set index corresponding to pointer.
 
size_type offset () const
 offset from the first entry. More...
 
Reference operator* () const
 Dereferencing operator.
 
DerivedTypeoperator++ ()
 Preincrement operator.
 
DerivedType operator++ (int)
 Postincrement operator.
 
DerivedTypeoperator-- ()
 Preincrement operator.
 
DerivedType operator-- (int)
 Postincrement operator.
 

Detailed Description

template<class B, class A = std::allocator<B>>
template<class T>
class Dune::compressed_base_array_unmanaged< B, A >::RealIterator< T >

iterator class for sequential access

Member Typedef Documentation

◆ DerivedType

typedef RealIterator< T > Dune::BidirectionalIteratorFacade< RealIterator< 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;
// 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()
T & Reference
The type of the reference to the values accessed.
Definition: iteratorfacades.hh:321
bool equals(const RealIterator< ValueType > &it) const
equality
Definition: basearray.hh:625

For an elaborate explanation see the STL Documentation

Member Function Documentation

◆ offset()

template<class B , class A = std::allocator<B>>
template<class T >
size_type Dune::compressed_base_array_unmanaged< B, A >::RealIterator< T >::offset ( ) const
inline

offset from the first entry.

An iterator positioned at the beginning has to be increment this amount of times to the same position.


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 12, 23:30, 2024)