 |
deal.II version GIT relicensing-2289-g1e5549a87a 2024-12-21 21:30:00+00:00
|
Loading...
Searching...
No Matches
|
deal.II version GIT relicensing-2289-g1e5549a87a 2024-12-21 21:30:00+00:00
|
#include <deal.II/lac/sparse_matrix.h>
Classes | |
| class | Reference |
Public Types | |
| using | MatrixType = SparseMatrix< number > |
| 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 |
| 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 |
Protected Member Functions | |
| void | advance () |
Static Protected Member Functions | |
| static ::ExceptionBase & | DummyAccessor () |
Protected Attributes | |
| const SparsityPattern * | container |
| std::size_t | linear_index |
Private Attributes | |
| MatrixType * | matrix |
Friends | |
| template<typename , bool > | |
| class | Iterator |
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 189 of file sparse_matrix.h.
| using SparseMatrixIterators::Accessor< number, false >::MatrixType = SparseMatrix<number> |
Typedef for the type (including constness) of the matrix to be used here.
Definition at line 273 of file sparse_matrix.h.
Size type of SparsityPattern.
Definition at line 138 of file sparsity_pattern.h.
| SparseMatrixIterators::Accessor< number, false >::Accessor | ( | MatrixType * | matrix, |
| const std::size_t | index | ||
| ) |
Constructor.
| SparseMatrixIterators::Accessor< number, false >::Accessor | ( | MatrixType * | matrix | ) |
Constructor. Construct the end accessor for the given matrix.
| Reference SparseMatrixIterators::Accessor< number, false >::value | ( | ) | const |
Value of this matrix entry, returned as a read- and writable reference.
| 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.
|
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.
|
inherited |
Index within the current row of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.
|
inherited |
This function returns the how-many'th entry within the entire sparsity pattern the current iterator points to. While the order of entries in a sparsity pattern is generally not important, this function allows indexing entries of the sparsity pattern using a linear index.
This function can only be called for entries for which is_valid_entry() is true.
|
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.
|
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.
Comparison. True, if both iterators point to the same matrix position.
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.
|
protectedinherited |
Move the accessor to the next nonzero entry in the matrix.
Definition at line 311 of file sparse_matrix.h.
|
private |
Pointer to the matrix we use.
Definition at line 302 of file sparse_matrix.h.
|
protectedinherited |
The sparsity pattern we operate on accessed.
Definition at line 229 of file sparsity_pattern.h.
|
protectedinherited |
Index in global sparsity pattern. This index represents the location the iterator/accessor points to within the array of the SparsityPattern class that stores the column numbers. It is also the index within the values array of a sparse matrix that stores the corresponding value of this site.
Definition at line 238 of file sparsity_pattern.h.
1.9.8