Expression object for sparse matrix transpositions.The SMatTransExpr class represents the compile time expression for transpositions of sparse matrices.
More...
#include <SMatTransExpr.h>
Inherits blaze::MatTransExpr< SparseMatrix< SMatTransExpr< MT, SO >, SO > >, and Type< IsComputation_v< MT >, Computation, Transformation >.
|
static constexpr bool | smpAssignable = MT::smpAssignable |
| Compilation switch for the expression template assignment strategy.
|
|
static constexpr bool | storageOrder |
| Storage order of the matrix.
|
|
|
using | RT = ResultType_t< MT > |
| Result type of the sparse matrix expression.
|
|
using | CT = CompositeType_t< MT > |
| Composite type of the sparse matrix expression.
|
|
|
Operand | sm_ |
| Sparse matrix of the transposition expression.
|
|
template<typename MT, bool SO>
class blaze::SMatTransExpr< MT, SO >
Expression object for sparse matrix transpositions.
The SMatTransExpr class represents the compile time expression for transpositions of sparse matrices.
◆ SMatTransExpr()
template<typename MT , bool SO>
Constructor for the SMatTransExpr class.
- Parameters
-
sm | The sparse matrix operand of the transposition expression. |
◆ at()
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. |
◆ begin()
template<typename MT , 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 , 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 , 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 , bool SO>
Returns the current number of columns of the matrix.
- Returns
- The number of columns of the matrix.
◆ end()
template<typename MT , 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 , 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 , 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 , 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 , 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 , bool SO>
Returns the number of non-zero elements in the specified row/column.
- Parameters
-
i | The index of the row/column. |
- Returns
- The number of non-zero elements of row/column i.
◆ operand()
template<typename MT , bool SO>
Returns the sparse matrix operand.
- Returns
- The sparse matrix operand.
◆ operator()()
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.
◆ operator~() [1/2]
Conversion operator for non-constant matrices.
- Returns
- Reference of the actual type of the matrix.
◆ operator~() [2/2]
Conversion operator for constant matrices.
- Returns
- Constant reference of the actual type of the matrix.
◆ rows()
template<typename MT , bool SO>
Returns the current number of rows of the matrix.
- Returns
- The number of rows of the matrix.
◆ upperBound()
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.
◆ useAssign
template<typename MT , bool SO>
Compilation switch for the serial evaluation strategy of the transposition expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the transposition expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the transposition 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: