![]() |
Reference documentation for deal.II version 8.1.0
|
#include <sparsity_pattern.h>
Public Member Functions | |
Iterator (const SparsityPattern *sp, const size_type row, const size_type index) DEAL_II_DEPRECATED | |
Iterator (const SparsityPattern *sp, const std::size_t index_within_sparsity) | |
Iterator & | operator++ () |
Iterator | operator++ (int) |
const Accessor & | operator* () const |
const Accessor * | operator-> () const |
bool | operator== (const Iterator &) const |
bool | operator!= (const Iterator &) const |
bool | operator< (const Iterator &) const |
int | operator- (const Iterator &p) const |
Private Attributes | |
Accessor | accessor |
STL conforming iterator walking over the elements of a sparsity pattern.
The typical use for these iterators is to iterate over the elements of a sparsity pattern (or, since they also serve as the basis for iterating over the elements of an associated matrix, over the elements of a sparse matrix) or over the elements of individual rows. Note that there is no guarantee that the elements of a row are actually traversed in an order in which columns monotonically increase. See the documentation of the SparsityPattern class for more information.
Definition at line 244 of file sparsity_pattern.h.
SparsityPatternIterators::Iterator::Iterator | ( | const SparsityPattern * | sp, |
const size_type | row, | ||
const size_type | index | ||
) |
Constructor. Create an iterator into the sparsity pattern sp
for the given row and the index within it.
SparsityPatternIterators::Iterator::Iterator | ( | const SparsityPattern * | sp, |
const std::size_t | index_within_sparsity | ||
) |
Constructor. Create an iterator into the sparsity pattern sp
for the given global index (i.e., the index of the given element counting from the zeroth row).
Iterator& SparsityPatternIterators::Iterator::operator++ | ( | ) |
Prefix increment.
const Accessor& SparsityPatternIterators::Iterator::operator* | ( | ) | const |
Dereferencing operator.
const Accessor* SparsityPatternIterators::Iterator::operator-> | ( | ) | const |
Dereferencing operator.
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 matrix.
Return the distance between the current iterator and the argument. The distance is given by how many times one has to apply operator++ to the current iterator to get the argument (for a positive return value), or operator-- (for a negative return value).
|
private |
Store an object of the accessor class.
Definition at line 317 of file sparsity_pattern.h.