Expression object for the sparse matrix map() function.
More...
#include <SMatMapExpr.h >
Inherits blaze::MatMapExpr< SparseMatrix< SMatMapExpr< MT, OP, SO >, SO > > , and blaze::Computation .
static constexpr bool smpAssignable = MT::smpAssignable
Compilation switch for the expression template assignment strategy.
using RT = ResultType_t <MT>
Result type of the sparse matrix expression.
using OT = OppositeType_t <MT>
Opposite type of the sparse matrix expression.
using RN = ReturnType_t <MT>
Return type of the sparse matrix expression.
Operand sm_
Sparse matrix of the map expression.
Operation op_
The custom unary operation.
template<typename MT, typename OP, bool SO>
class blaze::SMatMapExpr< MT, OP, SO >
Expression object for the sparse matrix map() function.
The SMatMapExpr class represents the compile time expression for the evaluation of a custom operation on each element of a sparse matrix via the map() function.
◆ SMatMapExpr()
template<typename MT, typename OP, bool SO>
Constructor for the SMatMapExpr class.
Parameters
sm The sparse matrix operand of the map expression.
op The custom unary operation.
◆ at()
template<typename MT, typename OP, 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.
◆ begin()
template<typename MT, typename OP, bool SO>
Returns an iterator to the first non-zero element of row/column i .
Parameters
Returns Iterator to the first non-zero element of row/column i .
◆ canAlias()
template<typename MT, typename OP, 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.
◆ canSMPAssign()
template<typename MT, typename OP, 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.
◆ columns()
template<typename MT, typename OP, bool SO>
Returns the current number of columns of the matrix.
Returns The number of columns of the matrix.
◆ end()
template<typename MT, typename OP, bool SO>
Returns an iterator just past the last non-zero element of row/column i .
Parameters
Returns Iterator just past the last non-zero element of row/column i .
◆ find()
template<typename MT, typename OP, 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.
◆ isAliased()
template<typename MT, typename OP, 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.
◆ lowerBound()
template<typename MT, typename OP, 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.
◆ nonZeros() [1/2]
template<typename MT, typename OP, bool SO>
Returns the number of non-zero elements in the sparse matrix.
Returns The number of non-zero elements in the sparse matrix.
◆ nonZeros() [2/2]
template<typename MT, typename OP, bool SO>
Returns the number of non-zero elements in the specified row.
Parameters
Returns The number of non-zero elements of row i .
◆ operand()
template<typename MT, typename OP, bool SO>
Returns the sparse matrix operand.
Returns The sparse matrix operand.
◆ operation()
template<typename MT, typename OP, bool SO>
Returns a copy of the custom operation.
Returns A copy of the custom operation.
◆ operator()()
template<typename MT, typename OP, 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.
◆ rows()
template<typename MT, typename OP, bool SO>
Returns the current number of rows of the matrix.
Returns The number of rows of the matrix.
◆ upperBound()
template<typename MT, typename OP, 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.
◆ useAssign
template<typename MT, typename OP, bool SO>
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 matrix expression of type MT 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: