Blaze 3.9
Classes | Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::DVecScalarMultExpr< VT, ST, TF > Class Template Reference

Expression object for dense vector-scalar multiplications. More...

#include <DVecScalarMultExpr.h>

Inherits blaze::VecScalarMultExpr< DenseVector< DVecScalarMultExpr< VT, ST, TF >, TF > >, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the dense vector. More...
 

Public Types

using This = DVecScalarMultExpr< VT, ST, TF >
 Type of this DVecScalarMultExpr instance.
 
using BaseType = VecScalarMultExpr< DenseVector< This, TF > >
 Base type of this DVecScalarMultExpr instance.
 
using ResultType = MultTrait_t< RT, ST >
 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 If_t< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = If_t< useAssign, const ResultType, const DVecScalarMultExpr & >
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< VT >, const VT, const VT & >
 Composite type of the left-hand side dense vector expression.
 
using RightOperand = ST
 Composite type of the right-hand side scalar value.
 
using VectorType = DVecScalarMultExpr< VT, ST, TF >
 Type of the vector.
 

Public Member Functions

 DVecScalarMultExpr (const VT &vector, ST scalar) noexcept
 Constructor for the DVecScalarMultExpr 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...
 
BLAZE_ALWAYS_INLINE auto load (size_t index) const noexcept
 Access to the SIMD elements of the vector. More...
 
ConstIterator begin () const
 Returns an iterator to the first non-zero element of the dense vector. More...
 
ConstIterator end () const
 Returns an iterator just past the last non-zero element of the dense vector. 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 vector operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side scalar 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 DVecScalarMultExpr< VT, ST, TF > & operator~ () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE constexpr const DVecScalarMultExpr< VT, ST, TF > & operator~ () const noexcept
 CRTP-based conversion operation for constant vectors. More...
 
constexpr DVecScalarMultExpr< VT, ST, TF > & operator* () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
constexpr const DVecScalarMultExpr< VT, ST, TF > & operator* () const noexcept
 CRTP-based conversion operation for constant vectors. More...
 

Static Public Attributes

static constexpr bool simdEnabled
 Compilation switch for the expression template evaluation strategy. More...
 
static constexpr bool smpAssignable = VT::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.
 
static constexpr bool transposeFlag
 Transpose flag of the vector.
 

Private Types

using RT = ResultType_t< VT >
 Result type of the dense vector expression.
 
using RN = ReturnType_t< VT >
 Return type of the dense vector expression.
 
using ET = ElementType_t< VT >
 Element type of the dense vector expression.
 
using CT = CompositeType_t< VT >
 Composite type of the dense vector expression.
 
using ExprReturnType = decltype(std::declval< RN >() *std::declval< ST >())
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand vector_
 Left-hand side dense vector of the multiplication expression.
 
RightOperand scalar_
 Right-hand side scalar of the multiplication expression.
 

Static Private Attributes

static constexpr bool returnExpr = !IsTemporary_v<RN>
 Compilation switch for the selection of the subscript operator return type. More...
 
static constexpr bool useAssign = ( IsComputation_v<VT> && RequiresEvaluation_v<VT> )
 Compilation switch for the serial evaluation strategy of the multiplication expression. More...
 

Detailed Description

template<typename VT, typename ST, bool TF>
class blaze::DVecScalarMultExpr< VT, ST, TF >

Expression object for dense vector-scalar multiplications.

The DVecScalarMultExpr class represents the compile time expression for multiplications between a dense vector and a scalar value.

Constructor & Destructor Documentation

◆ DVecScalarMultExpr()

template<typename VT , typename ST , bool TF>
blaze::DVecScalarMultExpr< VT, ST, TF >::DVecScalarMultExpr ( const VT &  vector,
ST  scalar 
)
inlinenoexcept

Constructor for the DVecScalarMultExpr class.

Parameters
vectorThe left-hand side dense vector of the multiplication expression.
scalarThe right-hand side scalar of the multiplication expression.

Member Function Documentation

◆ at()

template<typename VT , typename ST , bool TF>
ReturnType blaze::DVecScalarMultExpr< VT, ST, TF >::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.

◆ begin()

template<typename VT , typename ST , bool TF>
ConstIterator blaze::DVecScalarMultExpr< VT, ST, TF >::begin ( ) const
inline

Returns an iterator to the first non-zero element of the dense vector.

Returns
Iterator to the first non-zero element of the dense vector.

◆ canAlias()

template<typename VT , typename ST , bool TF>
template<typename T >
bool blaze::DVecScalarMultExpr< VT, ST, TF >::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 VT , typename ST , bool TF>
bool blaze::DVecScalarMultExpr< VT, ST, TF >::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.

◆ end()

template<typename VT , typename ST , bool TF>
ConstIterator blaze::DVecScalarMultExpr< VT, ST, TF >::end ( ) const
inline

Returns an iterator just past the last non-zero element of the dense vector.

Returns
Iterator just past the last non-zero element of the dense vector.

◆ isAliased()

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

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.

◆ load()

template<typename VT , typename ST , bool TF>
BLAZE_ALWAYS_INLINE auto blaze::DVecScalarMultExpr< VT, ST, TF >::load ( size_t  index) const
inlinenoexcept

Access to the SIMD elements of the vector.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
Reference to the accessed values.

◆ operator*() [1/2]

BLAZE_ALWAYS_INLINE constexpr const DVecScalarMultExpr< VT, ST, TF > & blaze::Vector< DVecScalarMultExpr< VT, ST, TF > , TF >::operator*
constexprnoexceptinherited

CRTP-based conversion operation for constant vectors.

Returns
Const reference of the actual type of the vector.

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

◆ operator*() [2/2]

BLAZE_ALWAYS_INLINE constexpr DVecScalarMultExpr< VT, ST, TF > & blaze::Vector< DVecScalarMultExpr< VT, ST, TF > , TF >::operator*
constexprnoexceptinherited

CRTP-based conversion operation for non-constant vectors.

Returns
Mutable reference of the actual type of the vector.

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

◆ operator[]()

template<typename VT , typename ST , bool TF>
ReturnType blaze::DVecScalarMultExpr< VT, ST, TF >::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]

BLAZE_ALWAYS_INLINE constexpr const DVecScalarMultExpr< VT, ST, TF > & blaze::Vector< DVecScalarMultExpr< VT, ST, TF > , TF >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for constant vectors.

Returns
Constant reference of the actual type of the vector.

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

◆ operator~() [2/2]

BLAZE_ALWAYS_INLINE constexpr DVecScalarMultExpr< VT, ST, TF > & blaze::Vector< DVecScalarMultExpr< VT, ST, TF > , TF >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for non-constant vectors.

Returns
Mutable reference of the actual type of the vector.

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

◆ rightOperand()

template<typename VT , typename ST , bool TF>
RightOperand blaze::DVecScalarMultExpr< VT, ST, TF >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side scalar operand.

Returns
The right-hand side scalar operand.

◆ size()

template<typename VT , typename ST , bool TF>
size_t blaze::DVecScalarMultExpr< VT, ST, TF >::size ( ) const
inlinenoexcept

Returns the current size/dimension of the vector.

Returns
The size of the vector.

Member Data Documentation

◆ returnExpr

template<typename VT , typename ST , bool TF>
constexpr bool blaze::DVecScalarMultExpr< VT, ST, TF >::returnExpr = !IsTemporary_v<RN>
staticconstexprprivate

Compilation switch for the selection of the subscript operator return type.

The returnExpr compile time constant expression is a compilation switch for the selection of the ReturnType. If the vector operand returns a temporary vector or matrix, returnExpr will be set to false and the subscript operator will return it's result by value. Otherwise returnExpr will be set to true and the subscript operator may return it's result as an expression.

◆ simdEnabled

template<typename VT , typename ST , bool TF>
constexpr bool blaze::DVecScalarMultExpr< VT, ST, TF >::simdEnabled
staticconstexpr
Initial value:
=
( VT::simdEnabled && IsNumeric_v<ET> &&
( HasSIMDMult_v<ET,ST> || HasSIMDMult_v<UnderlyingElement_t<ET>,ST> ) )

Compilation switch for the expression template evaluation strategy.

◆ useAssign

template<typename VT , typename ST , bool TF>
constexpr bool blaze::DVecScalarMultExpr< VT, ST, TF >::useAssign = ( IsComputation_v<VT> && RequiresEvaluation_v<VT> )
staticconstexprprivate

Compilation switch for the serial evaluation strategy of the multiplication expression.

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the multiplication expression. In case the given dense vector expression of type VT is a computation expression and requires an intermediate evaluation, useAssign will be set to 1 and the multiplication 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.


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