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

Expression object for transpose dense matrix-transpose sparse matrix multiplications.The TDMatTSMatMultExpr class represents the compile time expression for multiplications between a column-major dense matrix and a column-major sparse matrix. More...

#include <TDMatTSMatMultExpr.h>

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

Public Types

enum  : bool { simdEnabled }
 Compilation switch for the expression template evaluation strategy.
 
enum  : bool { smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
enum  : size_t { SIMDSIZE = SIMDTrait<ElementType>::size }
 The number of elements packed within a single SIMD element.
 
using This = TDMatTSMatMultExpr< MT1, MT2, SF, HF, LF, UF >
 Type of this TDMatTSMatMultExpr instance.
 
using ResultType = MultTrait_< RT1, RT2 >
 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_< ResultType >
 Resulting element type.
 
using SIMDType = SIMDTrait_< ElementType >
 Resulting SIMD 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_< IsExpression< MT1 >, const MT1, const MT1 &>
 Composite type of the left-hand side dense matrix expression.
 
using RightOperand = If_< IsExpression< MT2 >, const MT2, const MT2 &>
 Composite type of the right-hand side sparse matrix expression.
 
using LT = IfTrue_< evaluateLeft, const RT1, CT1 >
 Type for the assignment of the left-hand side dense matrix operand.
 
using RT = IfTrue_< evaluateRight, const RT2, CT2 >
 Type for the assignment of the right-hand side sparse matrix operand.
 
using MatrixType = MT
 Type of the matrix.
 

Public Member Functions

 TDMatTSMatMultExpr (const MT1 &lhs, const MT2 &rhs) noexcept
 Constructor for the TDMatTSMatMultExpr 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 transpose dense matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side transpose 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 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...
 
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 { evaluateLeft = IsComputation<MT1>::value || RequiresEvaluation<MT1>::value }
 Compilation switch for the composite type of the left-hand side dense matrix expression.
 
enum  : bool { evaluateRight = IsComputation<MT2>::value || RequiresEvaluation<MT2>::value }
 Compilation switch for the composite type of the right-hand side sparse matrix expression.
 
enum  : bool { SYM = ( SF && !( HF || LF || UF ) ), HERM = ( HF && !( LF || UF ) ), LOW = ( LF || ( ( SF || HF ) && UF ) ), UPP = ( UF || ( ( SF || HF ) && LF ) ) }
 Compilation switches for the kernel generation. More...
 
using RT1 = ResultType_< MT1 >
 Result type of the left-hand side dense matrix expression.
 
using RT2 = ResultType_< MT2 >
 Result type of the right-hand side sparse matrix expression.
 
using ET1 = ElementType_< RT1 >
 Element type of the left-hand side dense matrix expression.
 
using ET2 = ElementType_< RT2 >
 Element type of the right-hand side sparse matrix expression.
 
using CT1 = CompositeType_< MT1 >
 Composite type of the left-hand side dense matrix expression.
 
using CT2 = CompositeType_< MT2 >
 Composite type of the right-hand side sparse matrix expression.
 

Private Attributes

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

Detailed Description

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

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

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

Member Enumeration Documentation

◆ anonymous enum

template<typename MT1 , typename MT2 , bool SF, bool HF, bool LF, bool UF>
anonymous enum : bool
private

Compilation switches for the kernel generation.

Enumerator
SYM 

Flag for symmetric matrices.

HERM 

Flag for Hermitian matrices.

LOW 

Flag for lower matrices.

UPP 

Flag for upper matrices.

Constructor & Destructor Documentation

◆ TDMatTSMatMultExpr()

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

Constructor for the TDMatTSMatMultExpr class.

Parameters
lhsThe left-hand side dense matrix operand of the multiplication expression.
rhsThe right-hand side sparse 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::TDMatTSMatMultExpr< 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::TDMatTSMatMultExpr< 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::TDMatTSMatMultExpr< 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::TDMatTSMatMultExpr< 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::TDMatTSMatMultExpr< 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::TDMatTSMatMultExpr< 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::TDMatTSMatMultExpr< MT1, MT2, SF, HF, LF, UF >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side transpose dense matrix operand.

Returns
The left-hand side transpose dense matrix operand.

◆ operator()()

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

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

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.

◆ operator~() [2/2]

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

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.

◆ rightOperand()

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

Returns the right-hand side transpose sparse matrix operand.

Returns
The right-hand side transpose sparse matrix operand.

◆ rows()

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

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