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

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

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

Public Types
using	MatrixType = const 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_within_matrix)
	Accessor (MatrixType *matrix)
	Accessor (const SparseMatrixIterators::Accessor< number, false > &a)
number	value () const
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, true >

Accessor class for constant matrices, used in the const_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 131 of file sparse_matrix.h.

Member Typedef Documentation

MatrixType

template<typename number >

using SparseMatrixIterators::Accessor< number, true >::MatrixType = const SparseMatrix<number>

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

Definition at line 138 of file sparse_matrix.h.

Constructor & Destructor Documentation

Accessor() [1/3]

template<typename number >

SparseMatrixIterators::Accessor< number, true >::Accessor	(	MatrixType *	matrix,
		const std::size_t	index_within_matrix
	)

Constructor.

Accessor() [2/3]

template<typename number >

SparseMatrixIterators::Accessor< number, true >::Accessor

(

MatrixType *

matrix

)

Constructor. Construct the end accessor for the given matrix.

Accessor() [3/3]

template<typename number >

SparseMatrixIterators::Accessor< number, true >::Accessor

(

const SparseMatrixIterators::Accessor< number, false > &

a

)

Copy constructor to get from a non-const accessor to a const accessor.

Member Function Documentation

value()

template<typename number >

number SparseMatrixIterators::Accessor< number, true >::value

(

)

const

Value of this matrix entry.

get_matrix()

template<typename number >

const MatrixType& SparseMatrixIterators::Accessor< number, true >::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.

Friends And Related Function Documentation

Iterator

template<typename number >

template<typename , bool >

friend class Iterator

friend

Definition at line 181 of file sparse_matrix.h.

Member Data Documentation

matrix

template<typename number >

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

private

Pointer to the matrix we use.

Definition at line 172 of file sparse_matrix.h.

---

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

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