Reference documentation for deal.II version Git 437f94a 2018-06-23 09:16:19 -0400
Public Types | Public Member Functions | Private Attributes | List of all members
IndexSet::IntervalIterator Class Reference

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

Public Types

typedef std::forward_iterator_tag iterator_category
 

Public Member Functions

 IntervalIterator (const IndexSet *idxset, const size_type range_idx)
 
 IntervalIterator (const IndexSet *idxset)
 
 IntervalIterator ()
 
 IntervalIterator (const IntervalIterator &other)
 
IntervalIteratoroperator= (const IntervalIterator &other)
 
IntervalIteratoroperator++ ()
 
IntervalIterator operator++ (int)
 
const IntervalAccessoroperator* () const
 
const IntervalAccessoroperator-> () const
 
bool operator== (const IntervalIterator &) const
 
bool operator!= (const IntervalIterator &) const
 
bool operator< (const IntervalIterator &) const
 
int operator- (const IntervalIterator &p) const
 

Private Attributes

IntervalAccessor accessor
 

Detailed Description

Class that represents an iterator pointing to a contiguous interval \([a,b[\) as returned by IndexSet::begin_interval().

Definition at line 573 of file index_set.h.

Member Typedef Documentation

typedef std::forward_iterator_tag IndexSet::IntervalIterator::iterator_category

Mark the class as forward iterator and declare some typedefs which are standard for iterators and are used by algorithms to enquire about the specifics of the iterators they work on.

Definition at line 657 of file index_set.h.

Constructor & Destructor Documentation

IndexSet::IntervalIterator::IntervalIterator ( const IndexSet idxset,
const size_type  range_idx 
)
inline

Construct a valid iterator pointing to the interval with index range_idx.

Definition at line 1119 of file index_set.h.

IndexSet::IntervalIterator::IntervalIterator ( const IndexSet idxset)
inlineexplicit

Construct an invalid iterator (used as end()).

Definition at line 1133 of file index_set.h.

IndexSet::IntervalIterator::IntervalIterator ( )
inline

Construct an empty iterator.

Definition at line 1127 of file index_set.h.

IndexSet::IntervalIterator::IntervalIterator ( const IntervalIterator other)
inline

Copy constructor from other iterator.

Definition at line 1139 of file index_set.h.

Member Function Documentation

IndexSet::IntervalIterator & IndexSet::IntervalIterator::operator= ( const IntervalIterator other)
inline

Assignment of another iterator.

Definition at line 1147 of file index_set.h.

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

Prefix increment.

Definition at line 1156 of file index_set.h.

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

Postfix increment.

Definition at line 1165 of file index_set.h.

const IndexSet::IntervalAccessor & IndexSet::IntervalIterator::operator* ( ) const
inline

Dereferencing operator, returns an IntervalAccessor.

Definition at line 1175 of file index_set.h.

const IndexSet::IntervalAccessor * IndexSet::IntervalIterator::operator-> ( ) const
inline

Dereferencing operator, returns a pointer to an IntervalAccessor.

Definition at line 1183 of file index_set.h.

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

Comparison.

Definition at line 1192 of file index_set.h.

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

Inverse of ==.

Definition at line 1201 of file index_set.h.

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

Comparison operator.

Definition at line 1210 of file index_set.h.

int IndexSet::IntervalIterator::operator- ( const IntervalIterator p) const
inline

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

Definition at line 1219 of file index_set.h.

Member Data Documentation

IntervalAccessor IndexSet::IntervalIterator::accessor
private

Accessor that contains what IndexSet and interval we are pointing at.

Definition at line 667 of file index_set.h.


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