Classes | Public Types | Public Member Functions | Static Public Attributes | Private Types | Private Attributes | Static Private Attributes | List of all members
blaze::SVecScalarMultExpr< VT, ST, TF > Class Template Reference

Expression object for sparse vector-scalar multiplications.The SVecScalarMultExpr class represents the compile time expression for multiplications between a sparse vector and a scalar value. More...

#include <SVecScalarMultExpr.h>

Inherits blaze::VecScalarMultExpr< SparseVector< SVecScalarMultExpr< VT, ST, TF >, TF > >, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse vector/scalar multiplication expression. More...
 

Public Types

using This = SVecScalarMultExpr< VT, ST, TF >
 Type of this SVecScalarMultExpr instance.
 
using BaseType = SparseVector< This, TF >
 Base type of this SVecScalarMultExpr instance.
 
using ResultType = MultTrait_t< RT, ST >
 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 = const If_t< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = If_t< useAssign, const ResultType, const SVecScalarMultExpr &>
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< VT >, const VT, const VT &>
 Composite type of the left-hand side sparse vector expression.
 
using RightOperand = ST
 Composite type of the right-hand side scalar value.
 
using VectorType = SVecScalarMultExpr< VT, ST, TF >
 Type of the vector.
 

Public Member Functions

 SVecScalarMultExpr (const VT &vector, ST scalar) noexcept
 Constructor for the SVecScalarMultExpr 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...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side sparse vector operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side scalar 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...
 
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 = false
 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.
 
using CT = CompositeType_t< VT >
 Composite type of the sparse vector expression.
 
using ExprReturnType = decltype(std::declval< RN >() *std::declval< ST >())
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand vector_
 Left-hand side sparse vector of the multiplication expression.
 
RightOperand scalar_
 Right-hand side scalar of the multiplication expression.
 

Static Private Attributes

static constexpr bool returnExpr = !IsTemporary_v<RN>
 Compilation switch for the selection of the subscript operator return type. More...
 
static constexpr bool useAssign = RequiresEvaluation_v<VT>
 Compilation switch for the serial evaluation strategy of the multiplication expression. More...
 

Detailed Description

template<typename VT, typename ST, bool TF>
class blaze::SVecScalarMultExpr< VT, ST, TF >

Expression object for sparse vector-scalar multiplications.

The SVecScalarMultExpr class represents the compile time expression for multiplications between a sparse vector and a scalar value.

Constructor & Destructor Documentation

◆ SVecScalarMultExpr()

template<typename VT , typename ST , bool TF>
blaze::SVecScalarMultExpr< VT, ST, TF >::SVecScalarMultExpr ( const VT &  vector,
ST  scalar 
)
inlineexplicitnoexcept

Constructor for the SVecScalarMultExpr class.

Parameters
vectorThe left-hand side sparse vector of the multiplication expression.
scalarThe right-hand side scalar of the multiplication expression.

Member Function Documentation

◆ at()

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

◆ end()

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

◆ leftOperand()

template<typename VT , typename ST , bool TF>
LeftOperand blaze::SVecScalarMultExpr< VT, ST, TF >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side sparse vector operand.

Returns
The left-hand side sparse vector operand.

◆ lowerBound()

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

◆ operator[]()

template<typename VT , typename ST , bool TF>
ReturnType blaze::SVecScalarMultExpr< VT, ST, 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< SVecScalarMultExpr< VT, ST, 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< SVecScalarMultExpr< VT, ST, TF > , TF >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant vectors.

Returns
Const reference of the actual type of the vector.

◆ rightOperand()

template<typename VT , typename ST , bool TF>
RightOperand blaze::SVecScalarMultExpr< VT, ST, TF >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side scalar operand.

Returns
The right-hand side scalar operand.

◆ size()

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

Returns the current size/dimension of the vector.

Returns
The size of the vector.

◆ upperBound()

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

◆ returnExpr

template<typename VT , typename ST , bool TF>
constexpr bool blaze::SVecScalarMultExpr< VT, ST, TF >::returnExpr = !IsTemporary_v<RN>
staticprivate

Compilation switch for the selection of the subscript operator return type.

The returnExpr compile time constant expression is a compilation switch for the selection of the ReturnType. If the vector operand returns a temporary vector or matrix, returnExpr will be set to false and the subscript operator will return it's result by value. Otherwise returnExpr will be set to true and the subscript operator may return it's result as an expression.

◆ useAssign

template<typename VT , typename ST , bool TF>
constexpr bool blaze::SVecScalarMultExpr< VT, ST, TF >::useAssign = RequiresEvaluation_v<VT>
staticprivate

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

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