Expression object for dense vector-dense vector subtractions.
More...
#include <DVecDVecSubExpr.h >
Inherits blaze::VecVecSubExpr< DenseVector< DVecDVecSubExpr< VT1, VT2, TF >, TF > > , and blaze::Computation .
using This = DVecDVecSubExpr <VT1,VT2,TF>
Type of this DVecDVecSubExpr instance.
using BaseType = VecVecSubExpr < DenseVector <This ,TF> >
Base type of this DVecDVecSubExpr instance.
using ResultType = SubTrait_t <RT1 ,RT2 >
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 DVecDVecSubExpr & >
Data type for composite expression templates.
using LeftOperand = If_t < IsExpression_v <VT1>, const VT1, const VT1& >
Composite type of the left-hand side dense vector expression.
using RightOperand = If_t < IsExpression_v <VT2>, const VT2, const VT2& >
Composite type of the right-hand side dense vector expression.
using VectorType
Type of the vector.
DVecDVecSubExpr (const VT1 &lhs, const VT2 &rhs) noexcept
Constructor for the DVecDVecSubExpr class.
ReturnType operator[] (size_t index) const
Subscript operator for the direct access to the vector elements.
ReturnType at (size_t index) const
Checked access to the vector elements.
BLAZE_ALWAYS_INLINE auto load (size_t index) const noexcept
Access to the SIMD elements of the vector.
ConstIterator begin () const
Returns an iterator to the first non-zero element of the dense vector.
ConstIterator end () const
Returns an iterator just past the last non-zero element of the dense vector.
size_t size () const noexcept
Returns the current size/dimension of the vector.
LeftOperand leftOperand () const noexcept
Returns the left-hand side dense vector operand.
RightOperand rightOperand () const noexcept
Returns the right-hand side dense vector operand.
template<typename T>
bool canAlias (const T *alias) const noexcept
Returns whether the expression can alias with the given address alias .
template<typename T>
bool isAliased (const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias .
bool isAligned () const noexcept
Returns whether the operands of the expression are properly aligned in memory.
bool canSMPAssign () const noexcept
Returns whether the expression can be used in SMP assignments.
BLAZE_ALWAYS_INLINE constexpr DVecDVecSubExpr < VT1, VT2, TF > & operator~ () noexcept
CRTP-based conversion operation for non-constant vectors.
BLAZE_ALWAYS_INLINE constexpr const DVecDVecSubExpr < VT1, VT2, TF > & operator~ () const noexcept
CRTP-based conversion operation for constant vectors.
constexpr DVecDVecSubExpr < VT1, VT2, TF > & operator* () noexcept
CRTP-based conversion operation for non-constant vectors.
constexpr const DVecDVecSubExpr < VT1, VT2, TF > & operator* () const noexcept
CRTP-based conversion operation for constant vectors.
static constexpr bool simdEnabled
Compilation switch for the expression template evaluation strategy.
static constexpr bool smpAssignable = ( VT1::smpAssignable && VT2::smpAssignable )
Compilation switch for the expression template assignment strategy.
static constexpr size_t SIMDSIZE = SIMDTrait <ElementType >::size
The number of elements packed within a single SIMD element.
static constexpr bool transposeFlag
Transpose flag of the vector.
using RT1 = ResultType_t <VT1>
Result type of the left-hand side dense vector expression.
using RT2 = ResultType_t <VT2>
Result type of the right-hand side dense vector expression.
using RN1 = ReturnType_t <VT1>
Return type of the left-hand side dense vector expression.
using RN2 = ReturnType_t <VT2>
Return type of the right-hand side dense vector expression.
using CT1 = CompositeType_t <VT1>
Composite type of the left-hand side dense vector expression.
using CT2 = CompositeType_t <VT2>
Composite type of the right-hand side dense vector expression.
using ET1 = ElementType_t <VT1>
Element type of the left-hand side dense vector expression.
using ET2 = ElementType_t <VT2>
Element type of the right-hand side dense vector expression.
using ExprReturnType = decltype( std::declval<RN1 >() - std::declval<RN2 >() )
Expression return type for the subscript operator.
LeftOperand lhs_
Left-hand side dense vector of the subtraction expression.
RightOperand rhs_
Right-hand side dense vector of the subtraction expression.
static constexpr bool returnExpr = ( !IsTemporary_v <RN1 > && !IsTemporary_v <RN2 > )
Compilation switch for the selection of the subscript operator return type.
static constexpr bool useAssign
Compilation switch for the serial evaluation strategy of the subtraction expression.
template<typename VT1, typename VT2, bool TF>
class blaze::DVecDVecSubExpr< VT1, VT2, TF >
Expression object for dense vector-dense vector subtractions.
The DVecDVecSubExpr class represents the compile time expression for subtractions between dense vectors.
◆ DVecDVecSubExpr()
template<typename VT1, typename VT2, bool TF>
Constructor for the DVecDVecSubExpr class.
Parameters
lhs The left-hand side operand of the subtraction expression.
rhs The right-hand side operand of the subtraction expression.
◆ at()
template<typename VT1, typename VT2, bool TF>
Checked access to the vector elements.
Parameters
index Access index. The index has to be in the range .
Returns The resulting value.
Exceptions
std::out_of_range Invalid vector access index.
◆ begin()
template<typename VT1, typename VT2, bool TF>
Returns an iterator to the first non-zero element of the dense vector.
Returns Iterator to the first non-zero element of the dense vector.
◆ canAlias()
template<typename VT1, typename VT2, bool TF>
template<typename T>
Returns whether the expression can alias with the given address alias .
Parameters
alias The alias to be checked.
Returns true in case the expression can alias, false otherwise.
◆ canSMPAssign()
template<typename VT1, typename VT2, bool TF>
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 VT1, typename VT2, bool TF>
Returns an iterator just past the last non-zero element of the dense vector.
Returns Iterator just past the last non-zero element of the dense vector.
◆ isAliased()
template<typename VT1, typename VT2, bool TF>
template<typename T>
Returns whether the expression is aliased with the given address alias .
Parameters
alias The alias to be checked.
Returns true in case an alias effect is detected, false otherwise.
◆ isAligned()
template<typename VT1, typename VT2, bool TF>
Returns whether the operands of the expression are properly aligned in memory.
Returns true in case the operands are aligned, false if not.
◆ leftOperand()
template<typename VT1, typename VT2, bool TF>
Returns the left-hand side dense vector operand.
Returns The left-hand side dense vector operand.
◆ load()
template<typename VT1, typename VT2, bool TF>
Access to the SIMD elements of the vector.
Parameters
index Access index. The index has to be in the range .
Returns Reference to the accessed values.
◆ operator*() [1/2]
constexpr noexcept inherited
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]
constexpr noexcept inherited
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 VT1, typename VT2, bool TF>
Subscript operator for the direct access to the vector elements.
Parameters
index Access index. The index has to be in the range .
Returns The resulting value.
◆ operator~() [1/2]
constexpr noexcept inherited
CRTP-based conversion operation for constant vectors.
Deprecated
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 .
Deprecated
◆ operator~() [2/2]
constexpr noexcept inherited
CRTP-based conversion operation for non-constant vectors.
Deprecated
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 .
Deprecated
◆ rightOperand()
template<typename VT1, typename VT2, bool TF>
Returns the right-hand side dense vector operand.
Returns The right-hand side dense vector operand.
◆ size()
template<typename VT1, typename VT2, bool TF>
Returns the current size/dimension of the vector.
Returns The size of the vector.
◆ returnExpr
template<typename VT1, typename VT2, bool TF>
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 0 and the subscript operator will return it's result by value. Otherwise returnExpr will be set to 1 and the subscript operator may return it's result as an expression.
◆ simdEnabled
template<typename VT1, typename VT2, bool TF>
Initial value: =
constexpr bool HasSIMDSub_v
Auxiliary variable template for the HasSIMDSub type trait.
Definition HasSIMDSub.h:187
Compilation switch for the expression template evaluation strategy.
◆ useAssign
template<typename VT1, typename VT2, bool TF>
Initial value: =
static constexpr bool returnExpr
Compilation switch for the selection of the subscript operator return type.
Definition DMatDMatAddExpr.h:117
constexpr bool RequiresEvaluation_v
Auxiliary variable template for the RequiresEvaluation type trait.
Definition RequiresEvaluation.h:91
Compilation switch for the serial evaluation strategy of the subtraction expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the subtraction expression. In case either of the two dense vector operands requires an intermediate evaluation or the subscript operator can only return by value, useAssign will be set to 1 and the subtraction 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 file: