Reference documentation for deal.II version GIT relicensing-822-gf1642d4ea5 2024-06-12 14:10: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
Classes | Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | Friends | List of all members
SparseMatrixIterators::Accessor< number, false > Class Template Reference

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

Inheritance diagram for SparseMatrixIterators::Accessor< number, false >:
Inheritance graph


class  Reference

Public Types

using MatrixType = SparseMatrix< number >
using size_type = SparsityPatternIterators::size_type

Public Member Functions

 Accessor (MatrixType *matrix, const std::size_t index)
 Accessor (MatrixType *matrix)
Reference value () const
MatrixTypeget_matrix () const
size_type row () const
size_type index () const
size_type global_index () const
size_type column () const
bool is_valid_entry () 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 SparsityPatterncontainer
std::size_t linear_index

Private Attributes



template<typename , bool >
class Iterator

Detailed Description

template<typename number>
class SparseMatrixIterators::Accessor< number, false >

Accessor class for non-constant matrices, used in the iterators. This class builds on the accessor classes used for sparsity patterns to loop over all nonzero entries, and only adds the accessor functions to gain access to the actual value stored at a certain location.

Definition at line 189 of file sparse_matrix.h.

Member Typedef Documentation

◆ MatrixType

template<typename number >
using SparseMatrixIterators::Accessor< number, false >::MatrixType = SparseMatrix<number>

Typedef for the type (including constness) of the matrix to be used here.

Definition at line 273 of file sparse_matrix.h.

◆ size_type

Size type of SparsityPattern.

Definition at line 138 of file sparsity_pattern.h.

Constructor & Destructor Documentation

◆ Accessor() [1/2]

template<typename number >
SparseMatrixIterators::Accessor< number, false >::Accessor ( MatrixType matrix,
const std::size_t  index 


◆ Accessor() [2/2]

template<typename number >
SparseMatrixIterators::Accessor< number, false >::Accessor ( MatrixType matrix)

Constructor. Construct the end accessor for the given matrix.

Member Function Documentation

◆ value()

template<typename number >
Reference SparseMatrixIterators::Accessor< number, false >::value ( ) const

Value of this matrix entry, returned as a read- and writable reference.

◆ get_matrix()

template<typename number >
MatrixType & SparseMatrixIterators::Accessor< number, false >::get_matrix ( ) const

Return a reference to the matrix into which this accessor points. Note that in the present case, this is a non-constant reference.

◆ row()

size_type SparsityPatternIterators::Accessor::row ( ) const

Row number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

◆ index()

size_type SparsityPatternIterators::Accessor::index ( ) const

Index within the current row of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

◆ global_index()

size_type SparsityPatternIterators::Accessor::global_index ( ) const

This function returns the how-many'th entry within the entire sparsity pattern the current iterator points to. While the order of entries in a sparsity pattern is generally not important, this function allows indexing entries of the sparsity pattern using a linear index.

This function can only be called for entries for which is_valid_entry() is true.

◆ column()

size_type SparsityPatternIterators::Accessor::column ( ) const

Column number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.

◆ is_valid_entry()

bool SparsityPatternIterators::Accessor::is_valid_entry ( ) const

Return whether the sparsity pattern entry pointed to by this iterator is valid or not. Note that after compressing the sparsity pattern, all entries are valid. However, before compression, the sparsity pattern allocated some memory to be used while still adding new nonzero entries; if you create iterators in this phase of the sparsity pattern's lifetime, you will iterate over elements that are not valid. If this is so, then this function will return false.

◆ operator==()

bool SparsityPatternIterators::Accessor::operator== ( const Accessor ) const

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

◆ operator<()

bool SparsityPatternIterators::Accessor::operator< ( const Accessor ) 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.

◆ advance()

void SparsityPatternIterators::Accessor::advance ( )

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

Friends And Related Symbol Documentation

◆ Iterator

template<typename number >
template<typename , bool >
friend class Iterator

Definition at line 311 of file sparse_matrix.h.

Member Data Documentation

◆ matrix

template<typename number >
MatrixType* SparseMatrixIterators::Accessor< number, false >::matrix

Pointer to the matrix we use.

Definition at line 302 of file sparse_matrix.h.

◆ container

const SparsityPattern* SparsityPatternIterators::Accessor::container

The sparsity pattern we operate on accessed.

Definition at line 229 of file sparsity_pattern.h.

◆ linear_index

std::size_t SparsityPatternIterators::Accessor::linear_index

Index in global sparsity pattern. This index represents the location the iterator/accessor points to within the array of the SparsityPattern class that stores the column numbers. It is also the index within the values array of a sparse matrix that stores the corresponding value of this site.

Definition at line 238 of file sparsity_pattern.h.

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