deal.II version 9.7.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\}}\)
Loading...
Searching...
No Matches
IndexSet::IntervalAccessor Class Reference

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

Detailed Description

Dereferencing an IntervalIterator will return a reference to an object of this type. It allows access to a contiguous interval \([a,b[\) (also called a range) of the IndexSet being iterated over.

Definition at line 684 of file index_set.h.

Public Member Functions

 IntervalAccessor (const IndexSet *idxset, const size_type range_idx)
 IntervalAccessor (const IndexSet *idxset)
size_type n_elements () const
bool is_valid () const
ElementIterator begin () const
ElementIterator end () const
size_type last () const

Private Member Functions

 IntervalAccessor (const IntervalAccessor &other)
IntervalAccessor & operator= (const IntervalAccessor &other)
bool operator== (const IntervalAccessor &other) const
bool operator< (const IntervalAccessor &other) const
void advance ()

Private Attributes

const IndexSet * index_set
size_type range_idx

Friends

class IntervalIterator

Constructor & Destructor Documentation

◆ IntervalAccessor() [1/3]

IndexSet::IntervalAccessor::IntervalAccessor ( const IndexSet * idxset,
const size_type range_idx )
inline

Construct a valid accessor given an IndexSet and the index range_idx of the range to point to.

Definition at line 1232 of file index_set.h.

◆ IntervalAccessor() [2/3]

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

Construct an invalid accessor for the IndexSet.

Definition at line 1244 of file index_set.h.

◆ IntervalAccessor() [3/3]

IndexSet::IntervalAccessor::IntervalAccessor ( const IntervalAccessor & other)
inlineprivate

Private copy constructor.

Definition at line 1251 of file index_set.h.

Member Function Documentation

◆ n_elements()

IndexSet::size_type IndexSet::IntervalAccessor::n_elements ( ) const
inline

Number of elements in this interval.

Definition at line 1263 of file index_set.h.

◆ is_valid()

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

If true, we are pointing at a valid interval in the IndexSet.

Definition at line 1272 of file index_set.h.

◆ begin()

IndexSet::ElementIterator IndexSet::IntervalAccessor::begin ( ) const
inline

Return an iterator pointing at the first index in this interval.

Definition at line 1280 of file index_set.h.

◆ end()

IndexSet::ElementIterator IndexSet::IntervalAccessor::end ( ) const
inline

Return an iterator pointing directly after the last index in this interval.

Definition at line 1289 of file index_set.h.

◆ last()

IndexSet::size_type IndexSet::IntervalAccessor::last ( ) const
inline

Return the index of the last index in this interval.

Definition at line 1303 of file index_set.h.

◆ operator=()

IndexSet::IntervalAccessor & IndexSet::IntervalAccessor::operator= ( const IntervalAccessor & other)
inlineprivate

Private copy operator.

Definition at line 1313 of file index_set.h.

◆ operator==()

bool IndexSet::IntervalAccessor::operator== ( const IntervalAccessor & other) const
inlineprivate

Test for equality, used by IntervalIterator.

Definition at line 1325 of file index_set.h.

◆ operator<()

bool IndexSet::IntervalAccessor::operator< ( const IntervalAccessor & other) const
inlineprivate

Smaller-than operator, used by IntervalIterator.

Definition at line 1336 of file index_set.h.

◆ advance()

void IndexSet::IntervalAccessor::advance ( )
inlineprivate

Advance this accessor to point to the next interval in the index_set.

Definition at line 1349 of file index_set.h.

◆ IntervalIterator

friend class IntervalIterator
friend

Definition at line 767 of file index_set.h.

Member Data Documentation

◆ index_set

const IndexSet* IndexSet::IntervalAccessor::index_set
private

Reference to the IndexSet.

Definition at line 759 of file index_set.h.

◆ range_idx

size_type IndexSet::IntervalAccessor::range_idx
private

Index into index_set.ranges[]. Set to numbers::invalid_dof_index if invalid or the end iterator.

Definition at line 765 of file index_set.h.

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