Reference documentation for deal.II version GIT b8135fa6eb 2023-03-25 15:55:02+00:00
SparseMatrixIterators::Accessor< number, Constness > Class Template Reference

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

Inheritance diagram for SparseMatrixIterators::Accessor< number, Constness >:
[legend]

## Public Types

using size_type = SparsityPatternIterators::size_type

## Public Member Functions

number value () const

number & value ()

const SparseMatrix< number > & get_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

## Static Protected Member Functions

static ::ExceptionBaseDummyAccessor ()

## Protected Attributes

const SparsityPatterncontainer

std::size_t linear_index

## Detailed Description

### template<typename number, bool Constness> class SparseMatrixIterators::Accessor< number, Constness >

General template for sparse matrix accessors. The first template argument denotes the underlying numeric type, the second the constness of the matrix.

The general template is not implemented, only the specializations for the two possible values of the second template argument. Therefore, the interface listed here only serves as a template provided since doxygen does not link the specializations.

Definition at line 97 of file sparse_matrix.h.

## ◆ size_type

 inherited

Size type of SparsityPattern.

Definition at line 139 of file sparsity_pattern.h.

## ◆ value() [1/2]

template<typename number , bool Constness>
 number SparseMatrixIterators::Accessor< number, Constness >::value ( ) const

Value of this matrix entry.

## ◆ value() [2/2]

template<typename number , bool Constness>
 number& SparseMatrixIterators::Accessor< number, Constness >::value ( )

Value of this matrix entry.

## ◆ get_matrix()

template<typename number , bool Constness>
 const SparseMatrix& SparseMatrixIterators::Accessor< number, Constness >::get_matrix ( ) const

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

## ◆ row()

 size_type SparsityPatternIterators::Accessor::row ( ) const
inherited

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
inherited

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
inherited

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
inherited

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
inherited

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
inherited

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

## ◆ operator<()

 bool SparsityPatternIterators::Accessor::operator< ( const Accessor & ) const
inherited

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.

protectedinherited

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

## ◆ container

 const SparsityPattern* SparsityPatternIterators::Accessor::container
protectedinherited

The sparsity pattern we operate on accessed.

Definition at line 230 of file sparsity_pattern.h.

## ◆ linear_index

 std::size_t SparsityPatternIterators::Accessor::linear_index
protectedinherited

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 239 of file sparsity_pattern.h.

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