Blaze  3.6
Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::DMatSVecMultExpr< MT, VT > Class Template Reference

Expression object for dense matrix-sparse vector multiplications.The DMatSVecMultExpr class represents the compile time expression for multiplications between row-major dense matrices and sparse vectors. More...

#include <DMatSVecMultExpr.h>

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

Public Types

using This = DMatSVecMultExpr< MT, VT >
 Type of this DMatSVecMultExpr instance.
 
using BaseType = DenseVector< This, false >
 Base type of this DMatSVecMultExpr 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 ReturnType = const ElementType
 Return type for expression template evaluations.
 
using CompositeType = If_t< useAssign, const ResultType, const DMatSVecMultExpr & >
 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 matrix operand.
 
using VectorType = VT
 Type of the vector.
 

Public Member Functions

 DMatSVecMultExpr (const MT &mat, const VT &vec) noexcept
 Constructor for the DMatSVecMultExpr class. More...
 
ReturnType operator[] (size_t index) const
 Subscript operator for the direct access to the vector elements. More...
 
ReturnType at (size_t index) const
 Checked access to the vector elements. More...
 
size_t size () const noexcept
 Returns the current size/dimension of the vector. More...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side dense matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side sparse vector 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 constexpr VectorTypeoperator~ () noexcept
 Conversion operator for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE constexpr const VectorTypeoperator~ () const noexcept
 Conversion operator for constant vectors. 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 transposeFlag = TF
 Transpose flag of the vector.
 

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 sparse 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 sparse vector expression.
 

Private Attributes

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

Static Private Attributes

static constexpr bool evaluateMatrix = RequiresEvaluation_v<MT>
 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 sparse vector expression.
 
static constexpr bool useAssign = ( evaluateMatrix || evaluateVector )
 Compilation switch for the evaluation strategy of the multiplication expression. More...
 

Detailed Description

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

Expression object for dense matrix-sparse vector multiplications.

The DMatSVecMultExpr class represents the compile time expression for multiplications between row-major dense matrices and sparse vectors.

Constructor & Destructor Documentation

◆ DMatSVecMultExpr()

template<typename MT , typename VT >
blaze::DMatSVecMultExpr< MT, VT >::DMatSVecMultExpr ( const MT &  mat,
const VT &  vec 
)
inlineexplicitnoexcept

Constructor for the DMatSVecMultExpr class.

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

Member Function Documentation

◆ at()

template<typename MT , typename VT >
ReturnType blaze::DMatSVecMultExpr< 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::DMatSVecMultExpr< 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 given alias is contained in this expression, false if not.

◆ canSMPAssign()

template<typename MT , typename VT >
bool blaze::DMatSVecMultExpr< 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::DMatSVecMultExpr< 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 the given alias is contained in this expression, false if not.

◆ isAligned()

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

Returns the left-hand side dense matrix operand.

Returns
The left-hand side dense matrix operand.

◆ operator[]()

template<typename MT , typename VT >
ReturnType blaze::DMatSVecMultExpr< 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.

◆ operator~() [1/2]

template<typename VT, bool TF>
BLAZE_ALWAYS_INLINE constexpr VectorType& blaze::Vector< VT, TF >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.

◆ operator~() [2/2]

template<typename VT, bool TF>
BLAZE_ALWAYS_INLINE constexpr const VectorType& blaze::Vector< VT, TF >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant vectors.

Returns
Const reference of the actual type of the vector.

◆ rightOperand()

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

Returns the right-hand side sparse vector operand.

Returns
The right-hand side sparse vector operand.

◆ size()

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

Returns the current size/dimension of the vector.

Returns
The size of the vector.

Member Data Documentation

◆ smpAssignable

template<typename MT , typename VT >
constexpr bool blaze::DMatSVecMultExpr< MT, VT >::smpAssignable
static
Initial value:
=
( !evaluateMatrix && MT::smpAssignable && !evaluateVector && VT::smpAssignable )

Compilation switch for the expression template assignment strategy.

◆ useAssign

template<typename MT , typename VT >
constexpr bool blaze::DMatSVecMultExpr< MT, VT >::useAssign = ( evaluateMatrix || evaluateVector )
staticprivate

Compilation switch for the evaluation strategy of the multiplication expression.

The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the multiplication expression. In case either the matrix or the vector operand requires an intermediate evaluation or the sparse vector expression is a compound expression, useAssign will be set to true and the multiplication expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the subscript operator.


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