dune-istl  2.2.1
Public Member Functions | List of all members
Dune::Amg::SubGraph< G, T >::EdgeIterator Class Reference

The edge iterator of the graph. More...

#include <dune/istl/paamg/graph.hh>

Public Member Functions

 EdgeIterator (const VertexDescriptor &source, const EdgeDescriptor &edge)
 Constructor.
 EdgeIterator (const EdgeDescriptor &edge)
 Constructor for the end iterator.
bool equals (const EdgeIterator &other) const
 Equality operator.
EdgeIteratorincrement ()
 Preincrement operator.
EdgeIteratordecrement ()
 Preincrement operator.
EdgeIteratoradvance (std::ptrdiff_t n)
const EdgeDescriptordereference () const
 The descriptor of the current edge.
const VertexDescriptortarget () const
 The index of the target vertex of the current edge.
const VertexDescriptorsource () const
 The index of the source vertex of the current edge.
std::ptrdiff_t distanceTo (const EdgeIterator &other) const

Detailed Description

template<class G, class T>
class Dune::Amg::SubGraph< G, T >::EdgeIterator

The edge iterator of the graph.

Constructor & Destructor Documentation

template<class G, class T>
Dune::Amg::SubGraph< G, T >::EdgeIterator::EdgeIterator ( const VertexDescriptor source,
const EdgeDescriptor edge 
)
explicit

Constructor.

Parameters
sourceThe source vertex of the edge.
edgePointer to the edge the iterator should point to.
template<class G, class T>
Dune::Amg::SubGraph< G, T >::EdgeIterator::EdgeIterator ( const EdgeDescriptor edge)
explicit

Constructor for the end iterator.

Only operator== or operator!= can be called safely on an iterator constructed this way!

Parameters
edgePointer to the end of the graph's edge array.

Member Function Documentation

template<class G, class T>
EdgeIterator& Dune::Amg::SubGraph< G, T >::EdgeIterator::advance ( std::ptrdiff_t  n)
template<class G, class T>
EdgeIterator& Dune::Amg::SubGraph< G, T >::EdgeIterator::decrement ( )

Preincrement operator.

template<class G, class T>
const EdgeDescriptor& Dune::Amg::SubGraph< G, T >::EdgeIterator::dereference ( ) const

The descriptor of the current edge.

template<class G, class T>
std::ptrdiff_t Dune::Amg::SubGraph< G, T >::EdgeIterator::distanceTo ( const EdgeIterator other) const
template<class G, class T>
bool Dune::Amg::SubGraph< G, T >::EdgeIterator::equals ( const EdgeIterator other) const

Equality operator.

template<class G, class T>
EdgeIterator& Dune::Amg::SubGraph< G, T >::EdgeIterator::increment ( )

Preincrement operator.

template<class G, class T>
const VertexDescriptor& Dune::Amg::SubGraph< G, T >::EdgeIterator::source ( ) const

The index of the source vertex of the current edge.

template<class G, class T>
const VertexDescriptor& Dune::Amg::SubGraph< G, T >::EdgeIterator::target ( ) const

The index of the target vertex of the current edge.


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