Expression object for the sparse matrix real() function.The SMatRealExpr class represents the compile time expression for the calculation of the real part of each element of a sparse matrix via the real() function.
More...
#include <SMatRealExpr.h>
Inherits blaze::SparseMatrix< SMatRealExpr< MT, SO >, SO >, blaze::MatRealExpr, and blaze::Computation.
|
enum | { returnExpr = !IsTemporary<RN>::value
} |
| Compilation switch for the selection of the subscript operator return type. More...
|
|
enum | { useAssign = RequiresEvaluation<MT>::value
} |
| Compilation switch for the serial evaluation strategy of the real part expression. More...
|
|
typedef MT::ResultType | RT |
| Result type of the sparse matrix expression.
|
|
typedef MT::ReturnType | RN |
| Return type of the sparse matrix expression.
|
|
typedef MT::CompositeType | CT |
| Composite type of the sparse matrix expression.
|
|
typedef RealExprTrait< RN >::Type | ExprReturnType |
| Expression return type for the subscript operator.
|
|
|
Operand | sm_ |
| Sparse matrix of the real part expression.
|
|
template<typename MT, bool SO>
class blaze::SMatRealExpr< MT, SO >
Expression object for the sparse matrix real() function.
The SMatRealExpr class represents the compile time expression for the calculation of the real part of each element of a sparse matrix via the real() function.
template<typename MT , 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 , bool SO>
Compilation switch for the serial evaluation strategy of the real part expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the real part expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the real part 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 , bool SO>
Constructor for the SMatRealExpr class.
- Parameters
-
sm | The sparse matrix operand of the real part expression. |
template<typename MT , 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 , 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 , 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 , bool SO>
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.
template<typename MT , bool SO>
Returns the current number of columns of the matrix.
- Returns
- The number of columns of the matrix.
template<typename MT , 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 , 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 , 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 , 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 , 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 , 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 , bool SO>
Returns the sparse matrix operand.
- Returns
- The sparse matrix operand.
template<typename MT , 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 , bool SO>
Returns the current number of rows of the matrix.
- Returns
- The number of rows of the matrix.
template<typename MT , 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: