|
Blaze 3.9
|
Access proxy for upper unitriangular matrices. More...
#include <UniUpperProxy.h>
Inherits blaze::Proxy< UniUpperProxy< MT > >.
Public Types | |
| using | RepresentedType = ElementType_t<MT> |
| Type of the represented matrix element. | |
| using | ValueType |
| Value type of the represented complex element. | |
| using | value_type = ValueType |
| Value type of the represented complex element. | |
Public Member Functions | |
| template<typename T> | |
| const UniUpperProxy< MT > & | operator= (const T &value) const |
| Assignment to the accessed matrix element. | |
| template<typename T> | |
| const UniUpperProxy< MT > & | operator+= (const T &value) const |
| Addition assignment to the accessed matrix element. | |
| template<typename T> | |
| const UniUpperProxy< MT > & | operator-= (const T &value) const |
| Subtraction assignment to the accessed matrix element. | |
| template<typename T> | |
| const UniUpperProxy< MT > & | operator*= (const T &value) const |
| Multiplication assignment to the accessed matrix element. | |
| template<typename T> | |
| const UniUpperProxy< MT > & | operator/= (const T &value) const |
| Division assignment to the accessed matrix element. | |
| template<typename T> | |
| const UniUpperProxy< MT > & | operator%= (const T &value) const |
| Modulo assignment to the accessed matrix element. | |
Constructors | |
| UniUpperProxy (MT &matrix, size_t row, size_t column) | |
| Initialization constructor for a UniUpperProxy. | |
| UniUpperProxy (const UniUpperProxy &)=default | |
Destructor | |
Assignment operators | |
| const UniUpperProxy & | operator= (const UniUpperProxy &uup) const |
| Copy assignment operator for UniUpperProxy. | |
| template<typename T> | |
| const UniUpperProxy & | operator= (const T &value) const |
| template<typename T> | |
| const UniUpperProxy & | operator+= (const T &value) const |
| template<typename T> | |
| const UniUpperProxy & | operator-= (const T &value) const |
| template<typename T> | |
| const UniUpperProxy & | operator*= (const T &value) const |
| template<typename T> | |
| const UniUpperProxy & | operator/= (const T &value) const |
| template<typename T> | |
| const UniUpperProxy & | operator%= (const T &value) const |
Access operators | |
| const UniUpperProxy * | operator-> () const noexcept |
| Direct access to the accessed matrix element. | |
Utility functions | |
| void | invert () const |
| In-place inversion of the represented element. | |
| RepresentedType | get () const noexcept |
| Returning the value of the accessed matrix element. | |
| bool | isRestricted () const noexcept |
| Returns whether the proxy represents a restricted matrix element.. | |
Conversion operator | |
| operator RepresentedType () const noexcept | |
| Conversion to the accessed matrix element. | |
Complex data access functions | |
| ValueType | real () const |
| Returns the real part of the represented complex number. | |
| void | real (ValueType value) const |
| Setting the real part of the represented complex number. | |
| ValueType | imag () const |
| Returns the imaginary part of the represented complex number. | |
| void | imag (ValueType value) const |
| Setting the imaginary part of the represented complex number. | |
Private Types | |
| using | ReferenceType = typename MT::Reference |
| Reference type of the underlying matrix type. | |
Private Attributes | |
Member variables | |
| ReferenceType | value_ |
| Reference to the accessed matrix element. | |
| size_t | row_ |
| Row index of the accessed matrix element. | |
| size_t | column_ |
| Column index of the accessed matrix element. | |
Access proxy for upper unitriangular matrices.
The UniUpperProxy provides controlled access to the elements of a non-const upper unitriangular matrix. It guarantees that the uniupper matrix invariant is not violated, i.e. that elements in the lower part of the matrix remain 0 and the diagonal elements remain 1. The following example illustrates this by means of a 
| using blaze::UniUpperProxy< MT >::ValueType |
Value type of the represented complex element.
|
inline |
Initialization constructor for a UniUpperProxy.
| matrix | Reference to the adapted matrix. |
| row | The row-index of the accessed matrix element. |
| column | The column-index of the accessed matrix element. |
|
inlinenoexcept |
Returning the value of the accessed matrix element.
|
inline |
Returns the imaginary part of the represented complex number.
In case the proxy represents a complex number, this function returns the current value of its imaginary part.
|
inline |
Setting the imaginary part of the represented complex number.
| value | The new value for the imaginary part. |
| std::invalid_argument | Invalid setting for diagonal or lower matrix element. |
In case the proxy represents a complex number, this function sets a new value to its imaginary part. In case the represented value is a diagonal element or an element in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
In-place inversion of the represented element.
| std::invalid_argument | Invalid inversion of upper matrix element. |
In case the proxy represents a lower element, a std::invalid_argument exception is thrown.
|
inlinenoexcept |
Returns whether the proxy represents a restricted matrix element..
|
inlinenoexcept |
Conversion to the accessed matrix element.
|
inline |
Modulo assignment to the accessed matrix element.
| value | The right-hand side value for the modulo operation. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
Multiplication assignment to the accessed matrix element.
| value | The right-hand side value for the multiplication. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
Addition assignment to the accessed matrix element.
| value | The right-hand side value to be added to the matrix element. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
Subtraction assignment to the accessed matrix element.
| value | The right-hand side value to be subtracted from the matrix element. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inlinenoexcept |
Direct access to the accessed matrix element.
|
inline |
Division assignment to the accessed matrix element.
| value | The right-hand side value for the division. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
Assignment to the accessed matrix element.
| value | The new value of the matrix element. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
Copy assignment operator for UniUpperProxy.
| uup | Proxy to be copied. |
| std::invalid_argument | Invalid assignment to diagonal or lower matrix element. |
In case the proxy represents an element on the diagonal or in the lower part of the matrix, a std::invalid_argument exception is thrown.
|
inline |
Returns the real part of the represented complex number.
In case the proxy represents a complex number, this function returns the current value of its real part.
|
inline |
Setting the real part of the represented complex number.
| value | The new value for the real part. |
| std::invalid_argument | Invalid setting for diagonal or lower matrix element. |
In case the proxy represents a complex number, this function sets a new value to its real part. In case the represented value is a diagonal element or an element in the lower part of the matrix, a std::invalid_argument exception is thrown.