Expression object for sparse vector-scalar multiplications.The SVecScalarMultExpr class represents the compile time expression for multiplications between a sparse vector and a scalar value.
More...
#include <SVecScalarMultExpr.h>
Inherits blaze::SparseVector< SVecScalarMultExpr< VT, ST, TF >, TF >, blaze::VecScalarMultExpr, and blaze::Computation.
|
class | ConstIterator |
| Iterator over the elements of the sparse vector/scalar multiplication expression. More...
|
|
|
enum | { smpAssignable = 0
} |
| Compilation switch for the expression template assignment strategy.
|
|
typedef SVecScalarMultExpr< VT, ST, TF > | This |
| Type of this SVecScalarMultExpr instance.
|
|
typedef MultTrait< RT, ST >::Type | ResultType |
| Result type for expression template evaluations.
|
|
typedef ResultType::TransposeType | TransposeType |
| Transpose type for expression template evaluations.
|
|
typedef ResultType::ElementType | ElementType |
| Resulting element type.
|
|
typedef const SelectType< returnExpr, ExprReturnType, ElementType >::Type | ReturnType |
| Return type for expression template evaluations.
|
|
typedef SelectType< useAssign, const ResultType, const SVecScalarMultExpr & >::Type | CompositeType |
| Data type for composite expression templates.
|
|
typedef SelectType< IsExpression< VT >::value, const VT, const VT & >::Type | LeftOperand |
| Composite type of the left-hand side sparse vector expression.
|
|
typedef ST | RightOperand |
| Composite type of the right-hand side scalar value.
|
|
typedef SVecScalarMultExpr< VT, ST, TF > | VectorType |
| Type of the vector.
|
|
|
enum | { returnExpr = !IsTemporary<RN>::value
} |
| Compilation switch for the selection of the subscript operator return type. More...
|
|
enum | { useAssign = RequiresEvaluation<VT>::value
} |
| Compilation switch for the serial evaluation strategy of the multiplication expression. More...
|
|
typedef VT::ResultType | RT |
| Result type of the sparse vector expression.
|
|
typedef VT::ReturnType | RN |
| Return type of the sparse vector expression.
|
|
typedef VT::CompositeType | CT |
| Composite type of the sparse vector expression.
|
|
typedef MultExprTrait< RN, ST >::Type | ExprReturnType |
| Expression return type for the subscript operator.
|
|
template<typename VT, typename ST, bool TF>
class blaze::SVecScalarMultExpr< VT, ST, TF >
Expression object for sparse vector-scalar multiplications.
The SVecScalarMultExpr class represents the compile time expression for multiplications between a sparse vector and a scalar value.
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.
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 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.
template<typename VT , typename ST , bool TF>
Constructor for the SVecScalarMultExpr class.
- Parameters
-
vector | The left-hand side sparse vector of the multiplication expression. |
scalar | The right-hand side scalar of the multiplication expression. |
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. |
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.
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.
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.
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.
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.
template<typename VT , typename ST , bool TF>
Returns the left-hand side sparse vector operand.
- Returns
- The left-hand side sparse vector operand.
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.
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.
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.
Conversion operator for non-constant vectors.
- Returns
- Reference of the actual type of the vector.
Conversion operator for constant vectors.
- Returns
- Const reference of the actual type of the vector.
template<typename VT , typename ST , bool TF>
Returns the right-hand side scalar operand.
- Returns
- The right-hand side scalar operand.
template<typename VT , typename ST , bool TF>
Returns the current size/dimension of the vector.
- Returns
- The size of the vector.
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.
The documentation for this class was generated from the following files: