Expression object for the explicit Hermitian declaration of sparse matrices.
More...
#include <SMatDeclHermExpr.h>
Inherits blaze::DeclHermExpr< SparseMatrix< SMatDeclHermExpr< MT, SO >, SO > >, and blaze::Declaration< MT >.
|
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.
|
|
|
| BLAZE_CREATE_GET_TYPE_MEMBER_TYPE_TRAIT (GetConstIterator, ConstIterator, INVALID_TYPE) |
| Definition of the GetConstIterator type trait.
|
|
|
Operand | sm_ |
| Sparse matrix of the declherm expression.
|
|
|
static constexpr bool | useAssign = RequiresEvaluation_v<MT> |
| Compilation switch for the serial evaluation strategy of the Hermitian declaration expression. More...
|
|
template<typename MT, bool SO>
class blaze::SMatDeclHermExpr< MT, SO >
Expression object for the explicit Hermitian declaration of sparse matrices.
The SMatDeclHermExpr class represents the compile time expression for the explicit Hermitian declaration of a sparse matrix.
◆ SMatDeclHermExpr()
template<typename MT , bool SO>
Constructor for the SMatDeclHermExpr class.
- Parameters
-
sm | The sparse matrix operand of the declherm 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 i.
- Parameters
-
- Returns
- Iterator to the first non-zero element of row 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 i.
- Parameters
-
- Returns
- Iterator just past the last non-zero element of row i.
◆ 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.
◆ 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.
◆ useAssign
template<typename MT , bool SO>
Compilation switch for the serial evaluation strategy of the Hermitian declaration expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the Hermitian declaration expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the Hermitian declaration 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: