SparseMatrixIterators::Accessor< number, false > Class Template Reference

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

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

Classes
class	Reference

Public Types
using	MatrixType = SparseMatrix< number >
Public Types inherited from SparsityPatternIterators::Accessor
using	size_type = SparsityPatternIterators::size_type

Public Member Functions
	Accessor (MatrixType *matrix, const std::size_t index)
	Accessor (MatrixType *matrix)
Reference	value () const
MatrixType &	get_matrix () const
Public Member Functions inherited from SparsityPatternIterators::Accessor
	Accessor (const SparsityPatternBase *matrix, const std::size_t linear_index)
	Accessor (const SparsityPatternBase *matrix)
	Accessor ()
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

Private Attributes
MatrixType *	matrix

Friends
template<typename , bool >
class	Iterator

Additional Inherited Members
Protected Member Functions inherited from SparsityPatternIterators::Accessor
void	advance ()
Static Protected Member Functions inherited from SparsityPatternIterators::Accessor
static ::ExceptionBase &	DummyAccessor ()
Protected Attributes inherited from SparsityPatternIterators::Accessor
const SparsityPatternBase *	container
std::size_t	linear_index

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 192 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 276 of file sparse_matrix.h.

Constructor & Destructor Documentation

Accessor() [1/2]

template<typename number >

SparseMatrixIterators::Accessor< number, false >::Accessor	(	MatrixType *	matrix,
		const std::size_t	index
	)

Constructor.

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.

Friends And Related Function Documentation

Iterator

template<typename number >

template<typename , bool >

friend class Iterator

friend

Definition at line 314 of file sparse_matrix.h.

Member Data Documentation

matrix

template<typename number >

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

private

Pointer to the matrix we use.

Definition at line 305 of file sparse_matrix.h.

---

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

• include/deal.II/lac/sparse_matrix.h