Dune::GeneralVertexOrder< dim, Index_ >::iterator Class Reference

Iterate over the vertex indices of some sub-entity. More...

#include <dune/geometry/generalvertexorder.hh>

Public Types
typedef iterator	DerivedType
	The type of derived iterator. More...
typedef const Index_	Value
	The type of value accessed through the iterator.
typedef const Index_ *	Pointer
	The pointer to the Value.
typedef std::ptrdiff_t	DifferenceType
	The type of the difference between two positions.
typedef const Index_ &	Reference
	The type of the reference to the values accessed.

Public Member Functions
	iterator ()
	public default constructor More...
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.

Detailed Description

template<std::size_t dim, class Index_ = std::size_t>
class Dune::GeneralVertexOrder< dim, Index_ >::iterator

Iterate over the vertex indices of some sub-entity.

This is a random access iterator with constant value_type.

Member Typedef Documentation

DerivedType

typedef iterator Dune::RandomAccessIteratorFacade< iterator , const Index_ , const Index_ & , 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 wether
// the same containers are referenced
DifferenceType distanceTo(j) const;

For an elaborate explanation see the STL Documentation

Constructor & Destructor Documentation

iterator()

template<std::size_t dim, class Index_ = std::size_t>

Dune::GeneralVertexOrder< dim, Index_ >::iterator::iterator ( )

inline

public default constructor

The contructed iterator object will have a singular value. The only valid operations will be assignment of a non-singular value and destruction, all other operations will result in undefined behaviour.

Member Function Documentation

operator[]()

Reference Dune::RandomAccessIteratorFacade< iterator , const Index_ , const Index_ & , std::ptrdiff_t >::operator[] ( DifferenceType  n ) const

inlineinherited

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/geometry/generalvertexorder.hh