Public Types | |
using | size_type |
Public Member Functions | |
Reference (const Accessor *accessor, const bool dummy) | |
operator number () const | |
const Reference & | operator= (const number n) const |
const Reference & | operator+= (const number n) const |
const Reference & | operator-= (const number n) const |
const Reference & | operator*= (const number n) const |
const Reference & | operator/= (const number n) const |
number | value () const |
number & | value () |
const ChunkSparseMatrix< number > & | get_matrix () const |
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 |
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 |
Private Attributes | |
const Accessor * | accessor |
Reference class. This is what the accessor class returns when you call the value() function. The reference acts just as if it were a reference to the actual value of a matrix entry, i.e. you can read and write it, you can add and multiply to it, etc, but since the matrix does not give away the address of this matrix entry, we have to go through functions to do all this.
The constructor takes a pointer to an accessor object that describes which element of the matrix it points to. This creates an ambiguity when one writes code like iterator->value()=0 (instead of iterator->value()=0.0), since the right hand side is an integer that can both be converted to a number
(i.e., most commonly a double) or to another object of type Reference
. The compiler then complains about not knowing which conversion to take.
For some reason, adding another overload operator=(int) doesn't seem to cure the problem. We avoid it, however, by adding a second, dummy argument to the Reference constructor, that is unused, but makes sure there is no second matching conversion sequence using a one-argument right hand side.
Definition at line 186 of file chunk_sparse_matrix.h.
Declare the type for container size.
Definition at line 68 of file chunk_sparsity_pattern.h.
ChunkSparseMatrixIterators::Accessor< number, false >::Reference::Reference | ( | const Accessor< number, false > * | accessor, |
const bool | dummy ) |
Constructor. For the second argument, see the general class documentation.
ChunkSparseMatrixIterators::Accessor< number, false >::Reference::operator number | ( | ) | const |
Conversion operator to the data type of the matrix.
const Reference & ChunkSparseMatrixIterators::Accessor< number, false >::Reference::operator= | ( | const number | n | ) | const |
Set the element of the matrix we presently point to to n
.
const Reference & ChunkSparseMatrixIterators::Accessor< number, false >::Reference::operator+= | ( | const number | n | ) | const |
Add n
to the element of the matrix we presently point to.
const Reference & ChunkSparseMatrixIterators::Accessor< number, false >::Reference::operator-= | ( | const number | n | ) | const |
Subtract n
from the element of the matrix we presently point to.
const Reference & ChunkSparseMatrixIterators::Accessor< number, false >::Reference::operator*= | ( | const number | n | ) | const |
Multiply the element of the matrix we presently point to by n
.
const Reference & ChunkSparseMatrixIterators::Accessor< number, false >::Reference::operator/= | ( | const number | n | ) | const |
Divide the element of the matrix we presently point to by n
.
number ChunkSparseMatrixIterators::Accessor< number, Constness >::value | ( | ) | const |
Value of this matrix entry.
number & ChunkSparseMatrixIterators::Accessor< number, Constness >::value | ( | ) |
Value of this matrix entry.
const ChunkSparseMatrix< number > & ChunkSparseMatrixIterators::Accessor< number, Constness >::get_matrix | ( | ) | const |
Return a reference to the matrix into which this accessor points. Note that in the present case, this is a constant reference.
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.
bool ChunkSparsityPatternIterators::Accessor::operator== | ( | const Accessor< number, false > & | ) | const |
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.
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.
|
private |
Pointer to the accessor that denotes which element we presently point to.
Definition at line 235 of file chunk_sparse_matrix.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.