Expression object for the sparse vector map() function.The SVecMapExpr class represents the compile time expression for the evaluation of a custom operation on each element of a sparse vector via the map() function.
More...
#include <SVecMapExpr.h>
Inherits blaze::VecMapExpr< SparseVector< SVecMapExpr< VT, OP, TF >, TF > >, and blaze::Computation.
|
using | This = SVecMapExpr< VT, OP, TF > |
| Type of this SVecMapExpr instance.
|
|
using | BaseType = SparseVector< This, TF > |
| Base type of this SVecMapExpr instance.
|
|
using | ResultType = MapTrait_t< RT, OP > |
| 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 = decltype(std::declval< OP >()(std::declval< RN >())) |
| Return type for expression template evaluations.
|
|
using | CompositeType = If_t< useAssign, const ResultType, const SVecMapExpr &> |
| Data type for composite expression templates.
|
|
using | Operand = If_t< IsExpression_v< VT >, const VT, const VT &> |
| Composite data type of the sparse vector expression.
|
|
using | Operation = OP |
| Data type of the custom unary operation.
|
|
using | VectorType = SVecMapExpr< VT, OP, TF > |
| Type of the vector.
|
|
|
static constexpr bool | smpAssignable = VT::smpAssignable |
| 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.
|
|
template<typename VT, typename OP, bool TF>
class blaze::SVecMapExpr< VT, OP, TF >
Expression object for the sparse vector map() function.
The SVecMapExpr class represents the compile time expression for the evaluation of a custom operation on each element of a sparse vector via the map() function.
◆ SVecMapExpr()
template<typename VT , typename OP , bool TF>
Constructor for the SVecMapExpr class.
- Parameters
-
sv | The sparse vector operand of the map expression. |
op | The custom unary operation. |
◆ at()
template<typename VT , typename OP , 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 OP , 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 OP , 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 VT , typename OP , 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 VT , typename OP , 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 OP , 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 OP , 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.
◆ lowerBound()
template<typename VT , typename OP , 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 OP , bool TF>
Returns the number of non-zero elements in the sparse vector.
- Returns
- The number of non-zero elements in the sparse vector.
◆ operand()
template<typename VT , typename OP , bool TF>
Returns the sparse vector operand.
- Returns
- The sparse vector operand.
◆ operation()
template<typename VT , typename OP , bool TF>
Returns a copy of the custom operation.
- Returns
- A copy of the custom operation.
◆ operator[]()
template<typename VT , typename OP , 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]
Conversion operator for non-constant vectors.
- Returns
- Reference of the actual type of the vector.
◆ operator~() [2/2]
Conversion operator for constant vectors.
- Returns
- Const reference of the actual type of the vector.
◆ size()
template<typename VT , typename OP , bool TF>
Returns the current size/dimension of the vector.
- Returns
- The size of the vector.
◆ upperBound()
template<typename VT , typename OP , 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.
◆ useAssign
template<typename VT , typename OP , bool TF>
Compilation switch for the serial evaluation strategy of the map expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the map expression. In case the given sparse vector expression of type VT requires an intermediate evaluation, useAssign will be set to 1 and the map 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: