Reference documentation for deal.II version Git 2618e0f 2017-11-23 17:25:26 +0100
Public Member Functions | Private Member Functions | Private Attributes | List of all members
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
 
ElementIteratoroperator++ ()
 
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 IndexSetindex_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 612 of file index_set.h.

Constructor & Destructor Documentation

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 1180 of file index_set.h.

IndexSet::ElementIterator::ElementIterator ( const IndexSet idxset)
inlineexplicit

Construct an iterator pointing to the end of the IndexSet.

Definition at line 1199 of file index_set.h.

Member Function Documentation

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 1226 of file index_set.h.

bool IndexSet::ElementIterator::is_valid ( ) const
inline

Does this iterator point to an existing element?

Definition at line 1210 of file index_set.h.

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

Prefix increment.

Definition at line 1276 of file index_set.h.

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

Postfix increment.

Definition at line 1286 of file index_set.h.

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

Comparison.

Definition at line 1237 of file index_set.h.

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

Inverse of ==.

Definition at line 1296 of file index_set.h.

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

Comparison operator.

Definition at line 1304 of file index_set.h.

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 1315 of file index_set.h.

void IndexSet::ElementIterator::advance ( )
inlineprivate

Advance iterator by one.

Definition at line 1248 of file index_set.h.

Member Data Documentation

const IndexSet* IndexSet::ElementIterator::index_set
private

The parent IndexSet.

Definition at line 683 of file index_set.h.

size_type IndexSet::ElementIterator::range_idx
private

Index into index_set.ranges.

Definition at line 687 of file index_set.h.

size_type IndexSet::ElementIterator::idx
private

The global index this iterator is pointing at.

Definition at line 691 of file index_set.h.


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