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

Expression object for the forced evaluation of sparse vectors.The SVecEvalExpr class represents the compile time expression for the forced evaluation of a sparse vector. More...

#include <SVecEvalExpr.h>

Inherits blaze::VecEvalExpr< SparseVector< SVecEvalExpr< VT, TF >, TF > >, and blaze::Computation.

Public Types

using This = SVecEvalExpr< VT, TF >
 Type of this SVecEvalExpr instance.
 
using BaseType = SparseVector< This, TF >
 Base type of this SVecEvalExpr 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 = const ResultType
 Data type for composite expression templates.
 
using Operand = If_t< IsExpression_v< VT >, const VT, const VT & >
 Composite data type of the sparse vector expression.
 
using VectorType = SVecEvalExpr< VT, TF >
 Type of the vector.
 

Public Member Functions

 SVecEvalExpr (const VT &sv) noexcept
 Constructor for the SVecEvalExpr 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...
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse vector. More...
 
Operand operand () const noexcept
 Returns the 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 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 smpAssignable = VT::smpAssignable
 Compilation switch for the expression template assignment strategy.
 
static constexpr bool transposeFlag
 Transpose flag of the vector.
 

Private Attributes

Operand sv_
 Sparse vector of the evaluation expression.
 

Detailed Description

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

Expression object for the forced evaluation of sparse vectors.

The SVecEvalExpr class represents the compile time expression for the forced evaluation of a sparse vector.

Constructor & Destructor Documentation

◆ SVecEvalExpr()

template<typename VT , bool TF>
blaze::SVecEvalExpr< VT, TF >::SVecEvalExpr ( const VT &  sv)
inlineexplicitnoexcept

Constructor for the SVecEvalExpr class.

Parameters
svThe sparse vector operand of the evaluation expression.

Member Function Documentation

◆ at()

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

◆ canAlias()

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

◆ isAliased()

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

◆ nonZeros()

template<typename VT , bool TF>
size_t blaze::SVecEvalExpr< VT, TF >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the sparse vector.

Returns
The number of non-zero elements in the sparse vector.

◆ operand()

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

Returns the sparse vector operand.

Returns
The sparse vector operand.

◆ operator[]()

template<typename VT , bool TF>
ReturnType blaze::SVecEvalExpr< 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 VectorType& blaze::Vector< SVecEvalExpr< VT, TF > , TF >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.

◆ operator~() [2/2]

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

Conversion operator for constant vectors.

Returns
Const reference of the actual type of the vector.

◆ size()

template<typename VT , bool TF>
size_t blaze::SVecEvalExpr< 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 files: