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

Expression object for the explicit diagonal declaration of sparse matrices.The SMatDeclDiagExpr class represents the compile time expression for the explicit diagonal declaration of a sparse matrix. More...

#include <SMatDeclDiagExpr.h>

Inherits blaze::DeclDiagExpr< SparseMatrix< SMatDeclDiagExpr< MT, SO >, SO > >, and blaze::Declaration< MT >.

Public Types

enum  : bool { smpAssignable = MT::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
using This = SMatDeclDiagExpr< MT, SO >
 Type of this SMatDeclDiagExpr instance.
 
using ResultType = DeclDiagTrait_< RT >
 Result type for expression template evaluations.
 
using OppositeType = OppositeType_< ResultType >
 Result type with opposite storage order for expression template evaluations.
 
using TransposeType = TransposeType_< ResultType >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_< MT >
 Resulting element type.
 
using ReturnType = ReturnType_< MT >
 Return type for expression template evaluations.
 
using CompositeType = If_< RequiresEvaluation< MT >, const ResultType, const SMatDeclDiagExpr &>
 Data type for composite expression templates.
 
using ConstIterator = typename GetConstIterator< MT >::Type
 Iterator over the elements of the dense matrix.
 
using Operand = If_< IsExpression< MT >, const MT, const MT &>
 Composite data type of the sparse matrix expression.
 
using MatrixType = SMatDeclDiagExpr< MT, SO >
 Type of the matrix.
 

Public Member Functions

 SMatDeclDiagExpr (const MT &sm) noexcept
 Constructor for the SMatDeclDiagExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
ReturnType at (size_t i, size_t j) const
 Checked access to the matrix elements. More...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row i. More...
 
size_t rows () const noexcept
 Returns the current number of rows of the matrix. More...
 
size_t columns () const noexcept
 Returns the current number of columns of the matrix. More...
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse matrix. More...
 
size_t nonZeros (size_t i) const
 Returns the number of non-zero elements in the specified row. More...
 
Operand operand () const noexcept
 Returns the sparse matrix operand. More...
 
template<typename T >
bool canAlias (const T *alias) const noexcept
 Returns whether the expression can alias with the given address alias. More...
 
template<typename T >
bool isAliased (const T *alias) const noexcept
 Returns whether the expression is aliased with the given address alias. More...
 
bool canSMPAssign () const noexcept
 Returns whether the expression can be used in SMP assignments. More...
 
BLAZE_ALWAYS_INLINE MatrixTypeoperator~ () noexcept
 Conversion operator for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE const MatrixTypeoperator~ () const noexcept
 Conversion operator for constant matrices. More...
 

Private Types

enum  : bool { useAssign = RequiresEvaluation<MT>::value }
 Compilation switch for the serial evaluation strategy of the diagonal declaration expression. More...
 
using RT = ResultType_< MT >
 Result type of the sparse matrix expression.
 

Private Attributes

Operand sm_
 Sparse matrix of the decldiag expression.
 

Detailed Description

template<typename MT, bool SO>
class blaze::SMatDeclDiagExpr< MT, SO >

Expression object for the explicit diagonal declaration of sparse matrices.

The SMatDeclDiagExpr class represents the compile time expression for the explicit diagonal declaration of a sparse matrix.

Member Enumeration Documentation

◆ anonymous enum

template<typename MT , bool SO>
anonymous enum : bool
private

Compilation switch for the serial evaluation strategy of the diagonal declaration expression.

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the diagonal declaration expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the diagonal declaration expression will be evaluated via the assign function family. Otherwise useAssign will be set to 0 and the expression will be evaluated via the subscript operator.

Constructor & Destructor Documentation

◆ SMatDeclDiagExpr()

template<typename MT , bool SO>
blaze::SMatDeclDiagExpr< MT, SO >::SMatDeclDiagExpr ( const MT &  sm)
inlineexplicitnoexcept

Constructor for the SMatDeclDiagExpr class.

Parameters
smThe sparse matrix operand of the decldiag expression.

Member Function Documentation

◆ at()

template<typename MT , bool SO>
ReturnType blaze::SMatDeclDiagExpr< MT, SO >::at ( size_t  i,
size_t  j 
) const
inline

Checked access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
Exceptions
std::out_of_rangeInvalid matrix access index.

◆ begin()

template<typename MT , bool SO>
ConstIterator blaze::SMatDeclDiagExpr< MT, SO >::begin ( size_t  i) const
inline

Returns an iterator to the first non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator to the first non-zero element of row i.

◆ canAlias()

template<typename MT , bool SO>
template<typename T >
bool blaze::SMatDeclDiagExpr< MT, SO >::canAlias ( const T *  alias) const
inlinenoexcept

Returns whether the expression can alias with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case the expression can alias, false otherwise.

◆ canSMPAssign()

template<typename MT , bool SO>
bool blaze::SMatDeclDiagExpr< MT, SO >::canSMPAssign ( ) const
inlinenoexcept

Returns whether the expression can be used in SMP assignments.

Returns
true in case the expression can be used in SMP assignments, false if not.

◆ columns()

template<typename MT , bool SO>
size_t blaze::SMatDeclDiagExpr< MT, SO >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ end()

template<typename MT , bool SO>
ConstIterator blaze::SMatDeclDiagExpr< MT, SO >::end ( size_t  i) const
inline

Returns an iterator just past the last non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator just past the last non-zero element of row i.

◆ isAliased()

template<typename MT , bool SO>
template<typename T >
bool blaze::SMatDeclDiagExpr< MT, SO >::isAliased ( const T *  alias) const
inlinenoexcept

Returns whether the expression is aliased with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case an alias effect is detected, false otherwise.

◆ nonZeros() [1/2]

template<typename MT , bool SO>
size_t blaze::SMatDeclDiagExpr< MT, SO >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the sparse matrix.

Returns
The number of non-zero elements in the sparse matrix.

◆ nonZeros() [2/2]

template<typename MT , bool SO>
size_t blaze::SMatDeclDiagExpr< MT, SO >::nonZeros ( size_t  i) const
inline

Returns the number of non-zero elements in the specified row.

Parameters
iThe index of the row.
Returns
The number of non-zero elements of row i.

◆ operand()

template<typename MT , bool SO>
Operand blaze::SMatDeclDiagExpr< MT, SO >::operand ( ) const
inlinenoexcept

Returns the sparse matrix operand.

Returns
The sparse matrix operand.

◆ operator()()

template<typename MT , bool SO>
ReturnType blaze::SMatDeclDiagExpr< MT, SO >::operator() ( size_t  i,
size_t  j 
) const
inline

2D-access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.

◆ operator~() [1/2]

BLAZE_ALWAYS_INLINE MatrixType& blaze::Matrix< SMatDeclDiagExpr< MT, SO > , SO >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.

◆ operator~() [2/2]

BLAZE_ALWAYS_INLINE const MatrixType& blaze::Matrix< SMatDeclDiagExpr< MT, SO > , SO >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.

◆ rows()

template<typename MT , bool SO>
size_t blaze::SMatDeclDiagExpr< MT, SO >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

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