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

Expression object for the non-aliased evaluation of dense vectors. More...

#include <DVecNoAliasExpr.h>

Inherits blaze::VecNoAliasExpr< DenseVector< DVecNoAliasExpr< VT, TF >, TF > >, and blaze::Modification< VT >.

Public Types

using This = DVecNoAliasExpr< VT, TF >
 Type of this DVecNoAliasExpr instance.
 
using BaseType = VecNoAliasExpr< DenseVector< This, TF > >
 Base type of this DVecNoAliasExpr instance.
 
using ResultType = ResultType_t< VT >
 Result type for expression template evaluations.
 
using TransposeType = TransposeType_t< VT >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_t< VT >
 Resulting element type.
 
using ReturnType = ReturnType_t< VT >
 Return type for expression template evaluations.
 
using CompositeType = If_t< RequiresEvaluation_v< VT >, const ResultType, const DVecNoAliasExpr & >
 Data type for composite expression templates.
 
using ConstIterator = GetConstIterator_t< VT >
 Iterator over the elements of the dense vector.
 
using Operand = If_t< IsExpression_v< VT >, const VT, const VT & >
 Composite data type of the dense vector expression.
 
using VectorType = DVecNoAliasExpr< VT, TF >
 Type of the vector.
 

Public Member Functions

 DVecNoAliasExpr (const VT &dv) noexcept
 Constructor for the DVecNoAliasExpr 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...
 
const ElementTypedata () const noexcept
 Low-level data access to the vector elements. 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...
 
Operand operand () const noexcept
 Returns the 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...
 
Conversion operators
BLAZE_ALWAYS_INLINE constexpr DVecNoAliasExpr< VT, TF > & operator~ () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE constexpr const DVecNoAliasExpr< VT, TF > & operator~ () const noexcept
 CRTP-based conversion operation for constant vectors. More...
 
constexpr DVecNoAliasExpr< VT, TF > & operator* () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
constexpr const DVecNoAliasExpr< VT, TF > & operator* () const noexcept
 CRTP-based conversion operation for constant vectors. More...
 

Static Public Attributes

static constexpr bool simdEnabled = VT::simdEnabled
 Compilation switch for the expression template evaluation strategy.
 
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 Member Functions

 BLAZE_CREATE_GET_TYPE_MEMBER_TYPE_TRAIT (GetConstIterator, ConstIterator, INVALID_TYPE)
 Definition of the GetConstIterator type trait.
 

Private Attributes

Operand dv_
 Dense vector of the no-alias expression.
 

Detailed Description

template<typename VT, bool TF>
class blaze::DVecNoAliasExpr< VT, TF >

Expression object for the non-aliased evaluation of dense vectors.

The DVecNoAliasExpr class represents the compile time expression for the non-alias evaluation of a dense vector.

Constructor & Destructor Documentation

◆ DVecNoAliasExpr()

template<typename VT , bool TF>
blaze::DVecNoAliasExpr< VT, TF >::DVecNoAliasExpr ( const VT &  dv)
inlineexplicitnoexcept

Constructor for the DVecNoAliasExpr class.

Parameters
dvThe dense vector operand of the no-alias expression.

Member Function Documentation

◆ at()

template<typename VT , bool TF>
ReturnType blaze::DVecNoAliasExpr< VT, 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 , bool TF>
ConstIterator blaze::DVecNoAliasExpr< VT, 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 , bool TF>
template<typename T >
bool blaze::DVecNoAliasExpr< VT, 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 , bool TF>
bool blaze::DVecNoAliasExpr< VT, 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.

◆ data()

template<typename VT , bool TF>
const ElementType * blaze::DVecNoAliasExpr< VT, TF >::data ( ) const
inlinenoexcept

Low-level data access to the vector elements.

Returns
Pointer to the internal element storage.

◆ end()

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

◆ load()

template<typename VT , bool TF>
BLAZE_ALWAYS_INLINE auto blaze::DVecNoAliasExpr< VT, 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.

◆ operand()

template<typename VT , bool TF>
Operand blaze::DVecNoAliasExpr< VT, TF >::operand ( ) const
inlinenoexcept

Returns the dense vector operand.

Returns
The dense vector operand.

◆ operator*() [1/2]

BLAZE_ALWAYS_INLINE constexpr const DVecNoAliasExpr< VT, TF > & blaze::Vector< DVecNoAliasExpr< VT, 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 DVecNoAliasExpr< VT, TF > & blaze::Vector< DVecNoAliasExpr< VT, 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 , bool TF>
ReturnType blaze::DVecNoAliasExpr< VT, 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 DVecNoAliasExpr< VT, TF > & blaze::Vector< DVecNoAliasExpr< VT, 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 DVecNoAliasExpr< VT, TF > & blaze::Vector< DVecNoAliasExpr< VT, 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.

◆ size()

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

Returns the current size/dimension of the vector.

Returns
The size of the vector.

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