Public Types | Public Member Functions | Private Attributes | List of all members
blaze::UniUpperValue< MT > Class Template Reference

Representation of a value within a sparse upper unitriangular matrix.The UniUpperValue class represents a single value within a sparse upper unitriangular matrix. It guarantees that the uniupper 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 $ 3 \times 3 $ sparse upper unitriangular matrix: More...

#include <UniUpperValue.h>

Inherits blaze::Proxy< UniUpperValue< MT > >.

Public Types

typedef ElementType_< MT > RepresentedType
 Type of the represented matrix element.
 
typedef If_< IsComplex< RepresentedType >, ComplexType< RepresentedType >, BuiltinType< RepresentedType > >::Type ValueType
 Value type of the represented complex element.
 
typedef ValueType value_type
 Value type of the represented complex element.
 

Public Member Functions

template<typename T >
UniUpperValue< MT > & operator= (const T &value)
 Assignment to the uniupper value. More...
 
template<typename T >
UniUpperValue< MT > & operator+= (const T &value)
 Addition assignment to the uniupper value. More...
 
template<typename T >
UniUpperValue< MT > & operator-= (const T &value)
 Subtraction assignment to the uniupper value. More...
 
template<typename T >
UniUpperValue< MT > & operator*= (const T &value)
 Multiplication assignment to the uniupper value. More...
 
template<typename T >
UniUpperValue< MT > & operator/= (const T &value)
 Division assignment to the uniupper value. More...
 
Constructors
 UniUpperValue (RepresentedType &value, bool diagonal)
 Constructor for the UniUpperValue class. More...
 
Assignment operators
UniUpperValueoperator= (const UniUpperValue &uuv)
 Copy assignment operator for UniUpperValue. More...
 
template<typename T >
UniUpperValueoperator= (const T &value)
 
template<typename T >
UniUpperValueoperator+= (const T &value)
 
template<typename T >
UniUpperValueoperator-= (const T &value)
 
template<typename T >
UniUpperValueoperator*= (const T &value)
 
template<typename T >
UniUpperValueoperator/= (const T &value)
 
Utility functions
void reset () const
 Reset the uniupper value to its default initial value. More...
 
void clear () const
 Clearing the uniupper value. More...
 
void invert () const
 In-place inversion of the uniupper value. More...
 
RepresentedType get () const noexcept
 Access to the represented value. More...
 
bool isRestricted () const noexcept
 Returns whether the value represents a restricted matrix element.. More...
 
Conversion operator
 operator RepresentedType () const noexcept
 Conversion to the represented value. More...
 
Complex data access functions
ValueType real () const
 Returns the real part of the represented complex number. More...
 
void real (ValueType value) const
 Setting the real part of the represented complex number. More...
 
ValueType imag () const
 Returns the imaginary part of the represented complex number. More...
 
void imag (ValueType value) const
 Setting the imaginary part of the represented complex number. More...
 

Private Attributes

RepresentedTypevalue_
 The represented value.
 
bool diagonal_
 true in case the element is on the diagonal, false if not.
 

Detailed Description

template<typename MT>
class blaze::UniUpperValue< MT >

Representation of a value within a sparse upper unitriangular matrix.

The UniUpperValue class represents a single value within a sparse upper unitriangular matrix. It guarantees that the uniupper 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 $ 3 \times 3 $ sparse upper unitriangular matrix:

// Creating a 3x3 upper unitriangular sparse matrix
UniUpper A( 3UL );
A(0,1) = -2; // ( 1 -2 3 )
A(0,2) = 3; // => A = ( 0 1 5 )
A(1,2) = 5; // ( 0 0 1 )
UniUpper::Iterator it = A.begin( 1UL );
it->value() = 9; // Invalid assignment to diagonal matrix element; results in an exception!
++it;
it->value() = 4; // Modification of matrix element (1,2)

Constructor & Destructor Documentation

template<typename MT >
blaze::UniUpperValue< MT >::UniUpperValue ( RepresentedType value,
bool  diagonal 
)
inline

Constructor for the UniUpperValue class.

Parameters
valueReference to the represented value.
diagonaltrue in case the element is on the diagonal, false if not.

Member Function Documentation

template<typename MT >
void blaze::UniUpperValue< MT >::clear ( ) const
inline

Clearing the uniupper value.

Returns
void

This function clears the uniupper value to its default initial state.

template<typename MT >
UniUpperValue< MT >::RepresentedType blaze::UniUpperValue< MT >::get ( ) const
inlinenoexcept

Access to the represented value.

Returns
Copy of the represented value.
template<typename MT >
UniUpperValue< MT >::ValueType blaze::UniUpperValue< MT >::imag ( ) const
inline

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.

template<typename MT >
void blaze::UniUpperValue< MT >::imag ( ValueType  value) const
inline

Setting the imaginary part of the represented complex number.

Parameters
valueThe new value for the imaginary part.
Returns
void
Exceptions
std::invalid_argumentInvalid setting for diagonal matrix element.

In case the proxy represents a complex number, this function sets a new value to its imaginary part. In case the proxy represents a diagonal element and the given value is not zero, a std::invalid_argument exception is thrown.

template<typename MT >
void blaze::UniUpperValue< MT >::invert ( ) const
inline

In-place inversion of the uniupper value.

Returns
void
template<typename MT >
bool blaze::UniUpperValue< MT >::isRestricted ( ) const
inlinenoexcept

Returns whether the value represents a restricted matrix element..

Returns
true in case access to the matrix element is restricted, false if not.
template<typename MT >
blaze::UniUpperValue< MT >::operator RepresentedType ( ) const
inlinenoexcept

Conversion to the represented value.

Returns
Copy of the represented value.
template<typename MT>
template<typename T >
UniUpperValue<MT>& blaze::UniUpperValue< MT >::operator*= ( const T &  value)
inline

Multiplication assignment to the uniupper value.

Parameters
valueThe right-hand side value for the multiplication.
Returns
Reference to the assigned uniupper value.
Exceptions
std::invalid_argumentInvalid assignment to diagonal matrix element.
template<typename MT>
template<typename T >
UniUpperValue<MT>& blaze::UniUpperValue< MT >::operator+= ( const T &  value)
inline

Addition assignment to the uniupper value.

Parameters
valueThe right-hand side value to be added to the uniupper value.
Returns
Reference to the assigned uniupper value.
Exceptions
std::invalid_argumentInvalid assignment to diagonal matrix element.
template<typename MT>
template<typename T >
UniUpperValue<MT>& blaze::UniUpperValue< MT >::operator-= ( const T &  value)
inline

Subtraction assignment to the uniupper value.

Parameters
valueThe right-hand side value to be subtracted from the uniupper value.
Returns
Reference to the assigned uniupper value.
Exceptions
std::invalid_argumentInvalid assignment to diagonal matrix element.
template<typename MT>
template<typename T >
UniUpperValue<MT>& blaze::UniUpperValue< MT >::operator/= ( const T &  value)
inline

Division assignment to the uniupper value.

Parameters
valueThe right-hand side value for the division.
Returns
Reference to the assigned uniupper value.
Exceptions
std::invalid_argumentInvalid assignment to diagonal matrix element.
template<typename MT >
UniUpperValue< MT > & blaze::UniUpperValue< MT >::operator= ( const UniUpperValue< MT > &  uuv)
inline

Copy assignment operator for UniUpperValue.

Parameters
uuvThe uniupper value to be copied.
Returns
Reference to the assigned uniupper value.
Exceptions
std::invalid_argumentInvalid assignment to diagonal matrix element.
template<typename MT>
template<typename T >
UniUpperValue<MT>& blaze::UniUpperValue< MT >::operator= ( const T &  value)
inline

Assignment to the uniupper value.

Parameters
valueThe new value of the uniupper value.
Returns
Reference to the assigned uniupper value.
Exceptions
std::invalid_argumentInvalid assignment to diagonal matrix element.
template<typename MT >
UniUpperValue< MT >::ValueType blaze::UniUpperValue< MT >::real ( ) const
inline

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.

template<typename MT >
void blaze::UniUpperValue< MT >::real ( ValueType  value) const
inline

Setting the real part of the represented complex number.

Parameters
valueThe new value for the real part.
Returns
void
Exceptions
std::invalid_argumentInvalid setting for diagonal matrix element.

In case the proxy represents a complex number, this function sets a new value to its real part.

template<typename MT >
void blaze::UniUpperValue< MT >::reset ( ) const
inline

Reset the uniupper value to its default initial value.

Returns
void

This function resets the uniupper value to its default initial value.


The documentation for this class was generated from the following file: