Reference documentation for deal.II version GIT relicensing-837-gaf73e64026 2024-06-15 22:40:02+00:00
\(\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\}}\)
No Matches
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
DynamicSparsityPatternIterators::Accessor Class Reference

#include <deal.II/lac/dynamic_sparsity_pattern.h>

Public Member Functions

 Accessor (const DynamicSparsityPattern *sparsity_pattern, const size_type row, const unsigned int index_within_row)
 Accessor (const DynamicSparsityPattern *sparsity_pattern)
 Accessor ()
size_type row () const
size_type index () const
size_type column () const
bool operator== (const Accessor &) const
bool operator< (const Accessor &) const

Protected Member Functions

void advance ()

Static Protected Member Functions

static ::ExceptionBaseDummyAccessor ()

Protected Attributes

const DynamicSparsityPatternsparsity_pattern
size_type current_row
std::vector< size_type >::const_iterator current_entry
std::vector< size_type >::const_iterator end_of_row


class Iterator

Detailed Description

Accessor class for iterators into objects of type DynamicSparsityPattern.

Note that this class only allows read access to elements, providing their row and column number (or alternatively the index within the complete sparsity pattern). It does not allow modifying the sparsity pattern itself.

Definition at line 66 of file dynamic_sparsity_pattern.h.

Constructor & Destructor Documentation

◆ Accessor() [1/3]

DynamicSparsityPatternIterators::Accessor::Accessor ( const DynamicSparsityPattern sparsity_pattern,
const size_type  row,
const unsigned int  index_within_row 


Definition at line 732 of file dynamic_sparsity_pattern.h.

◆ Accessor() [2/3]

DynamicSparsityPatternIterators::Accessor::Accessor ( const DynamicSparsityPattern sparsity_pattern)

Constructor. Construct the end accessor for the given sparsity pattern.

Definition at line 768 of file dynamic_sparsity_pattern.h.

◆ Accessor() [3/3]

DynamicSparsityPatternIterators::Accessor::Accessor ( )

Default constructor creating a dummy accessor. This constructor is here only to be able to store accessors in STL containers such as std::vector.

Definition at line 777 of file dynamic_sparsity_pattern.h.

Member Function Documentation

◆ row()

size_type DynamicSparsityPatternIterators::Accessor::row ( ) const

Row number of the element represented by this object.

Definition at line 786 of file dynamic_sparsity_pattern.h.

◆ index()

size_type DynamicSparsityPatternIterators::Accessor::index ( ) const

Index within the current row of the element represented by this object.

Definition at line 806 of file dynamic_sparsity_pattern.h.

◆ column()

size_type DynamicSparsityPatternIterators::Accessor::column ( ) const

Column number of the element represented by this object.

Definition at line 796 of file dynamic_sparsity_pattern.h.

◆ operator==()

bool DynamicSparsityPatternIterators::Accessor::operator== ( const Accessor other) const

Comparison. True, if both iterators point to the same matrix position.

Definition at line 822 of file dynamic_sparsity_pattern.h.

◆ operator<()

bool DynamicSparsityPatternIterators::Accessor::operator< ( const Accessor other) const

Comparison operator. Result is true if either the first row number is smaller or if the row numbers are equal and the first index is smaller.

This function is only valid if both iterators point into the same sparsity pattern.

Definition at line 838 of file dynamic_sparsity_pattern.h.

◆ advance()

void DynamicSparsityPatternIterators::Accessor::advance ( )

Move the accessor to the next nonzero entry in the matrix.

Definition at line 865 of file dynamic_sparsity_pattern.h.

Friends And Related Symbol Documentation

◆ Iterator

friend class Iterator

Definition at line 160 of file dynamic_sparsity_pattern.h.

Member Data Documentation

◆ sparsity_pattern

const DynamicSparsityPattern* DynamicSparsityPatternIterators::Accessor::sparsity_pattern

The sparsity pattern we operate on accessed.

Definition at line 132 of file dynamic_sparsity_pattern.h.

◆ current_row

size_type DynamicSparsityPatternIterators::Accessor::current_row

The row we currently point into.

Definition at line 137 of file dynamic_sparsity_pattern.h.

◆ current_entry

std::vector<size_type>::const_iterator DynamicSparsityPatternIterators::Accessor::current_entry

A pointer to the element within the current row that we currently point to.

Definition at line 143 of file dynamic_sparsity_pattern.h.

◆ end_of_row

std::vector<size_type>::const_iterator DynamicSparsityPatternIterators::Accessor::end_of_row

A pointer to the end of the current row. We store this to make comparison against the end of line iterator cheaper as it otherwise needs to do the IndexSet translation from row index to the index within the 'lines' array of DynamicSparsityPattern.

Definition at line 151 of file dynamic_sparsity_pattern.h.

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