Reference documentation for deal.II version 9.2.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Private Attributes | List of all members
IndexSet::IntervalIterator Class Reference

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

Public Types

using iterator_category = std::forward_iterator_tag
 
using value_type = IntervalAccessor
 
using difference_type = std::ptrdiff_t
 
using pointer = IntervalAccessor *
 
using reference = IntervalAccessor &
 

Public Member Functions

 IntervalIterator (const IndexSet *idxset, const size_type range_idx)
 
 IntervalIterator (const IndexSet *idxset)
 
 IntervalIterator ()
 
 IntervalIterator (const IntervalIterator &other)=default
 
IntervalIterator & operator= (const IntervalIterator &other)=default
 
IntervalIterator & operator++ ()
 
IntervalIterator operator++ (int)
 
const IntervalAccessor & operator* () const
 
const IntervalAccessor * operator-> () 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 618 of file index_set.h.

Member Typedef Documentation

◆ iterator_category

using IndexSet::IntervalIterator::iterator_category = std::forward_iterator_tag

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

Definition at line 702 of file index_set.h.

◆ value_type

using IndexSet::IntervalIterator::value_type = IntervalAccessor

Definition at line 703 of file index_set.h.

◆ difference_type

using IndexSet::IntervalIterator::difference_type = std::ptrdiff_t

Definition at line 704 of file index_set.h.

◆ pointer

using IndexSet::IntervalIterator::pointer = IntervalAccessor *

Definition at line 705 of file index_set.h.

◆ reference

using IndexSet::IntervalIterator::reference = IntervalAccessor &

Definition at line 706 of file index_set.h.

Constructor & Destructor Documentation

◆ IntervalIterator() [1/4]

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

◆ IntervalIterator() [2/4]

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

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

Definition at line 1174 of file index_set.h.

◆ IntervalIterator() [3/4]

IndexSet::IntervalIterator::IntervalIterator ( )
inline

Construct an empty iterator.

Definition at line 1168 of file index_set.h.

◆ IntervalIterator() [4/4]

IndexSet::IntervalIterator::IntervalIterator ( const IntervalIterator &  other)
default

Copy constructor from other iterator.

Member Function Documentation

◆ operator=()

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

Assignment of another iterator.

◆ operator++() [1/2]

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

Prefix increment.

Definition at line 1181 of file index_set.h.

◆ operator++() [2/2]

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

Postfix increment.

Definition at line 1190 of file index_set.h.

◆ operator*()

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

Dereferencing operator, returns an IntervalAccessor.

Definition at line 1200 of file index_set.h.

◆ operator->()

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

Dereferencing operator, returns a pointer to an IntervalAccessor.

Definition at line 1208 of file index_set.h.

◆ operator==()

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

Comparison.

Definition at line 1217 of file index_set.h.

◆ operator!=()

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

Inverse of ==.

Definition at line 1226 of file index_set.h.

◆ operator<()

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

Comparison operator.

Definition at line 1235 of file index_set.h.

◆ operator-()

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

Member Data Documentation

◆ accessor

IntervalAccessor IndexSet::IntervalIterator::accessor
private

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

Definition at line 712 of file index_set.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17