Blaze 3.9
Loading...
Searching...
No Matches
blaze::TDMatDVecMultExpr< MT, VT > Class Template Reference

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

#include <TDMatDVecMultExpr.h>

Inherits blaze::MatVecMultExpr< DenseVector< TDMatDVecMultExpr< MT, VT >, false > >, and blaze::Computation.

Public Types

using This = TDMatDVecMultExpr<MT,VT>
 Type of this TDMatDVecMultExpr instance.
using BaseType = MatVecMultExpr< DenseVector<This,false> >
 Base type of this TDMatDVecMultExpr instance.
using ResultType = MultTrait_t<MRT,VRT>
 Result type for expression template evaluations.
using TransposeType = TransposeType_t<ResultType>
 Transpose type for expression template evaluations.
using ElementType = ElementType_t<ResultType>
 Resulting element type.
using SIMDType = SIMDTrait_t<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_t< IsExpression_v<MT>, const MT, const MT& >
 Composite type of the left-hand side dense matrix expression.
using RightOperand = If_t< IsExpression_v<VT>, const VT, const VT& >
 Composite type of the right-hand side dense vector expression.
using LT = If_t< evaluateMatrix, const MRT, MCT >
 Type for the assignment of the left-hand side dense matrix operand.
using RT = If_t< evaluateVector, const VRT, VCT >
 Type for the assignment of the right-hand side dense vector operand.

Public Member Functions

 TDMatDVecMultExpr (const MT &mat, const VT &vec) noexcept
 Constructor for the TDMatDVecMultExpr class.
ReturnType operator[] (size_t index) const
 Subscript operator for the direct access to the vector elements.
ReturnType at (size_t index) const
 Checked access to the vector elements.
size_t size () const noexcept
 Returns the current size/dimension of the vector.
LeftOperand leftOperand () const noexcept
 Returns the left-hand side transpose dense matrix operand.
RightOperand rightOperand () const noexcept
 Returns the right-hand side dense vector operand.
template<typename T>
bool canAlias (const T *alias) const noexcept
 Returns whether the expression can alias with the given address alias.
template<typename T>
bool isAliased (const T *alias) const noexcept
 Returns whether the expression is aliased with the given address alias.
bool isAligned () const noexcept
 Returns whether the operands of the expression are properly aligned in memory.
bool canSMPAssign () const noexcept
 Returns whether the expression can be used in SMP assignments.

Static Public Attributes

static constexpr bool simdEnabled
 Compilation switch for the expression template evaluation strategy.
static constexpr bool smpAssignable
 Compilation switch for the expression template assignment strategy.
static constexpr size_t SIMDSIZE = SIMDTrait<ElementType>::size
 The number of elements packed within a single SIMD element.

Private Types

using MRT = ResultType_t<MT>
 Result type of the left-hand side dense matrix expression.
using VRT = ResultType_t<VT>
 Result type of the right-hand side dense vector expression.
using MET = ElementType_t<MRT>
 Element type of the left-hand side dense matrix expression.
using VET = ElementType_t<VRT>
 Element type of the right-hand side dense vector expression.
using MCT = CompositeType_t<MT>
 Composite type of the left-hand side dense matrix expression.
using VCT = CompositeType_t<VT>
 Composite type of the right-hand side dense vector expression.

Private Attributes

LeftOperand mat_
 Left-hand side dense matrix of the multiplication expression.
RightOperand vec_
 Right-hand side dense vector of the multiplication expression.

Static Private Attributes

static constexpr bool evaluateMatrix
 Compilation switch for the composite type of the left-hand side dense matrix expression.
static constexpr bool evaluateVector = ( IsComputation_v<VT> || RequiresEvaluation_v<VT> )
 Compilation switch for the composite type of the right-hand side dense vector expression.

Detailed Description

template<typename MT, typename VT>
class blaze::TDMatDVecMultExpr< MT, VT >

Expression object for transpose dense matrix-dense vector multiplications.

The TDMatDVecMultExpr class represents the compile time expression for multiplications between column-major dense matrices and dense vectors.

Constructor & Destructor Documentation

◆ TDMatDVecMultExpr()

template<typename MT, typename VT>
blaze::TDMatDVecMultExpr< MT, VT >::TDMatDVecMultExpr ( const MT & mat,
const VT & vec )
inlinenoexcept

Constructor for the TDMatDVecMultExpr class.

Parameters
matThe left-hand side matrix operand of the multiplication expression.
vecThe right-hand side vector operand of the multiplication expression.

Member Function Documentation

◆ at()

template<typename MT, typename VT>
ReturnType blaze::TDMatDVecMultExpr< MT, VT >::at ( size_t index) const
inline

Checked access to the vector elements.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
Exceptions
std::out_of_rangeInvalid vector access index.

◆ canAlias()

template<typename MT, typename VT>
template<typename T>
bool blaze::TDMatDVecMultExpr< MT, VT >::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, typename VT>
bool blaze::TDMatDVecMultExpr< MT, VT >::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.

◆ isAliased()

template<typename MT, typename VT>
template<typename T>
bool blaze::TDMatDVecMultExpr< MT, VT >::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 MT, typename VT>
bool blaze::TDMatDVecMultExpr< MT, VT >::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 MT, typename VT>
LeftOperand blaze::TDMatDVecMultExpr< MT, VT >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side transpose dense matrix operand.

Returns
The left-hand side transpose dense matrix operand.

◆ operator[]()

template<typename MT, typename VT>
ReturnType blaze::TDMatDVecMultExpr< MT, VT >::operator[] ( size_t index) const
inline

Subscript operator for the direct access to the vector elements.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.

◆ rightOperand()

template<typename MT, typename VT>
RightOperand blaze::TDMatDVecMultExpr< MT, VT >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side dense vector operand.

Returns
The right-hand side dense vector operand.

◆ size()

template<typename MT, typename VT>
size_t blaze::TDMatDVecMultExpr< MT, VT >::size ( ) const
inlinenoexcept

Returns the current size/dimension of the vector.

Returns
The size of the vector.

Member Data Documentation

◆ evaluateMatrix

template<typename MT, typename VT>
bool blaze::TDMatDVecMultExpr< MT, VT >::evaluateMatrix
staticconstexprprivate
Initial value:
=
constexpr bool RequiresEvaluation_v
Auxiliary variable template for the RequiresEvaluation type trait.
Definition RequiresEvaluation.h:91
constexpr bool IsComputation_v
Auxiliary variable template for the IsComputation type trait.
Definition IsComputation.h:90
constexpr bool IsBLASCompatible_v
Auxiliary variable template for the IsBLASCompatible type trait.
Definition IsBLASCompatible.h:99
constexpr bool IsSame_v
Auxiliary variable template for the IsSame type trait.
Definition IsSame.h:159

Compilation switch for the composite type of the left-hand side dense matrix expression.

◆ simdEnabled

template<typename MT, typename VT>
bool blaze::TDMatDVecMultExpr< MT, VT >::simdEnabled
staticconstexpr
Initial value:
=
MT::simdEnabled && VT::simdEnabled &&
constexpr bool IsDiagonal_v
Auxiliary variable template for the IsDiagonal type trait.
Definition IsDiagonal.h:148
constexpr bool HasSIMDAdd_v
Auxiliary variable template for the HasSIMDAdd type trait.
Definition HasSIMDAdd.h:187
constexpr bool HasSIMDMult_v
Auxiliary variable template for the HasSIMDMult type trait.
Definition HasSIMDMult.h:188

Compilation switch for the expression template evaluation strategy.

◆ smpAssignable

template<typename MT, typename VT>
bool blaze::TDMatDVecMultExpr< MT, VT >::smpAssignable
staticconstexpr
Initial value:
=
( !evaluateMatrix && MT::smpAssignable && !evaluateVector && VT::smpAssignable )
static constexpr bool evaluateMatrix
Compilation switch for the composite type of the left-hand side dense matrix expression.
Definition DMatDVecMultExpr.h:140
static constexpr bool evaluateVector
Compilation switch for the composite type of the right-hand side dense vector expression.
Definition DMatDVecMultExpr.h:147

Compilation switch for the expression template assignment strategy.


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