Expression object for the non-aliased evaluation of sparse matrices.
More...
#include <SMatNoAliasExpr.h>
Inherits blaze::MatNoAliasExpr< SparseMatrix< SMatNoAliasExpr< MT, SO >, SO > >, and blaze::Modification< MT >.
|
using | This = SMatNoAliasExpr< MT, SO > |
| Type of this SMatNoAliasExpr instance.
|
|
using | BaseType = MatNoAliasExpr< SparseMatrix< This, SO > > |
| Base type of this SMatNoAliasExpr instance.
|
|
using | ResultType = ResultType_t< MT > |
| Result type for expression template evaluations.
|
|
using | OppositeType = OppositeType_t< MT > |
| Result type with opposite storage order for expression template evaluations.
|
|
using | TransposeType = TransposeType_t< MT > |
| Transpose type for expression template evaluations.
|
|
using | ElementType = ElementType_t< MT > |
| Resulting element type.
|
|
using | ReturnType = ReturnType_t< MT > |
| Return type for expression template evaluations.
|
|
using | CompositeType = If_t< RequiresEvaluation_v< MT >, const ResultType, const SMatNoAliasExpr & > |
| Data type for composite expression templates.
|
|
using | ConstIterator = GetConstIterator_t< MT > |
| Iterator over the elements of the sparse matrix.
|
|
using | Operand = If_t< IsExpression_v< MT >, const MT, const MT & > |
| Composite data type of the sparse matrix expression.
|
|
using | MatrixType = SMatNoAliasExpr< MT, SO > |
| Type of the matrix.
|
|
|
static constexpr bool | smpAssignable = MT::smpAssignable |
| Compilation switch for the expression template assignment strategy.
|
|
static constexpr bool | storageOrder |
| Storage order of the matrix.
|
|
|
| BLAZE_CREATE_GET_TYPE_MEMBER_TYPE_TRAIT (GetConstIterator, ConstIterator, INVALID_TYPE) |
| Definition of the GetConstIterator type trait.
|
|
|
Operand | sm_ |
| Sparse matrix of the no-alias expression.
|
|
template<typename MT, bool SO>
class blaze::SMatNoAliasExpr< MT, SO >
Expression object for the non-aliased evaluation of sparse matrices.
The SMatNoAliasExpr class represents the compile time expression for the non-aliased evaluation of a sparse matrix.
◆ SMatNoAliasExpr()
template<typename MT , bool SO>
Constructor for the SMatNoAliasExpr class.
- Parameters
-
sm | The sparse matrix operand of the no-alias 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.
- Parameters
-
- Returns
- The number of non-zero elements of row 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]
|
constexprnoexceptinherited |
CRTP-based conversion operation for constant matrices.
- Returns
- Constant reference of the actual type of the matrix.
This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a constant reference to the actual type MT.
◆ operator*() [2/2]
|
constexprnoexceptinherited |
CRTP-based conversion operation for non-constant matrices.
- Returns
- Mutable reference of the actual type of the matrix.
This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a mutable reference to the actual type MT.
◆ operator~() [1/2]
|
constexprnoexceptinherited |
CRTP-based conversion operation for constant matrices.
- Parameters
-
matrix | The matrix to be downcast. |
- Returns
- Constant reference of the actual type of the matrix.
This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a constant reference to the actual type MT.
◆ operator~() [2/2]
|
constexprnoexceptinherited |
CRTP-based conversion operation for non-constant matrices.
- Parameters
-
matrix | The matrix to be downcast. |
- Returns
- Mutable reference of the actual type of the matrix.
This operator performs the CRTP-based type-safe downcast to the actual type MT of the matrix. It will return a mutable reference to the actual type MT.
◆ 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.
The documentation for this class was generated from the following files: