Dune::BCRSMatrix< B, A >::RealRowIterator< T > Class Template Reference

Iterator access to matrix rows More...

#include <dune/istl/bcrsmatrix.hh>

Public Types
typedef std::remove_const< T >::type	ValueType
	The unqualified value type.
typedef RealRowIterator< 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
	RealRowIterator (row_type *_p, size_type _i)
	constructor
	RealRowIterator ()
	empty constructor, use with care!
size_type	index () const
	return index
bool	equals (const RealRowIterator< ValueType > &other) const
	equality
bool	equals (const RealRowIterator< const ValueType > &other) const
	equality
constexpr Reference	operator* () const
	Dereferencing operator.
constexpr Reference	operator[] (DifferenceType n) const
	Get the element n positions from the current one. More...
constexpr DerivedType &	operator++ ()
	Preincrement operator.
constexpr DerivedType	operator++ (int)
	Postincrement operator.
constexpr DerivedType &	operator-- ()
	Predecrement operator.
constexpr DerivedType	operator-- (int)
	Postdecrement operator.

Detailed Description

template<class B, class A = std::allocator<B>>
template<class T>
class Dune::BCRSMatrix< B, A >::RealRowIterator< T >

Iterator access to matrix rows

Member Typedef Documentation

DerivedType

typedef RealRowIterator< T > Dune::RandomAccessIteratorFacade< RealRowIterator< 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;

For an elaborate explanation see the STL Documentation

Member Function Documentation

operator[]()

constexpr Reference Dune::RandomAccessIteratorFacade< RealRowIterator< T > , T , T & , std::ptrdiff_t >::operator[] ( DifferenceType  n ) const

inlineconstexprinherited

Get the element n positions from the current one.

Parameters

n	The distance to the element.

Returns

The element at that distance.

---

The documentation for this class was generated from the following file:

• dune/istl/bcrsmatrix.hh