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

Expression object for dense vector expansion. More...

#include <DVecExpandExpr.h>

Inherits blaze::VecExpandExpr< DenseMatrix< DVecExpandExpr< VT, TF, CEAs... >, !TF >, CEAs... >, If_t< IsComputation_v< VT >, Computation, Transformation >, and blaze::ExpandExprData< CEAs... >.

Public Types

using This = DVecExpandExpr< VT, TF, CEAs... >
 Type of this DVecExpandExpr instance.
 
using BaseType = VecExpandExpr< DenseMatrix< This,!TF >, CEAs... >
 Base type of this DVecExpandExpr instance.
 
using ResultType = ExpandTrait_t< VT, CEAs... >
 Result type for expression template evaluations.
 
using OppositeType = OppositeType_t< ResultType >
 Result type with opposite storage order for expression template evaluations.
 
using TransposeType = TransposeType_t< ResultType >
 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< useAssign, const ResultType, const DVecExpandExpr & >
 Data type for composite expression templates.
 
using ConstIterator = GetConstIterator_t< VT >
 Iterator over the elements of the dense matrix.
 
using Operand = If_t< IsExpression_v< VT >, const VT, const VT & >
 Composite data type of the dense matrix expression.
 
using MatrixType = DVecExpandExpr< VT, TF, CEAs... >
 Type of the matrix.
 

Public Member Functions

template<typename... REAs>
 DVecExpandExpr (const VT &dv, REAs... args) noexcept
 Constructor for the DVecExpandExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
ReturnType at (size_t i, size_t j) const
 Checked access to the matrix elements. More...
 
BLAZE_ALWAYS_INLINE auto load (size_t i, size_t j) const noexcept
 Access to the SIMD elements of the matrix. More...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row/column i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row/column i. More...
 
size_t rows () const noexcept
 Returns the current number of rows of the matrix. More...
 
size_t columns () const noexcept
 Returns the current number of columns of the matrix. 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 DVecExpandExpr< VT, TF, CEAs... > & operator~ () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const DVecExpandExpr< VT, TF, CEAs... > & operator~ () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 
constexpr DVecExpandExpr< VT, TF, CEAs... > & operator* () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
constexpr const DVecExpandExpr< VT, TF, CEAs... > & operator* () const noexcept
 CRTP-based conversion operation for constant matrices. 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 storageOrder
 Storage order of the matrix.
 

Private Types

using RT = ResultType_t< VT >
 Result type of the dense vector expression.
 
using DataType = ExpandExprData< CEAs... >
 The type of the ExpandExprData base class.
 

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 expansion expression.
 

Static Private Attributes

static constexpr bool useAssign = IsComputation_v<VT> || RequiresEvaluation_v<VT>
 Compilation switch for the serial evaluation strategy of the expansion expression. More...
 

Detailed Description

template<typename VT, bool TF, size_t... CEAs>
class blaze::DVecExpandExpr< VT, TF, CEAs >

Expression object for dense vector expansion.

The DVecExpandExpr class represents the compile time expression for expansions of dense vectors.

Constructor & Destructor Documentation

◆ DVecExpandExpr()

template<typename VT , bool TF, size_t... CEAs>
template<typename... REAs>
blaze::DVecExpandExpr< VT, TF, CEAs >::DVecExpandExpr ( const VT &  dv,
REAs...  args 
)
inlineexplicitnoexcept

Constructor for the DVecExpandExpr class.

Parameters
dvThe dense vector operand of the expansion expression.
argsThe runtime expansion expression arguments.

Member Function Documentation

◆ at()

template<typename VT , bool TF, size_t... CEAs>
ReturnType blaze::DVecExpandExpr< VT, TF, CEAs >::at ( size_t  i,
size_t  j 
) const
inline

Checked access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
Exceptions
std::out_of_rangeInvalid matrix access index.

◆ begin()

template<typename VT , bool TF, size_t... CEAs>
ConstIterator blaze::DVecExpandExpr< VT, TF, CEAs >::begin ( size_t  i) const
inline

Returns an iterator to the first non-zero element of row/column i.

Parameters
iThe row/column index.
Returns
Iterator to the first non-zero element of row/column i.

◆ canAlias()

template<typename VT , bool TF, size_t... CEAs>
template<typename T >
bool blaze::DVecExpandExpr< VT, TF, CEAs >::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, size_t... CEAs>
bool blaze::DVecExpandExpr< VT, TF, CEAs >::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.

◆ columns()

template<typename VT , bool TF, size_t... CEAs>
size_t blaze::DVecExpandExpr< VT, TF, CEAs >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ end()

template<typename VT , bool TF, size_t... CEAs>
ConstIterator blaze::DVecExpandExpr< VT, TF, CEAs >::end ( size_t  i) const
inline

Returns an iterator just past the last non-zero element of row/column i.

Parameters
iThe row/column index.
Returns
Iterator just past the last non-zero element of row/column i.

◆ isAliased()

template<typename VT , bool TF, size_t... CEAs>
template<typename T >
bool blaze::DVecExpandExpr< VT, TF, CEAs >::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, size_t... CEAs>
bool blaze::DVecExpandExpr< VT, TF, CEAs >::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, size_t... CEAs>
BLAZE_ALWAYS_INLINE auto blaze::DVecExpandExpr< VT, TF, CEAs >::load ( size_t  i,
size_t  j 
) const
inlinenoexcept

Access to the SIMD elements of the matrix.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
Reference to the accessed values.

◆ operand()

template<typename VT , bool TF, size_t... CEAs>
Operand blaze::DVecExpandExpr< VT, TF, CEAs >::operand ( ) const
inlinenoexcept

Returns the dense vector operand.

Returns
The dense vector operand.

◆ operator()()

template<typename VT , bool TF, size_t... CEAs>
ReturnType blaze::DVecExpandExpr< VT, TF, CEAs >::operator() ( size_t  i,
size_t  j 
) const
inline

2D-access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.

◆ operator*() [1/2]

BLAZE_ALWAYS_INLINE constexpr const DVecExpandExpr< VT, TF, CEAs... > & blaze::Matrix< DVecExpandExpr< VT, TF, CEAs... > , SO >::operator*
constexprnoexceptinherited

CRTP-based conversion operation for constant matrices.

Returns
Constant reference of the actual type of the matrix.

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

◆ operator*() [2/2]

BLAZE_ALWAYS_INLINE constexpr DVecExpandExpr< VT, TF, CEAs... > & blaze::Matrix< DVecExpandExpr< VT, TF, CEAs... > , SO >::operator*
constexprnoexceptinherited

CRTP-based conversion operation for non-constant matrices.

Returns
Mutable reference of the actual type of the matrix.

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

◆ operator~() [1/2]

BLAZE_ALWAYS_INLINE constexpr const DVecExpandExpr< VT, TF, CEAs... > & blaze::Matrix< DVecExpandExpr< VT, TF, CEAs... > , SO >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for constant matrices.

Parameters
matrixThe matrix to be downcast.
Returns
Constant reference of the actual type of the matrix.

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

◆ operator~() [2/2]

BLAZE_ALWAYS_INLINE constexpr DVecExpandExpr< VT, TF, CEAs... > & blaze::Matrix< DVecExpandExpr< VT, TF, CEAs... > , SO >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for non-constant matrices.

Parameters
matrixThe matrix to be downcast.
Returns
Mutable reference of the actual type of the matrix.

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

◆ rows()

template<typename VT , bool TF, size_t... CEAs>
size_t blaze::DVecExpandExpr< VT, TF, CEAs >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

Member Data Documentation

◆ useAssign

template<typename VT , bool TF, size_t... CEAs>
constexpr bool blaze::DVecExpandExpr< VT, TF, CEAs >::useAssign = IsComputation_v<VT> || RequiresEvaluation_v<VT>
staticconstexprprivate

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

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the expansion expression. In case the dense vector operand is a computation or requires an intermediate evaluation, useAssign will be set to 1 and the expansion expression will be evaluated via the assign function family. Otherwise useAssign will be set to 0 and the expression will be evaluated via the function call operator.


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