Representation of two synchronized values within a sparse symmetric matrix.
More...
#include <SymmetricValue.h >
Inherits blaze::Proxy< SymmetricValue< MT > > .
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.
using IteratorType = typename MT::Iterator
Type of the underlying sparse matrix iterators.
IteratorType pos_
Iterator to the current sparse symmetric matrix element.
MT * matrix_
The sparse matrix containing the iterator.
size_t index_
The row/column index of the iterator.
void invert () const
In-place inversion of the symmetric value.
RepresentedType get () const noexcept
Access to the represented value.
void sync () const
Synchronization of the current sparse element to the according paired element.
template<typename MT>
class blaze::SymmetricValue< MT >
Representation of two synchronized values within a sparse symmetric matrix.
The SymmetricValue class represents two synchronized values within a sparse symmetric matrix. It guarantees that a modification of value via iterator is also applied to the value . The following example illustrates this by means of a sparse symmetric matrix:
Symmetric A( 3UL );
A(0,2) = -2;
A(1,1) = 3;
A(1,2) = 5;
Symmetric::Iterator it = A.begin( 2UL );
it->value() = 4;
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.
◆ SymmetricValue()
Constructor for the SymmetricValue class.
Parameters
pos The initial position of the iterator.
matrix The sparse matrix containing the iterator.
index The row/column index of the iterator.
◆ get()
Access to the represented value.
Returns Copy of the represented value.
◆ 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 value 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 symmetric value.
Returns void
◆ operator RepresentedType()
Conversion to the represented value.
Returns Copy of the represented value.
◆ operator*=()
template<typename MT>
template<typename T>
Multiplication assignment to the symmetric value.
Parameters
value The right-hand side value for the multiplication.
Returns Reference to the assigned symmetric value.
◆ operator+=()
template<typename MT>
template<typename T>
Addition assignment to the symmetric value.
Parameters
value The right-hand side value to be added to the symmetric value.
Returns Reference to the assigned symmetric value.
Exceptions
std::invalid_argument Invalid assignment to diagonal matrix element.
◆ operator-=()
template<typename MT>
template<typename T>
Subtraction assignment to the symmetric value.
Parameters
value The right-hand side value to be subtracted from the symmetric value.
Returns Reference to the assigned symmetric value.
◆ operator/=()
template<typename MT>
template<typename T>
Division assignment to the symmetric value.
Parameters
value The right-hand side value for the division.
Returns Reference to the assigned symmetric value.
◆ operator=() [1/2]
Copy assignment operator for SymmetricValue .
Parameters
sv The symmetric value to be copied.
Returns Reference to the assigned symmetric value.
◆ operator=() [2/2]
template<typename MT>
template<typename T>
Assignment to the symmetric value.
Parameters
value The new value of the symmetric value.
Returns Reference to the assigned symmetric value.
◆ 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 value 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 value represents a complex number, this function sets a new value to its real part.
◆ sync()
Synchronization of the current sparse element to the according paired element.
Returns void
The documentation for this class was generated from the following file: