Reference documentation for deal.II version Git ca6ed5c 2017-11-20 14:53:00 +0100
Public Member Functions | Private Member Functions | Private Attributes | List of all members
IndexSet::IntervalAccessor Class Reference

#include <deal.II/base/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)
 
IntervalAccessoroperator= (const IntervalAccessor &other)
 
bool operator== (const IntervalAccessor &other) const
 
bool operator< (const IntervalAccessor &other) const
 
void advance ()
 

Private Attributes

const IndexSetindex_set
 
size_type range_idx
 

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

Constructor & Destructor Documentation

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

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

Construct an invalid accessor for the IndexSet.

Definition at line 914 of file index_set.h.

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

Private copy constructor.

Definition at line 924 of file index_set.h.

Member Function Documentation

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

Number of elements in this interval.

Definition at line 937 of file index_set.h.

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

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

Definition at line 947 of file index_set.h.

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

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

Definition at line 956 of file index_set.h.

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

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

Definition at line 967 of file index_set.h.

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

Return the index of the last index in this interval.

Definition at line 982 of file index_set.h.

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

Private copy operator.

Definition at line 993 of file index_set.h.

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

Test for equality, used by IntervalIterator.

Definition at line 1006 of file index_set.h.

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

Smaller-than operator, used by IntervalIterator.

Definition at line 1017 of file index_set.h.

void IndexSet::IntervalAccessor::advance ( )
inlineprivate

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

Definition at line 1027 of file index_set.h.

Member Data Documentation

const IndexSet* IndexSet::IntervalAccessor::index_set
private

Reference to the IndexSet.

Definition at line 514 of file index_set.h.

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


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