![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/lac/sparsity_pattern.h>
Public Types | |
using | size_type = SparsityPatternIterators::size_type |
Public Member Functions | |
Accessor (const SparsityPattern *matrix, const std::size_t linear_index) | |
Accessor (const SparsityPattern *matrix) | |
Accessor () | |
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 |
Friends | |
class | LinearIndexIterator< Iterator, Accessor > |
class | ChunkSparsityPatternIterators::Accessor |
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 (or alternatively the index within the complete sparsity pattern). It does not allow modifying the sparsity pattern itself.
Definition at line 132 of file sparsity_pattern.h.
Size type of SparsityPattern.
Definition at line 138 of file sparsity_pattern.h.
SparsityPatternIterators::Accessor::Accessor | ( | const SparsityPattern * | matrix, |
const std::size_t | linear_index ) |
Constructor.
SparsityPatternIterators::Accessor::Accessor | ( | const SparsityPattern * | matrix | ) |
Constructor. Construct the end accessor for the given sparsity pattern.
Default constructor creating a dummy accessor. This constructor is here only to be able to store accessors in STL containers such as std::vector
.
size_type SparsityPatternIterators::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.
size_type SparsityPatternIterators::Accessor::index | ( | ) | const |
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.
size_type SparsityPatternIterators::Accessor::global_index | ( | ) | const |
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.
size_type SparsityPatternIterators::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 SparsityPatternIterators::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 244 of file sparsity_pattern.h.
|
friend |
Definition at line 250 of file sparsity_pattern.h.
|
protected |
The sparsity pattern we operate on accessed.
Definition at line 229 of file sparsity_pattern.h.
|
protected |
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.