Expression object for sparse vector-dense vector divisions.
More...
#include <SVecDVecDivExpr.h>
Inherits blaze::VecVecDivExpr< SparseVector< SVecDVecDivExpr< VT1, VT2, TF >, TF > >, and blaze::Computation.
|
class | ConstIterator |
| Iterator over the elements of the sparse vector-dense vector division expression. More...
|
|
|
using | This = SVecDVecDivExpr< VT1, VT2, TF > |
| Type of this SVecDVecDivExpr instance.
|
|
using | BaseType = VecVecDivExpr< SparseVector< This, TF > > |
| Base type of this SVecDVecDivExpr instance.
|
|
using | ResultType = DivTrait_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 SVecDVecDivExpr & > |
| Data type for composite expression templates.
|
|
using | LeftOperand = If_t< IsExpression_v< VT1 >, const VT1, const VT1 & > |
| Composite type of the left-hand side sparse 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 = SVecDVecDivExpr< VT1, VT2, TF > |
| Type of the vector.
|
|
|
static constexpr bool | smpAssignable = false |
| Compilation switch for the expression template assignment strategy.
|
|
static constexpr bool | transposeFlag |
| Transpose flag of the vector.
|
|
|
using | RT1 = ResultType_t< VT1 > |
| Result type of the left-hand side sparse 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 sparse 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 sparse vector expression.
|
|
using | CT2 = CompositeType_t< VT2 > |
| Composite 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 sparse vector of the division expression.
|
|
RightOperand | rhs_ |
| Right-hand side dense vector of the division expression.
|
|
|
static constexpr bool | returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> ) |
| Compilation switch for the selection of the subscript operator return type. More...
|
|
static constexpr bool | useAssign = ( RequiresEvaluation_v<VT1> || RequiresEvaluation_v<VT2> ) |
| Compilation switch for the evaluation strategy of the division expression. More...
|
|
template<typename VT1, typename VT2, bool TF>
class blaze::SVecDVecDivExpr< VT1, VT2, TF >
Expression object for sparse vector-dense vector divisions.
The SVecDVecDivExpr class represents the compile time expression for componentwise divisions between a sparse vector and a dense vector.
◆ SVecDVecDivExpr()
template<typename VT1 , typename VT2 , bool TF>
Constructor for the SVecDVecDivExpr class.
- Parameters
-
lhs | The left-hand side sparse vector operand of the division expression. |
rhs | The right-hand side dense vector operand of the division 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 sparse vector.
- Returns
- Iterator to the first non-zero element of the sparse 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.
◆ end()
template<typename VT1 , typename VT2 , bool TF>
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 VT1 , typename VT2 , bool TF>
Searches for a specific vector element.
- Parameters
-
index | The index of the search element. |
- Returns
- Iterator to the element in case the index is found, end() iterator otherwise.
◆ 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.
◆ leftOperand()
template<typename VT1 , typename VT2 , bool TF>
Returns the left-hand side sparse vector operand.
- Returns
- The left-hand side sparse vector operand.
◆ lowerBound()
template<typename VT1 , typename VT2 , bool TF>
Returns an iterator to the first index not less then the given index.
- Parameters
-
index | The index of the search element. |
- Returns
- Iterator to the first index not less then the given index, end() iterator otherwise.
◆ nonZeros()
template<typename VT1 , typename VT2 , bool TF>
Returns the number of non-zero elements in the sparse vector.
- Returns
- The number of non-zero elements in the sparse vector.
◆ operator*() [1/2]
|
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]
|
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 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]
|
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]
|
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.
◆ 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.
◆ upperBound()
template<typename VT1 , typename VT2 , bool TF>
Returns an iterator to the first index greater then the given index.
- Parameters
-
index | The index of the search element. |
- Returns
- Iterator to the first index greater then the given index, end() iterator otherwise.
◆ 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 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 VT1 , typename VT2 , bool TF>
constexpr bool blaze::SVecDVecDivExpr< VT1, VT2, TF >::useAssign = ( RequiresEvaluation_v<VT1> || RequiresEvaluation_v<VT2> ) |
|
staticconstexprprivate |
Compilation switch for the evaluation strategy of the division expression.
The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the division expression. In case either the sparse or the dense vector operand requires an intermediate evaluation, useAssign will be set to true and the division expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the subscript operator.
The documentation for this class was generated from the following files: