Expression object for sparse matrix-scalar multiplications.The SMatScalarMult class represents the compile time expression for multiplications between a sparse matrix and a scalar value.
More...
#include <SMatScalarMultExpr.h>
Inherits blaze::SparseMatrix< SMatScalarMultExpr< MT, ST, SO >, SO >, blaze::MatScalarMultExpr, and blaze::Computation.
|
class | ConstIterator |
| Iterator over the elements of the sparse matrix/scalar multiplication expression. More...
|
|
|
enum | : bool { smpAssignable = false
} |
| Compilation switch for the expression template assignment strategy.
|
|
typedef SMatScalarMultExpr< MT, ST, SO > | This |
| Type of this SMatScalarMultExpr instance.
|
|
typedef MultTrait_< RT, ST > | ResultType |
| Result type for expression template evaluations.
|
|
typedef OppositeType_< ResultType > | OppositeType |
| Result type with opposite storage order for expression template evaluations.
|
|
typedef TransposeType_< ResultType > | TransposeType |
| Transpose type for expression template evaluations.
|
|
typedef ElementType_< ResultType > | ElementType |
| Resulting element type.
|
|
typedef const IfTrue_< returnExpr, ExprReturnType, ElementType > | ReturnType |
| Return type for expression template evaluations.
|
|
typedef IfTrue_< useAssign, const ResultType, const SMatScalarMultExpr & > | CompositeType |
| Data type for composite expression templates.
|
|
typedef If_< IsExpression< MT >, const MT, const MT & > | LeftOperand |
| Composite data type of the sparse matrix expression.
|
|
typedef ST | RightOperand |
| Composite type of the right-hand side scalar value.
|
|
typedef SMatScalarMultExpr< MT, ST, SO > | MatrixType |
| Type of the matrix.
|
|
|
enum | : bool { returnExpr = !IsTemporary<RN>::value
} |
| Compilation switch for the selection of the subscript operator return type. More...
|
|
enum | : bool { useAssign = RequiresEvaluation<MT>::value
} |
| Compilation switch for the serial evaluation strategy of the multiplication expression. More...
|
|
typedef ResultType_< MT > | RT |
| Result type of the sparse matrix expression.
|
|
typedef ReturnType_< MT > | RN |
| Return type of the sparse matrix expression.
|
|
typedef CompositeType_< MT > | CT |
| Composite type of the sparse matrix expression.
|
|
typedef MultExprTrait_< RN, ST > | ExprReturnType |
| Expression return type for the subscript operator.
|
|
template<typename MT, typename ST, bool SO>
class blaze::SMatScalarMultExpr< MT, ST, SO >
Expression object for sparse matrix-scalar multiplications.
The SMatScalarMult class represents the compile time expression for multiplications between a sparse matrix and a scalar value.
template<typename MT , typename ST , bool SO>
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 matrix 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 MT , typename ST , bool SO>
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 given sparse matrix expression of type MT 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 MT , typename ST , bool SO>
Constructor for the SMatScalarMultExpr class.
- Parameters
-
matrix | The left-hand side sparse matrix of the multiplication expression. |
scalar | The right-hand side scalar of the multiplication expression. |
template<typename MT , typename ST , bool SO>
Checked access to the matrix elements.
- Parameters
-
i | Access index for the row. The index has to be in the range . |
j | Access index for the column. The index has to be in the range . |
- Returns
- The resulting value.
- Exceptions
-
std::out_of_range | Invalid matrix access index. |
template<typename MT , typename ST , bool SO>
Returns an iterator to the first non-zero element of row i.
- Parameters
-
- Returns
- Iterator to the first non-zero element of row i.
template<typename MT , typename ST , bool SO>
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 MT , typename ST , bool SO>
Returns the current number of columns of the matrix.
- Returns
- The number of columns of the matrix.
template<typename MT , typename ST , bool SO>
Returns an iterator just past the last non-zero element of row i.
- Parameters
-
- Returns
- Iterator just past the last non-zero element of row i.
template<typename MT , typename ST , bool SO>
Searches for a specific matrix element.
- Parameters
-
i | The row index of the search element. |
j | The column index of the search element. |
- Returns
- Iterator to the element in case the index is found, end() iterator otherwise.
template<typename MT , typename ST , bool SO>
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 MT , typename ST , bool SO>
Returns the left-hand side sparse matrix operand.
- Returns
- The left-hand side sparse matrix operand.
template<typename MT , typename ST , bool SO>
Returns an iterator to the first index not less then the given index.
- Parameters
-
i | The row index of the search element. |
j | The column index of the search element. |
- Returns
- Iterator to the first index not less then the given index, end() iterator otherwise.
template<typename MT , typename ST , bool SO>
Returns the number of non-zero elements in the sparse matrix.
- Returns
- The number of non-zero elements in the sparse matrix.
template<typename MT , typename ST , bool SO>
Returns the number of non-zero elements in the specified row.
- Parameters
-
- Returns
- The number of non-zero elements of row i.
template<typename MT , typename ST , bool SO>
2D-access to the matrix elements.
- Parameters
-
i | Access index for the row. The index has to be in the range . |
j | Access index for the column. The index has to be in the range . |
- Returns
- The resulting value.
Conversion operator for non-constant matrices.
- Returns
- Reference of the actual type of the matrix.
Conversion operator for constant matrices.
- Returns
- Constant reference of the actual type of the matrix.
template<typename MT , typename ST , bool SO>
Returns the right-hand side scalar operand.
- Returns
- The right-hand side scalar operand.
template<typename MT , typename ST , bool SO>
Returns the current number of rows of the matrix.
- Returns
- The number of rows of the matrix.
template<typename MT , typename ST , bool SO>
Returns an iterator to the first index greater then the given index.
- Parameters
-
i | The row index of the search element. |
j | The column 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: