Blaze  3.6
Classes | Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::DVecDVecAddExpr< VT1, VT2, TF > Class Template Reference

Expression object for dense vector-dense vector additions.The DVecDVecAddExpr class represents the compile time expression for additions between dense vectors. More...

#include <DVecDVecAddExpr.h>

Inherits blaze::VecVecAddExpr< DenseVector< DVecDVecAddExpr< VT1, VT2, TF >, TF > >, and blaze::Computation.

Classes

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

Public Types

using This = DVecDVecAddExpr< VT1, VT2, TF >
 Type of this DVecDVecAddExpr instance.
 
using BaseType = DenseVector< This, TF >
 Base type of this DVecDVecAddExpr instance.
 
using ResultType = AddTrait_t< RT1, RT2 >
 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 DVecDVecAddExpr & >
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< VT1 >, const VT1, const VT1 & >
 Composite type of the left-hand side dense vector expression.
 
using RightOperand = If_t< IsExpression_v< VT2 >, const VT2, const VT2 & >
 Composite type of the right-hand side dense vector expression.
 
using VectorType = VT
 Type of the vector.
 

Public Member Functions

 DVecDVecAddExpr (const VT1 &lhs, const VT2 &rhs) noexcept
 Constructor for the DVecDVecAddExpr 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 dense 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
 Compilation switch for the expression template evaluation strategy. More...
 
static constexpr bool smpAssignable = ( VT1::smpAssignable && VT2::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 = TF
 Transpose flag of the vector.
 

Private Types

using RT1 = ResultType_t< VT1 >
 Result type of the left-hand side dense vector expression.
 
using RT2 = ResultType_t< VT2 >
 Result type of the right-hand side dense vector expression.
 
using RN1 = ReturnType_t< VT1 >
 Return type of the left-hand side dense vector expression.
 
using RN2 = ReturnType_t< VT2 >
 Return type of the right-hand side dense vector expression.
 
using CT1 = CompositeType_t< VT1 >
 Composite type of the left-hand side dense vector expression.
 
using CT2 = CompositeType_t< VT2 >
 Composite type of the right-hand side dense vector expression.
 
using ET1 = ElementType_t< VT1 >
 Element type of the left-hand side dense vector expression.
 
using ET2 = ElementType_t< VT2 >
 Element type of the right-hand side dense vector expression.
 
using ExprReturnType = decltype(std::declval< RN1 >()+std::declval< RN2 >())
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side dense vector of the addition expression.
 
RightOperand rhs_
 Right-hand side dense vector of the addition expression.
 

Static Private Attributes

static constexpr bool returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> )
 Compilation switch for the selection of the subscript operator return type. More...
 
static constexpr bool useAssign
 Compilation switch for the serial evaluation strategy of the addition expression. More...
 

Detailed Description

template<typename VT1, typename VT2, bool TF>
class blaze::DVecDVecAddExpr< VT1, VT2, TF >

Expression object for dense vector-dense vector additions.

The DVecDVecAddExpr class represents the compile time expression for additions between dense vectors.

Constructor & Destructor Documentation

◆ DVecDVecAddExpr()

template<typename VT1 , typename VT2 , bool TF>
blaze::DVecDVecAddExpr< VT1, VT2, TF >::DVecDVecAddExpr ( const VT1 &  lhs,
const VT2 &  rhs 
)
inlineexplicitnoexcept

Constructor for the DVecDVecAddExpr class.

Parameters
lhsThe left-hand side operand of the addition expression.
rhsThe right-hand side operand of the addition expression.

Member Function Documentation

◆ at()

template<typename VT1 , typename VT2 , bool TF>
ReturnType blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
ConstIterator blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
template<typename T >
bool blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
bool blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
ConstIterator blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
template<typename T >
bool blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
bool blaze::DVecDVecAddExpr< VT1, VT2, 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 VT1 , typename VT2 , bool TF>
LeftOperand blaze::DVecDVecAddExpr< VT1, VT2, TF >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.

◆ load()

template<typename VT1 , typename VT2 , bool TF>
BLAZE_ALWAYS_INLINE auto blaze::DVecDVecAddExpr< VT1, VT2, 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[]()

template<typename VT1 , typename VT2 , bool TF>
ReturnType blaze::DVecDVecAddExpr< VT1, VT2, 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]

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 VT1 , typename VT2 , bool TF>
RightOperand blaze::DVecDVecAddExpr< VT1, VT2, TF >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side dense vector operand.

Returns
The right-hand side dense vector operand.

◆ size()

template<typename VT1 , typename VT2 , bool TF>
size_t blaze::DVecDVecAddExpr< VT1, VT2, TF >::size ( ) const
inlinenoexcept

Returns the current size/dimension of the vector.

Returns
The size of the vector.

Member Data Documentation

◆ returnExpr

template<typename VT1 , typename VT2 , bool TF>
constexpr bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> )
staticprivate

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 either vector operand returns a temporary vector or matrix, returnExpr will be set to 0 and the subscript operator will return it's result by value. Otherwise returnExpr will be set to 1 and the subscript operator may return it's result as an expression.

◆ simdEnabled

template<typename VT1 , typename VT2 , bool TF>
constexpr bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::simdEnabled
static
Initial value:
=
( VT1::simdEnabled && VT2::simdEnabled && HasSIMDAdd_v<ET1,ET2> )

Compilation switch for the expression template evaluation strategy.

◆ useAssign

template<typename VT1 , typename VT2 , bool TF>
constexpr bool blaze::DVecDVecAddExpr< VT1, VT2, TF >::useAssign
staticprivate
Initial value:
=
( RequiresEvaluation_v<VT1> || RequiresEvaluation_v<VT2> || !returnExpr )

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

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the addition expression. In case either of the two dense vector operands requires an intermediate evaluation or the subscript operator can only return by value, useAssign will be set to 1 and the addition 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: