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

Expression object for the sparse vector map() function. More...

#include <SVecMapExpr.h>

Inherits blaze::VecMapExpr< SparseVector< SVecMapExpr< VT, OP, TF >, TF > >, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse vector map expression. More...
 

Public Types

using This = SVecMapExpr< VT, OP, TF >
 Type of this SVecMapExpr instance.
 
using BaseType = VecMapExpr< SparseVector< This, TF > >
 Base type of this SVecMapExpr instance.
 
using ResultType = MapTrait_t< RT, OP >
 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 = decltype(std::declval< OP >()(std::declval< RN >()))
 Return type for expression template evaluations.
 
using CompositeType = If_t< useAssign, const ResultType, const SVecMapExpr & >
 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 Operation = OP
 Data type of the custom unary operation.
 
using VectorType = SVecMapExpr< VT, OP, TF >
 Type of the vector.
 

Public Member Functions

 SVecMapExpr (const VT &sv, OP op) noexcept
 Constructor for the SVecMapExpr 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...
 
ConstIterator begin () const
 Returns an iterator to the first non-zero element of the sparse vector. More...
 
ConstIterator end () const
 Returns an iterator just past the last non-zero element of the sparse vector. 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...
 
ConstIterator find (size_t index) const
 Searches for a specific vector element. More...
 
ConstIterator lowerBound (size_t index) const
 Returns an iterator to the first index not less then the given index. More...
 
ConstIterator upperBound (size_t index) const
 Returns an iterator to the first index greater then the given index. More...
 
Operand operand () const noexcept
 Returns the sparse vector operand. More...
 
Operation operation () const
 Returns a copy of the custom operation. 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...
 
Conversion operators
BLAZE_ALWAYS_INLINE constexpr SVecMapExpr< VT, OP, TF > & operator~ () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE constexpr const SVecMapExpr< VT, OP, TF > & operator~ () const noexcept
 CRTP-based conversion operation for constant vectors. More...
 
constexpr SVecMapExpr< VT, OP, TF > & operator* () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
constexpr const SVecMapExpr< VT, OP, TF > & operator* () const noexcept
 CRTP-based conversion operation 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 Types

using RT = ResultType_t< VT >
 Result type of the sparse vector expression.
 
using RN = ReturnType_t< VT >
 Return type of the sparse vector expression.
 

Private Attributes

Operand sv_
 Sparse vector of the map expression.
 
Operation op_
 The custom unary operation.
 

Static Private Attributes

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

Detailed Description

template<typename VT, typename OP, bool TF>
class blaze::SVecMapExpr< VT, OP, TF >

Expression object for the sparse vector map() function.

The SVecMapExpr class represents the compile time expression for the evaluation of a custom operation on each element of a sparse vector via the map() function.

Constructor & Destructor Documentation

◆ SVecMapExpr()

template<typename VT , typename OP , bool TF>
blaze::SVecMapExpr< VT, OP, TF >::SVecMapExpr ( const VT &  sv,
OP  op 
)
inlinenoexcept

Constructor for the SVecMapExpr class.

Parameters
svThe sparse vector operand of the map expression.
opThe custom unary operation.

Member Function Documentation

◆ at()

template<typename VT , typename OP , bool TF>
ReturnType blaze::SVecMapExpr< VT, OP, 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 OP , bool TF>
ConstIterator blaze::SVecMapExpr< VT, OP, TF >::begin ( ) const
inline

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

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

◆ canAlias()

template<typename VT , typename OP , bool TF>
template<typename T >
bool blaze::SVecMapExpr< VT, OP, 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 OP , bool TF>
bool blaze::SVecMapExpr< VT, OP, 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 OP , bool TF>
ConstIterator blaze::SVecMapExpr< VT, OP, TF >::end ( ) const
inline

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

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

◆ find()

template<typename VT , typename OP , bool TF>
ConstIterator blaze::SVecMapExpr< VT, OP, TF >::find ( size_t  index) const
inline

Searches for a specific vector element.

Parameters
indexThe index of the search element.
Returns
Iterator to the element in case the index is found, end() iterator otherwise.

◆ isAliased()

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

◆ lowerBound()

template<typename VT , typename OP , bool TF>
ConstIterator blaze::SVecMapExpr< VT, OP, TF >::lowerBound ( size_t  index) const
inline

Returns an iterator to the first index not less then the given index.

Parameters
indexThe index of the search element.
Returns
Iterator to the first index not less then the given index, end() iterator otherwise.

◆ nonZeros()

template<typename VT , typename OP , bool TF>
size_t blaze::SVecMapExpr< VT, OP, 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 , typename OP , bool TF>
Operand blaze::SVecMapExpr< VT, OP, TF >::operand ( ) const
inlinenoexcept

Returns the sparse vector operand.

Returns
The sparse vector operand.

◆ operation()

template<typename VT , typename OP , bool TF>
Operation blaze::SVecMapExpr< VT, OP, TF >::operation ( ) const
inline

Returns a copy of the custom operation.

Returns
A copy of the custom operation.

◆ operator*() [1/2]

BLAZE_ALWAYS_INLINE constexpr const SVecMapExpr< VT, OP, TF > & blaze::Vector< SVecMapExpr< VT, OP, 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 SVecMapExpr< VT, OP, TF > & blaze::Vector< SVecMapExpr< VT, OP, 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 OP , bool TF>
ReturnType blaze::SVecMapExpr< VT, OP, 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 SVecMapExpr< VT, OP, TF > & blaze::Vector< SVecMapExpr< VT, OP, 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 SVecMapExpr< VT, OP, TF > & blaze::Vector< SVecMapExpr< VT, OP, 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 , typename OP , bool TF>
size_t blaze::SVecMapExpr< VT, OP, TF >::size ( ) const
inlinenoexcept

Returns the current size/dimension of the vector.

Returns
The size of the vector.

◆ upperBound()

template<typename VT , typename OP , bool TF>
ConstIterator blaze::SVecMapExpr< VT, OP, TF >::upperBound ( size_t  index) const
inline

Returns an iterator to the first index greater then the given index.

Parameters
indexThe index of the search element.
Returns
Iterator to the first index greater then the given index, end() iterator otherwise.

Member Data Documentation

◆ useAssign

template<typename VT , typename OP , bool TF>
constexpr bool blaze::SVecMapExpr< VT, OP, TF >::useAssign = RequiresEvaluation_v<VT>
staticconstexprprivate

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

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