Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::DVecSVecAddExpr< VT1, VT2, TF > Class Template Reference

Expression object for dense vector-sparse vector additions.The DVecSVecAddExpr class represents the compile time expression for additions between a dense vector and a sparse vector. More...

#include <DVecSVecAddExpr.h>

Inherits blaze::VecVecAddExpr< DenseVector< DVecSVecAddExpr< VT1, VT2, TF >, TF > >, and blaze::Computation.

Public Types

enum  : bool { simdEnabled = false }
 Compilation switch for the expression template evaluation strategy.
 
enum  : bool { smpAssignable = false }
 Compilation switch for the expression template assignment strategy.
 
using This = DVecSVecAddExpr< VT1, VT2, TF >
 Type of this DVecSVecAddExpr instance.
 
using ResultType = AddTrait_< RT1, RT2 >
 Result type for expression template evaluations.
 
using TransposeType = TransposeType_< ResultType >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_< ResultType >
 Resulting element type.
 
using ReturnType = const IfTrue_< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = const ResultType
 Data type for composite expression templates.
 
using LeftOperand = If_< IsExpression< VT1 >, const VT1, const VT1 &>
 Composite type of the left-hand side dense vector expression.
 
using RightOperand = If_< IsExpression< VT2 >, const VT2, const VT2 &>
 Composite type of the right-hand side sparse vector expression.
 
using VectorType = VT
 Type of the vector.
 

Public Member Functions

 DVecSVecAddExpr (const VT1 &lhs, const VT2 &rhs) noexcept
 Constructor for the DVecSVecAddExpr 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...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side dense vector operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side 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...
 
BLAZE_ALWAYS_INLINE VectorTypeoperator~ () noexcept
 Conversion operator for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE const VectorTypeoperator~ () const noexcept
 Conversion operator for constant vectors. More...
 

Private Types

enum  : bool { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
using RT1 = ResultType_< VT1 >
 Result type of the left-hand side dense vector expression.
 
using RT2 = ResultType_< VT2 >
 Result type of the right-hand side sparse vector expression.
 
using RN1 = ReturnType_< VT1 >
 Return type of the left-hand side dense vector expression.
 
using RN2 = ReturnType_< VT2 >
 Return type of the right-hand side sparse vector expression.
 
using CT1 = CompositeType_< VT1 >
 Composite type of the left-hand side dense vector expression.
 
using CT2 = CompositeType_< VT2 >
 Composite type of the right-hand side sparse vector expression.
 
using TT1 = TransposeType_< VT1 >
 Transpose type of the left-hand side dense vector expression.
 
using TT2 = TransposeType_< VT2 >
 Transpose type of the right-hand side sparse vector expression.
 
using ExprReturnType = AddExprTrait_< RN1, RN2 >
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side dense vector of the addition expression.
 
RightOperand rhs_
 Right-hand side sparse vector of the addition expression.
 

Detailed Description

template<typename VT1, typename VT2, bool TF>
class blaze::DVecSVecAddExpr< VT1, VT2, TF >

Expression object for dense vector-sparse vector additions.

The DVecSVecAddExpr class represents the compile time expression for additions between a dense vector and a sparse vector.

Member Enumeration Documentation

◆ anonymous enum

template<typename VT1, typename VT2, bool TF>
anonymous enum : bool
private

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 either 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.

Constructor & Destructor Documentation

◆ DVecSVecAddExpr()

template<typename VT1, typename VT2, bool TF>
blaze::DVecSVecAddExpr< VT1, VT2, TF >::DVecSVecAddExpr ( const VT1 &  lhs,
const VT2 &  rhs 
)
inlineexplicitnoexcept

Constructor for the DVecSVecAddExpr class.

Parameters
lhsThe left-hand side dense vector operand of the addition expression.
rhsThe right-hand side sparse vector operand of the addition expression.

Member Function Documentation

◆ at()

template<typename VT1, typename VT2, bool TF>
ReturnType blaze::DVecSVecAddExpr< VT1, VT2, 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 VT1, typename VT2, bool TF>
template<typename T >
bool blaze::DVecSVecAddExpr< VT1, VT2, 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 effect is detected, false otherwise.

◆ isAliased()

template<typename VT1, typename VT2, bool TF>
template<typename T >
bool blaze::DVecSVecAddExpr< VT1, VT2, 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 VT1, typename VT2, bool TF>
LeftOperand blaze::DVecSVecAddExpr< VT1, VT2, TF >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.

◆ operator[]()

template<typename VT1, typename VT2, bool TF>
ReturnType blaze::DVecSVecAddExpr< VT1, VT2, 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]

template<typename VT, bool TF>
BLAZE_ALWAYS_INLINE VectorType& blaze::Vector< VT, TF >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.

◆ operator~() [2/2]

template<typename VT, bool TF>
BLAZE_ALWAYS_INLINE const VectorType& blaze::Vector< VT, TF >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant vectors.

Returns
Const reference of the actual type of the vector.

◆ rightOperand()

template<typename VT1, typename VT2, bool TF>
RightOperand blaze::DVecSVecAddExpr< VT1, VT2, TF >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side sparse vector operand.

Returns
The right-hand side sparse vector operand.

◆ size()

template<typename VT1, typename VT2, bool TF>
size_t blaze::DVecSVecAddExpr< VT1, VT2, 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 file: