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

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

#include <SVecNoAliasExpr.h>

Inherits blaze::VecNoAliasExpr< SparseVector< SVecNoAliasExpr< VT, TF >, TF > >, and blaze::Modification< VT >.

Public Types

using This = SVecNoAliasExpr< VT, TF >
 Type of this SVecNoAliasExpr instance.
 
using BaseType = VecNoAliasExpr< SparseVector< This, TF > >
 Base type of this SVecNoAliasExpr 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 SVecNoAliasExpr & >
 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 sparse vector expression.
 
using VectorType = SVecNoAliasExpr< VT, TF >
 Type of the vector.
 

Public Member Functions

 SVecNoAliasExpr (const VT &sv) noexcept
 Constructor for the SVecNoAliasExpr 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...
 
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 SVecNoAliasExpr< VT, TF > & operator~ () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE constexpr const SVecNoAliasExpr< VT, TF > & operator~ () const noexcept
 CRTP-based conversion operation for constant vectors. More...
 
constexpr SVecNoAliasExpr< VT, TF > & operator* () noexcept
 CRTP-based conversion operation for non-constant vectors. More...
 
constexpr const SVecNoAliasExpr< VT, 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 Member Functions

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

Private Attributes

Operand sv_
 Sparse vector of the no-alias expression.
 

Detailed Description

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

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

The SVecNoAliasExpr class represents the compile time expression for the non-aliased evaluation of a sparse vector.

Constructor & Destructor Documentation

◆ SVecNoAliasExpr()

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

Constructor for the SVecNoAliasExpr class.

Parameters
svThe sparse vector operand of the no-alias expression.

Member Function Documentation

◆ at()

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

◆ end()

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

◆ lowerBound()

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

Returns the sparse vector operand.

Returns
The sparse vector operand.

◆ operator*() [1/2]

BLAZE_ALWAYS_INLINE constexpr const SVecNoAliasExpr< VT, TF > & blaze::Vector< SVecNoAliasExpr< 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 SVecNoAliasExpr< VT, TF > & blaze::Vector< SVecNoAliasExpr< 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::SVecNoAliasExpr< 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 SVecNoAliasExpr< VT, TF > & blaze::Vector< SVecNoAliasExpr< 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 SVecNoAliasExpr< VT, TF > & blaze::Vector< SVecNoAliasExpr< 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::SVecNoAliasExpr< VT, TF >::size ( ) const
inlinenoexcept

Returns the current size/dimension of the vector.

Returns
The size of the vector.

◆ upperBound()

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

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