Representation of an element within a sparse lower unitriangular matrix.
More...
#include <UniLowerElement.h >
Inherits blaze::SparseElement .
using ElementType = ElementType_t <MT>
Type of the represented matrix element.
using IteratorType = Iterator_t <MT>
Type of the underlying sparse matrix iterators.
IteratorType pos_
Iterator to the current lower unitriangular matrix element.
bool diagonal_
true in case the element is on the diagonal, false if not.
Reference value () const
Access to the current value of the unilower element.
IndexType index () const
Access to the current index of the unilower element.
template<typename MT>
class blaze::UniLowerElement< MT >
Representation of an element within a sparse lower unitriangular matrix.
The UniLowerElement class represents an element (i.e. value/index pair) within a sparse lower unitriangular matrix. It guarantees that the unilower matrix invariant is not violated, i.e. that elements in the upper part of the matrix remain 0 and the diagonal elements remain 1. The following example illustrates this by means of a sparse lower unitriangular matrix:
UniLower A( 3UL );
A(1,0) = -2;
A(2,0) = 3;
A(2,1) = 5;
UniLower::Iterator it = A.begin( 1UL );
*it = 4;
++it;
*it = 9;
Matrix adapter for lower unitriangular matrices.
Definition BaseTemplate.h:582
◆ UniLowerElement()
Constructor for the UniLowerElement class.
Parameters
pos Iterator to the current position with the sparse lower unitriangular matrix.
diagonal true in case the element is on the diagonal, false if not.
◆ index()
Access to the current index of the unilower element.
Returns The current index of the unilower element.
◆ operator*=()
template<typename MT>
template<typename T>
Multiplication assignment to the unilower element.
Parameters
v The right-hand side value for the multiplication.
Returns Reference to the assigned unilower element.
Exceptions
std::invalid_argument Invalid assignment to diagonal matrix element.
◆ operator+=()
template<typename MT>
template<typename T>
Addition assignment to the unilower element.
Parameters
v The right-hand side value for the addition.
Returns Reference to the assigned unilower element.
Exceptions
std::invalid_argument Invalid assignment to diagonal matrix element.
◆ operator-=()
template<typename MT>
template<typename T>
Subtraction assignment to the unilower element.
Parameters
v The right-hand side value for the subtraction.
Returns Reference to the assigned unilower element.
Exceptions
std::invalid_argument Invalid assignment to diagonal matrix element.
◆ operator->()
Direct access to the unilower element.
Returns Reference to the value of the unilower element.
◆ operator/=()
template<typename MT>
template<typename T>
Division assignment to the unilower element.
Parameters
v The right-hand side value for the division.
Returns Reference to the assigned unilower element.
Exceptions
std::invalid_argument Invalid assignment to diagonal matrix element.
◆ operator=()
template<typename MT>
template<typename T>
Assignment to the unilower element.
Parameters
v The new value of the unilower element.
Returns Reference to the assigned unilower element.
Exceptions
std::invalid_argument Invalid assignment to diagonal matrix element.
◆ value()
Access to the current value of the unilower element.
Returns The current value of the unilower element.
The documentation for this class was generated from the following file: