Access proxy for symmetric, square matrices with scalar element types.
More...
#include <ScalarProxy.h >
Inherits blaze::Proxy< ScalarProxy< MT > > .
using RepresentedType = ElementType_t <MT>
Type of the represented matrix element.
using Reference = Reference_t <MT>
Reference to the represented element.
using ConstReference = ConstReference_t <MT>
Reference-to-const to the represented element.
using Pointer = ScalarProxy *
Pointer to the represented element.
using ConstPointer = const ScalarProxy *
Pointer-to-const to the represented element.
using ValueType
Value type of the represented complex element.
template<typename T>
ScalarProxy < MT > & operator= (const T &value)
Assignment to the accessed matrix element.
template<typename T>
ScalarProxy < MT > & operator+= (const T &value)
Addition assignment to the accessed matrix element.
template<typename T>
ScalarProxy < MT > & operator-= (const T &value)
Subtraction assignment to the accessed matrix element.
template<typename T>
ScalarProxy < MT > & operator*= (const T &value)
Multiplication assignment to the accessed matrix element.
template<typename T>
ScalarProxy < MT > & operator/= (const T &value)
Division assignment to the accessed matrix element.
template<typename T>
ScalarProxy < MT > & operator%= (const T &value)
Modulo assignment to the accessed matrix element.
ScalarProxy (MT &matrix, size_t row, size_t column)
Initialization constructor for a ScalarProxy .
ScalarProxy (const ScalarProxy &)=default
ScalarProxy & operator= (const ScalarProxy &sp)
Copy assignment operator for ScalarProxy .
template<typename T>
ScalarProxy & operator= (const T &value)
template<typename T>
ScalarProxy & operator+= (const T &value)
template<typename T>
ScalarProxy & operator-= (const T &value)
template<typename T>
ScalarProxy & operator*= (const T &value)
template<typename T>
ScalarProxy & operator/= (const T &value)
template<typename T>
ScalarProxy & operator%= (const T &value)
Pointer operator-> ()
Direct access to the represented matrix element.
ConstPointer operator-> () const
Direct access to the represented matrix element.
void invert () const
In-place inversion of the represented element.
ConstReference get () const noexcept
Returning the value of the accessed matrix element.
operator ConstReference () const noexcept
Conversion to the accessed matrix element.
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.
MT & matrix_
Reference to the adapted matrix.
size_t row_
Row index of the accessed matrix element.
size_t column_
Column index of the accessed matrix element.
template<typename MT>
class blaze::ScalarProxy< MT >
Access proxy for symmetric, square matrices with scalar element types.
The ScalarProxy provides controlled access to the elements of a non-const symmetric matrix with scalar element type (e.g. integral values, floating point values, and complex values). It guarantees that a modification of element of the accessed matrix is also applied to element . The following example illustrates this by means of a dense symmetric matrix:
A(0,2) = -2;
A(1,1) = 3;
A(1,2) = 5;
Matrix adapter for symmetric matrices.
Definition BaseTemplate.h:614
◆ ValueType
Initial value:
, ComplexType<RepresentedType>
, BuiltinType<RepresentedType> >
::Type
typename If< Condition >::template Type< T1, T2 > If_t
Auxiliary alias template for the If class template.
Definition If.h:108
Value type of the represented complex element.
◆ ScalarProxy()
Initialization constructor for a ScalarProxy .
Parameters
matrix Reference to the adapted matrix.
row The row-index of the accessed matrix element.
column The column-index of the accessed matrix element.
◆ get()
Returning the value of the accessed matrix element.
Returns Direct/raw reference to the accessed matrix element.
◆ imag() [1/2]
Returns the imaginary part of the represented complex number.
Returns The current 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.
◆ imag() [2/2]
Setting the imaginary part of the represented complex number.
Parameters
value The new value for the imaginary part.
Returns void
In case the proxy represents a complex number, this function sets a new value to its imaginary part.
◆ invert()
In-place inversion of the represented element.
Returns void
◆ operator ConstReference()
Conversion to the accessed matrix element.
Returns Direct/raw reference to the accessed matrix element.
◆ operator%=()
template<typename MT>
template<typename T>
Modulo assignment to the accessed matrix element.
Parameters
value The right-hand side value for the modulo operation.
Returns Reference to the assigned proxy.
◆ operator*=()
template<typename MT>
template<typename T>
Multiplication assignment to the accessed matrix element.
Parameters
value The right-hand side value for the multiplication.
Returns Reference to the assigned proxy.
◆ operator+=()
template<typename MT>
template<typename T>
Addition assignment to the accessed matrix element.
Parameters
value The right-hand side value to be added to the matrix element.
Returns Reference to the assigned proxy.
◆ operator-=()
template<typename MT>
template<typename T>
Subtraction assignment to the accessed matrix element.
Parameters
value The right-hand side value to be subtracted from the matrix element.
Returns Reference to the assigned proxy.
◆ operator->() [1/2]
Direct access to the represented matrix element.
Returns Pointer to the represented matrix element.
◆ operator->() [2/2]
Direct access to the represented matrix element.
Returns Pointer to the represented matrix element.
◆ operator/=()
template<typename MT>
template<typename T>
Division assignment to the accessed matrix element.
Parameters
value The right-hand side value for the division.
Returns Reference to the assigned proxy.
◆ operator=() [1/2]
Copy assignment operator for ScalarProxy .
Parameters
sp Scalar proxy to be copied.
Returns Reference to the assigned proxy.
◆ operator=() [2/2]
template<typename MT>
template<typename T>
Assignment to the accessed matrix element.
Parameters
value The new value of the matrix element.
Returns Reference to the assigned proxy.
◆ real() [1/2]
Returns the real part of the represented complex number.
Returns The current 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.
◆ real() [2/2]
Setting the real part of the represented complex number.
Parameters
value The new value for the real part.
Returns void
In case the proxy represents a complex number, this function sets a new value to its real part.
The documentation for this class was generated from the following file: