![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/lac/chunk_sparsity_pattern.h>
Public Types | |
using | size_type = types::global_dof_index |
Public Member Functions | |
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 |
Protected Member Functions | |
void | advance () |
Protected Attributes | |
const ChunkSparsityPattern * | sparsity_pattern |
SparsityPatternIterators::Accessor | reduced_accessor |
size_type | chunk_row |
size_type | chunk_col |
Friends | |
class | Iterator |
Accessor class for iterators into sparsity patterns. This class is also the base class for both const and non-const accessor classes into sparse matrices.
Note that this class only allows read access to elements, providing their row and column number. It does not allow modifying the sparsity pattern itself.
Definition at line 62 of file chunk_sparsity_pattern.h.
Declare the type for container size.
Definition at line 68 of file chunk_sparsity_pattern.h.
ChunkSparsityPatternIterators::Accessor::Accessor | ( | const ChunkSparsityPattern * | matrix, |
const size_type | row ) |
Constructor.
ChunkSparsityPatternIterators::Accessor::Accessor | ( | const ChunkSparsityPattern * | matrix | ) |
Constructor. Construct the end accessor for the given sparsity pattern.
size_type ChunkSparsityPatternIterators::Accessor::row | ( | ) | const |
Row number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.
std::size_t ChunkSparsityPatternIterators::Accessor::reduced_index | ( | ) | const |
Return the global index from the reduced sparsity pattern.
size_type ChunkSparsityPatternIterators::Accessor::column | ( | ) | const |
Column number of the element represented by this object. This function can only be called for entries for which is_valid_entry() is true.
bool ChunkSparsityPatternIterators::Accessor::is_valid_entry | ( | ) | const |
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.
|
protected |
Move the accessor to the next nonzero entry in the matrix.
|
friend |
Definition at line 158 of file chunk_sparsity_pattern.h.
|
protected |
The sparsity pattern we operate on accessed.
Definition at line 134 of file chunk_sparsity_pattern.h.
|
protected |
The accessor of the (reduced) sparsity pattern.
Definition at line 139 of file chunk_sparsity_pattern.h.
|
protected |
Current chunk row number.
Definition at line 144 of file chunk_sparsity_pattern.h.
|
protected |
Current chunk col number.
Definition at line 149 of file chunk_sparsity_pattern.h.