Expression object for sparse matrix-dense matrix Schur product.
More...
#include <SMatDMatSchurExpr.h >
Inherits blaze::SchurExpr< SparseMatrix< SMatDMatSchurExpr< MT1, MT2 >, false > > , and blaze::Computation .
using This = SMatDMatSchurExpr <MT1,MT2>
Type of this SMatDMatSchurExpr instance.
using BaseType = SchurExpr < SparseMatrix <This ,false> >
Base type of this SMatDMatSchurExpr instance.
using ResultType = SchurTrait_t <RT1 ,RT2 >
Result type for expression template evaluations.
using OppositeType = OppositeType_t <ResultType >
Result type with opposite storage order for expression template evaluations.
using TransposeType = TransposeType_t <ResultType >
Transpose type for expression template evaluations.
using ElementType = ElementType_t <ResultType >
Resulting element type.
using ReturnType = const If_t < returnExpr , ExprReturnType , ElementType >
Return type for expression template evaluations.
using CompositeType = If_t < useAssign , const ResultType , const SMatDMatSchurExpr & >
Data type for composite expression templates.
using LeftOperand = If_t < IsExpression_v <MT1>, const MT1, const MT1& >
Composite type of the left-hand side sparse matrix expression.
using RightOperand = If_t < IsExpression_v <MT2>, const MT2, const MT2& >
Composite type of the right-hand side dense matrix expression.
using MatrixType
Type of the matrix.
SMatDMatSchurExpr (const MT1 &lhs, const MT2 &rhs) noexcept
Constructor for the SMatDMatSchurExpr class.
ReturnType operator() (size_t i, size_t j) const
2D-access to the matrix elements.
ReturnType at (size_t i, size_t j) const
Checked access to the matrix elements.
ConstIterator begin (size_t i) const
Returns an iterator to the first non-zero element of row i .
ConstIterator end (size_t i) const
Returns an iterator just past the last non-zero element of row i .
size_t rows () const noexcept
Returns the current number of rows of the matrix.
size_t columns () const noexcept
Returns the current number of columns of the matrix.
size_t nonZeros () const
Returns the number of non-zero elements in the sparse matrix.
size_t nonZeros (size_t i) const
Returns the number of non-zero elements in the specified row.
ConstIterator find (size_t i, size_t j) const
Searches for a specific matrix element.
ConstIterator lowerBound (size_t i, size_t j) const
Returns an iterator to the first index not less then the given index.
ConstIterator upperBound (size_t i, size_t j) const
Returns an iterator to the first index greater then the given index.
LeftOperand leftOperand () const noexcept
Returns the left-hand side sparse matrix operand.
RightOperand rightOperand () const noexcept
Returns the right-hand side dense matrix operand.
template<typename T>
bool canAlias (const T *alias) const noexcept
Returns whether the expression can alias with the given address alias .
template<typename T>
bool isAliased (const T *alias) const noexcept
Returns whether the expression is aliased with the given address alias .
BLAZE_ALWAYS_INLINE constexpr SMatDMatSchurExpr < MT1, MT2 > & operator~ () noexcept
CRTP-based conversion operation for non-constant matrices.
BLAZE_ALWAYS_INLINE constexpr const SMatDMatSchurExpr < MT1, MT2 > & operator~ () const noexcept
CRTP-based conversion operation for constant matrices.
constexpr SMatDMatSchurExpr < MT1, MT2 > & operator* () noexcept
CRTP-based conversion operation for non-constant matrices.
constexpr const SMatDMatSchurExpr < MT1, MT2 > & operator* () const noexcept
CRTP-based conversion operation for constant matrices.
static constexpr bool smpAssignable = false
Compilation switch for the expression template assignment strategy.
static constexpr bool storageOrder
Storage order of the matrix.
using RT1 = ResultType_t <MT1>
Result type of the left-hand side sparse matrix expression.
using RT2 = ResultType_t <MT2>
Result type of the right-hand side dense matrix expression.
using RN1 = ReturnType_t <MT1>
Return type of the left-hand side sparse matrix expression.
using RN2 = ReturnType_t <MT2>
Return type of the right-hand side dense matrix expression.
using CT1 = CompositeType_t <MT1>
Composite type of the left-hand side sparse matrix expression.
using CT2 = CompositeType_t <MT2>
Composite type of the right-hand side dense matrix expression.
using ExprReturnType = decltype( std::declval<RN1 >() * std::declval<RN2 >() )
Expression return type for the subscript operator.
template<typename MT1, typename MT2>
class blaze::SMatDMatSchurExpr< MT1, MT2 >
Expression object for sparse matrix-dense matrix Schur product.
The SMatDMatSchurExpr class represents the compile time expression for Schur products between a row-major sparse matrix and a dense matrix.
◆ SMatDMatSchurExpr()
template<typename MT1, typename MT2>
Constructor for the SMatDMatSchurExpr class.
Parameters
lhs The left-hand side sparse matrix operand of the Schur product expression.
rhs The right-hand side dense matrix operand of the Schur product expression.
◆ at()
template<typename MT1, typename MT2>
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 MT1, typename MT2>
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 MT1, typename MT2>
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 effect is detected, false otherwise.
◆ columns()
template<typename MT1, typename MT2>
Returns the current number of columns of the matrix.
Returns The number of columns of the matrix.
◆ end()
template<typename MT1, typename MT2>
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 .
◆ find()
template<typename MT1, typename MT2>
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 MT1, typename MT2>
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.
◆ leftOperand()
template<typename MT1, typename MT2>
Returns the left-hand side sparse matrix operand.
Returns The left-hand side sparse matrix operand.
◆ lowerBound()
template<typename MT1, typename MT2>
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 MT1, typename MT2>
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 MT1, typename MT2>
Returns the number of non-zero elements in the specified row.
Parameters
Returns The number of non-zero elements of row i .
◆ operator()()
template<typename MT1, typename MT2>
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]
constexpr noexcept inherited
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]
constexpr noexcept inherited
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]
constexpr noexcept inherited
CRTP-based conversion operation for constant matrices.
Deprecated
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 .
Deprecated
◆ operator~() [2/2]
constexpr noexcept inherited
CRTP-based conversion operation for non-constant matrices.
Deprecated
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 .
Deprecated
◆ rightOperand()
template<typename MT1, typename MT2>
Returns the right-hand side dense matrix operand.
Returns The right-hand side dense matrix operand.
◆ rows()
template<typename MT1, typename MT2>
Returns the current number of rows of the matrix.
Returns The number of rows of the matrix.
◆ upperBound()
template<typename MT1, typename MT2>
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.
◆ returnExpr
template<typename MT1, typename MT2>
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 either 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.
◆ useAssign
template<typename MT1, typename MT2>
Compilation switch for the evaluation strategy of the Schur product expression.
The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the Schur product expression. In case either the sparse or the dense matrix operand requires an intermediate evaluation, useAssign will be set to true and the Schur product expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the function call operator.
The documentation for this class was generated from the following files: