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

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

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

Public Types
using	MatrixType = const ChunkSparseMatrix< number >
Public Types inherited from ChunkSparsityPatternIterators::Accessor
using	size_type = types::global_dof_index

Public Member Functions
	Accessor (MatrixType *matrix, const unsigned int row)
	Accessor (MatrixType *matrix)
	Accessor (const ChunkSparseMatrixIterators::Accessor< number, false > &a)
number	value () const
const MatrixType &	get_matrix () const
Public Member Functions inherited from ChunkSparsityPatternIterators::Accessor
	Accessor (const ChunkSparsityPattern *matrix, const size_type row)
	Accessor (const ChunkSparsityPattern *matrix)
size_type	row () const
std::size_t	reduced_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 ChunkSparsityPatternIterators::Accessor
void	advance ()
Protected Attributes inherited from ChunkSparsityPatternIterators::Accessor
const ChunkSparsityPattern *	sparsity_pattern
SparsityPatternIterators::Accessor	reduced_accessor
size_type	chunk_row
size_type	chunk_col

Detailed Description

template<typename number>
class ChunkSparseMatrixIterators::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 96 of file chunk_sparse_matrix.h.

Member Typedef Documentation

MatrixType

template<typename number >

using ChunkSparseMatrixIterators::Accessor< number, true >::MatrixType = const ChunkSparseMatrix<number>

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

Definition at line 103 of file chunk_sparse_matrix.h.

Constructor & Destructor Documentation

Accessor() [1/3]

template<typename number >

ChunkSparseMatrixIterators::Accessor< number, true >::Accessor	(	MatrixType *	matrix,
		const unsigned int	row
	)

Constructor.

Accessor() [2/3]

template<typename number >

ChunkSparseMatrixIterators::Accessor< number, true >::Accessor

(

MatrixType *

matrix

)

Constructor. Construct the end accessor for the given matrix.

Accessor() [3/3]

template<typename number >

ChunkSparseMatrixIterators::Accessor< number, true >::Accessor

(

const ChunkSparseMatrixIterators::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 ChunkSparseMatrixIterators::Accessor< number, true >::value

(

)

const

Value of this matrix entry.

get_matrix()

template<typename number >

const MatrixType& ChunkSparseMatrixIterators::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

Make iterator class a friend.

Mark all other instances of this template as friends.

Definition at line 148 of file chunk_sparse_matrix.h.

Member Data Documentation

matrix

template<typename number >

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

private

Pointer to the matrix we use.

Definition at line 137 of file chunk_sparse_matrix.h.

---

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

• deal.II/lac/chunk_sparse_matrix.h