Reference documentation for deal.II version 9.3.3
\(\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\}}\)
Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
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
 

Protected Member Functions

void advance ()
 

Static Protected Member Functions

static ::ExceptionBase & DummyAccessor ()
 

Protected Attributes

const SparsityPatternBase * container
 
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 99 of file sparse_matrix.h.

Member Function Documentation

◆ 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< number > & 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.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.4