Blaze 3.9
Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > Class Template Reference

Expression object for sparse matrix-transpose dense matrix multiplications. More...

#include <SMatTDMatMultExpr.h>

Inherits blaze::MatMatMultExpr< DenseMatrix< SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >, true > >, and blaze::Computation.

Public Types

using This = SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >
 Type of this SMatTDMatMultExpr instance.
 
using BaseType = MatMatMultExpr< DenseMatrix< This, true > >
 Base type of this SMatTDMatMultExpr instance.
 
using ResultType = typename If_t< HERM, DeclHermTrait< MultTrait_t< RT1, RT2 > >, If_t< SYM, DeclSymTrait< MultTrait_t< RT1, RT2 > >, If_t< LOW, If_t< UPP, DeclDiagTrait< MultTrait_t< RT1, RT2 > >, DeclLowTrait< MultTrait_t< RT1, RT2 > > >, If_t< UPP, DeclUppTrait< MultTrait_t< RT1, RT2 > >, MultTrait< RT1, RT2 > > > > >::Type
 Result type for expression template evaluations.
 
using OppositeType = OppositeType_t< ResultType >
 Result type with opposite storage order for expression template evaluations.
 
using TransposeType = TransposeType_t< ResultType >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_t< ResultType >
 Resulting element type.
 
using ReturnType = const ElementType
 Return type for expression template evaluations.
 
using CompositeType = const ResultType
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< MT1 >, const MT1, const MT1 & >
 Composite type of the left-hand side sparse matrix expression.
 
using RightOperand = If_t< IsExpression_v< MT2 >, const MT2, const MT2 & >
 Composite type of the right-hand side dense matrix expression.
 
using LT = If_t< evaluateLeft, const RT1, CT1 >
 Type for the assignment of the left-hand side sparse matrix operand.
 
using RT = If_t< evaluateRight, const RT2, CT2 >
 Type for the assignment of the right-hand side dense matrix operand.
 
using MatrixType = SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >
 Type of the matrix.
 

Public Member Functions

 SMatTDMatMultExpr (const MT1 &lhs, const MT2 &rhs) noexcept
 Constructor for the SMatTDMatMultExpr 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...
 
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...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side sparse matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side transpose dense 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 isAligned () const noexcept
 Returns whether the operands of the expression are properly aligned in memory. More...
 
bool canSMPAssign () const noexcept
 Returns whether the expression can be used in SMP assignments. More...
 
Conversion operators
BLAZE_ALWAYS_INLINE constexpr SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & operator~ () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & operator~ () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 
constexpr SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & operator* () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
constexpr const SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & operator* () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 

Static Public Attributes

static constexpr bool simdEnabled = false
 Compilation switch for the expression template evaluation strategy.
 
static constexpr bool smpAssignable
 Compilation switch for the expression template assignment strategy. More...
 
static constexpr bool storageOrder
 Storage order of the matrix.
 

Private Types

using RT1 = ResultType_t< MT1 >
 Result type of the left-hand side sparse matrix expression.
 
using RT2 = ResultType_t< MT2 >
 Result type of the right-hand side dense matrix expression.
 
using ET1 = ElementType_t< RT1 >
 Element type of the left-hand side dense matrix expression.
 
using ET2 = ElementType_t< RT2 >
 Element type of the right-hand side sparse matrix expression.
 
using CT1 = CompositeType_t< MT1 >
 Composite type of the left-hand side sparse matrix expression.
 
using CT2 = CompositeType_t< MT2 >
 Composite type of the right-hand side dense matrix expression.
 

Private Attributes

LeftOperand lhs_
 Left-hand side sparse matrix of the multiplication expression.
 
RightOperand rhs_
 Right-hand side dense matrix of the multiplication expression.
 

Static Private Attributes

static constexpr bool evaluateLeft = ( IsComputation_v<MT1> || RequiresEvaluation_v<MT1> )
 Compilation switch for the composite type of the left-hand side sparse matrix expression.
 
static constexpr bool evaluateRight = ( IsComputation_v<MT2> || RequiresEvaluation_v<MT2> )
 Compilation switch for the composite type of the right-hand side dense matrix expression.
 
static constexpr bool SYM = ( SF && !( HF || LF || UF ) )
 Flag for symmetric matrices.
 
static constexpr bool HERM = ( HF && !( LF || UF ) )
 Flag for Hermitian matrices.
 
static constexpr bool LOW = ( LF || ( ( SF || HF ) && UF ) )
 Flag for lower matrices.
 
static constexpr bool UPP = ( UF || ( ( SF || HF ) && LF ) )
 Flag for upper matrices.
 

Detailed Description

template<typename MT1, typename MT2, bool SF, bool HF, bool LF, bool UF>
class blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >

Expression object for sparse matrix-transpose dense matrix multiplications.

The SMatTDMatMultExpr class represents the compile time expression for multiplications between a row-major sparse matrix and a column-major dense matrix.

Constructor & Destructor Documentation

◆ SMatTDMatMultExpr()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::SMatTDMatMultExpr ( const MT1 &  lhs,
const MT2 &  rhs 
)
inlinenoexcept

Constructor for the SMatTDMatMultExpr class.

Parameters
lhsThe left-hand side sparse matrix operand of the multiplication expression.
rhsThe right-hand side dense matrix operand of the multiplication expression.

Member Function Documentation

◆ at()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
ReturnType blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::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.

◆ canAlias()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
template<typename T >
bool blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::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 MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
bool blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::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 MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
size_t blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ isAliased()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
template<typename T >
bool blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::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.

◆ isAligned()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
bool blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::isAligned ( ) const
inlinenoexcept

Returns whether the operands of the expression are properly aligned in memory.

Returns
true in case the operands are aligned, false if not.

◆ leftOperand()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
LeftOperand blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side sparse matrix operand.

Returns
The left-hand side sparse matrix operand.

◆ operator()()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
ReturnType blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::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 constexpr const SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & blaze::Matrix< SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > , SO >::operator*
constexprnoexceptinherited

CRTP-based conversion operation for constant matrices.

Returns
Constant reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a constant reference to the actual type MT.

◆ operator*() [2/2]

BLAZE_ALWAYS_INLINE constexpr SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & blaze::Matrix< SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > , SO >::operator*
constexprnoexceptinherited

CRTP-based conversion operation for non-constant matrices.

Returns
Mutable reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a mutable reference to the actual type MT.

◆ operator~() [1/2]

BLAZE_ALWAYS_INLINE constexpr const SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & blaze::Matrix< SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > , SO >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for constant matrices.

Parameters
matrixThe matrix to be downcast.
Returns
Constant reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a constant reference to the actual type MT.

◆ operator~() [2/2]

BLAZE_ALWAYS_INLINE constexpr SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > & blaze::Matrix< SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF > , SO >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for non-constant matrices.

Parameters
matrixThe matrix to be downcast.
Returns
Mutable reference of the actual type of the matrix.

This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a mutable reference to the actual type MT.

◆ rightOperand()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
RightOperand blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side transpose dense matrix operand.

Returns
The right-hand side transpose dense matrix operand.

◆ rows()

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
size_t blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

Member Data Documentation

◆ smpAssignable

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
constexpr bool blaze::SMatTDMatMultExpr< MT1, MT2, SF, HF, LF, UF >::smpAssignable
staticconstexpr
Initial value:
=
( !evaluateLeft && MT1::smpAssignable && !evaluateRight && MT2::smpAssignable )
static constexpr bool evaluateRight
Compilation switch for the composite type of the right-hand side dense matrix expression.
Definition: SMatTDMatMultExpr.h:145
static constexpr bool evaluateLeft
Compilation switch for the composite type of the left-hand side sparse matrix expression.
Definition: SMatTDMatMultExpr.h:140

Compilation switch for the expression template assignment strategy.


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