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

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

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

Public Types
using	size_type = types::global_dof_index

Public Member Functions
number	value () const
number &	value ()
const ChunkSparseMatrix< number > &	get_matrix () const
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

Protected Member Functions
void	advance ()

Protected Attributes
const ChunkSparsityPattern *	sparsity_pattern
SparsityPatternIterators::Accessor	reduced_accessor
size_type	chunk_row
size_type	chunk_col

Detailed Description

template<typename number, bool Constness>
class ChunkSparseMatrixIterators::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 69 of file chunk_sparse_matrix.h.

Member Typedef Documentation

size_type

using ChunkSparsityPatternIterators::Accessor::size_type = types::global_dof_index

inherited

Declare the type for container size.

Definition at line 69 of file chunk_sparsity_pattern.h.

Member Function Documentation

value() [1/2]

template<typename number , bool Constness>

number ChunkSparseMatrixIterators::Accessor< number, Constness >::value

(

)

const

Value of this matrix entry.

value() [2/2]

template<typename number , bool Constness>

number & ChunkSparseMatrixIterators::Accessor< number, Constness >::value

(

)

Value of this matrix entry.

get_matrix()

template<typename number , bool Constness>

const ChunkSparseMatrix< number > & ChunkSparseMatrixIterators::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 ChunkSparsityPatternIterators::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.

reduced_index()

std::size_t ChunkSparsityPatternIterators::Accessor::reduced_index ( ) const

inherited

Return the global index from the reduced sparsity pattern.

column()

size_type ChunkSparsityPatternIterators::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 ChunkSparsityPatternIterators::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 ChunkSparsityPatternIterators::Accessor::operator== ( const Accessor &  ) const

inherited

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

operator<()

bool ChunkSparsityPatternIterators::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.

advance()

void ChunkSparsityPatternIterators::Accessor::advance ( )

protectedinherited

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

Member Data Documentation

sparsity_pattern

const ChunkSparsityPattern* ChunkSparsityPatternIterators::Accessor::sparsity_pattern

protectedinherited

The sparsity pattern we operate on accessed.

Definition at line 135 of file chunk_sparsity_pattern.h.

reduced_accessor

SparsityPatternIterators::Accessor ChunkSparsityPatternIterators::Accessor::reduced_accessor

protectedinherited

The accessor of the (reduced) sparsity pattern.

Definition at line 140 of file chunk_sparsity_pattern.h.

chunk_row

size_type ChunkSparsityPatternIterators::Accessor::chunk_row

protectedinherited

Current chunk row number.

Definition at line 145 of file chunk_sparsity_pattern.h.

chunk_col

size_type ChunkSparsityPatternIterators::Accessor::chunk_col

protectedinherited

Current chunk col number.

Definition at line 150 of file chunk_sparsity_pattern.h.

---

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

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