IndexSet::ElementIterator Class Reference

#include <deal.II/base/index_set.h>

Inherits iterator< std::forward_iterator_tag, size_type >.

Public Member Functions
	ElementIterator (const IndexSet *idxset, const size_type range_idx, const size_type index)
	ElementIterator (const IndexSet *idxset)
size_type	operator* () const
bool	is_valid () const
ElementIterator &	operator++ ()
ElementIterator	operator++ (int)
bool	operator== (const ElementIterator &) const
bool	operator!= (const ElementIterator &) const
bool	operator< (const ElementIterator &) const
std::ptrdiff_t	operator- (const ElementIterator &p) const

Private Member Functions
void	advance ()

Private Attributes
const IndexSet *	index_set
size_type	range_idx
size_type	idx

Detailed Description

Class that represents an iterator pointing to a single element in the IndexSet as returned by IndexSet::begin().

Definition at line 614 of file index_set.h.

Constructor & Destructor Documentation

ElementIterator() [1/2]

IndexSet::ElementIterator::ElementIterator ( const IndexSet *  idxset, const size_type  range_idx, const size_type  index  )

inline

Construct an iterator pointing to the global index index in the interval range_idx

Definition at line 1105 of file index_set.h.

ElementIterator() [2/2]

IndexSet::ElementIterator::ElementIterator ( const IndexSet *  idxset )

inlineexplicit

Construct an iterator pointing to the end of the IndexSet.

Definition at line 1117 of file index_set.h.

Member Function Documentation

operator*()

IndexSet::size_type IndexSet::ElementIterator::operator* ( ) const

inline

Dereferencing operator. The returned value is the index of the element inside the IndexSet.

Definition at line 1123 of file index_set.h.

is_valid()

bool IndexSet::ElementIterator::is_valid ( ) const

inline

Does this iterator point to an existing element?

Definition at line 1093 of file index_set.h.

operator++() [1/2]

IndexSet::ElementIterator & IndexSet::ElementIterator::operator++ ( )

inline

Prefix increment.

Definition at line 1162 of file index_set.h.

operator++() [2/2]

IndexSet::ElementIterator IndexSet::ElementIterator::operator++ ( int  )

inline

Postfix increment.

Definition at line 1170 of file index_set.h.

operator==()

bool IndexSet::ElementIterator::operator== ( const ElementIterator &  other ) const

inline

Comparison.

Definition at line 1130 of file index_set.h.

operator!=()

bool IndexSet::ElementIterator::operator!= ( const ElementIterator &  other ) const

inline

Inverse of ==.

Definition at line 1178 of file index_set.h.

operator<()

bool IndexSet::ElementIterator::operator< ( const ElementIterator &  other ) const

inline

Comparison operator.

Definition at line 1184 of file index_set.h.

operator-()

std::ptrdiff_t IndexSet::ElementIterator::operator- ( const ElementIterator &  p ) const

inline

Return the distance between the current iterator and the argument. In the expression it_left-it_right the distance is given by how many times one has to apply operator++ to the right operand it_right to get the left operand it_left (for a positive return value), or to it_left to get the it_right (for a negative return value).

Definition at line 1191 of file index_set.h.

advance()

void IndexSet::ElementIterator::advance ( )

inlineprivate

Advance iterator by one.

Definition at line 1137 of file index_set.h.

Member Data Documentation

index_set

const IndexSet* IndexSet::ElementIterator::index_set

private

The parent IndexSet.

Definition at line 685 of file index_set.h.

range_idx

size_type IndexSet::ElementIterator::range_idx

private

Index into index_set.ranges.

Definition at line 689 of file index_set.h.

idx

size_type IndexSet::ElementIterator::idx

private

The global index this iterator is pointing at.

Definition at line 693 of file index_set.h.

---

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

• deal.II/base/index_set.h