Reference documentation for deal.II version Git bef661081b 2019-09-23 12:55:27 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
ChunkSparseMatrixIterators::Accessor< number, false > Class Template Reference

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

Inheritance diagram for ChunkSparseMatrixIterators::Accessor< number, false >:
[legend]

Classes

class  Reference
 

Public Types

using MatrixType = 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)
 
Reference value () const
 
MatrixTypeget_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

MatrixTypematrix
 

Additional Inherited Members

- Protected Member Functions inherited from ChunkSparsityPatternIterators::Accessor
void advance ()
 
- Protected Attributes inherited from ChunkSparsityPatternIterators::Accessor
const ChunkSparsityPatternsparsity_pattern
 
SparsityPatternIterators::Accessor reduced_accessor
 
size_type chunk_row
 
size_type chunk_col
 

Detailed Description

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

Member Typedef Documentation

◆ MatrixType

template<typename number >
using ChunkSparseMatrixIterators::Accessor< number, false >::MatrixType = ChunkSparseMatrix<number>

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

Definition at line 242 of file chunk_sparse_matrix.h.

Constructor & Destructor Documentation

◆ Accessor() [1/2]

template<typename number >
ChunkSparseMatrixIterators::Accessor< number, false >::Accessor ( MatrixType matrix,
const unsigned int  row 
)

Constructor.

◆ Accessor() [2/2]

template<typename number >
ChunkSparseMatrixIterators::Accessor< number, false >::Accessor ( MatrixType matrix)

Constructor. Construct the end accessor for the given matrix.

Member Function Documentation

◆ value()

template<typename number >
Reference ChunkSparseMatrixIterators::Accessor< number, false >::value ( ) const

Value of this matrix entry, returned as a read- and writable reference.

◆ get_matrix()

template<typename number >
MatrixType& ChunkSparseMatrixIterators::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.

Member Data Documentation

◆ matrix

template<typename number >
MatrixType* ChunkSparseMatrixIterators::Accessor< number, false >::matrix
private

Pointer to the matrix we use.

Definition at line 271 of file chunk_sparse_matrix.h.


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