Expression object for divisions of a sparse vector by a scalar.
More...
#include <SVecScalarDivExpr.h>
Inherits blaze::VecScalarDivExpr< SparseVector< SVecScalarDivExpr< VT, ST, TF >, TF > >, and blaze::Computation.
|
class | ConstIterator |
| Iterator over the elements of the sparse vector/scalar multiplication expression. More...
|
|
|
using | This = SVecScalarDivExpr< VT, ST, TF > |
| Type of this SVecScalarDivExpr instance.
|
|
using | BaseType = VecScalarDivExpr< SparseVector< This, TF > > |
| Base type of this SVecScalarDivExpr instance.
|
|
using | ResultType = DivTrait_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 SVecScalarDivExpr & > |
| 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 = SVecScalarDivExpr< VT, ST, 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 | 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.
|
|
|
LeftOperand | vector_ |
| Left-hand side sparse vector of the division expression.
|
|
RightOperand | scalar_ |
| Right-hand side scalar of the division expression.
|
|
|
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...
|
|
template<typename VT, typename ST, bool TF>
class blaze::SVecScalarDivExpr< VT, ST, TF >
Expression object for divisions of a sparse vector by a scalar.
The SVecScalarDivExpr class represents the compile time expression for divisions of sparse vectors by scalar values.
◆ SVecScalarDivExpr()
template<typename VT , typename ST , bool TF>
Constructor for the SVecScalarDivExpr class.
- Parameters
-
vector | The left-hand side sparse vector of the division expression. |
scalar | The right-hand side scalar of the division expression. |
◆ at()
template<typename VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , bool TF>
Returns the left-hand side sparse vector operand.
- Returns
- The left-hand side sparse vector operand.
◆ lowerBound()
template<typename VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , 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 VT , typename ST , bool TF>
Returns the right-hand side scalar operand.
- Returns
- The right-hand side scalar operand.
◆ size()
template<typename VT , typename ST , bool TF>
Returns the current size/dimension of the vector.
- Returns
- The size of the vector.
◆ upperBound()
template<typename VT , typename ST , 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 VT , typename ST , 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 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>
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 either 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: