Expression object for sparse matrix-scalar divisions.
More...
#include <SMatScalarDivExpr.h >
Inherits blaze::MatScalarDivExpr< SparseMatrix< SMatScalarDivExpr< MT, ST, SO >, SO > > , and blaze::Computation .
class ConstIterator
Iterator over the elements of the sparse matrix/scalar division expression. More...
using This = SMatScalarDivExpr <MT,ST,SO>
Type of this SMatScalarDivExpr instance.
using BaseType = MatScalarDivExpr < SparseMatrix <This ,SO> >
Base type of this SMatScalarDivExpr instance.
using ResultType = MultTrait_t <RT ,ST>
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 SMatScalarDivExpr & >
Data type for composite expression templates.
using LeftOperand = If_t < IsExpression_v <MT>, const MT, const MT& >
Composite data type of the sparse matrix expression.
using RightOperand = ST
Composite type of the right-hand side scalar value.
static constexpr bool smpAssignable = false
Compilation switch for the expression template assignment strategy.
using RT = ResultType_t <MT>
Result type of the sparse matrix expression.
using RN = ReturnType_t <MT>
Return type of the sparse matrix expression.
using CT = CompositeType_t <MT>
Composite type of the sparse matrix expression.
using ExprReturnType = decltype( std::declval<RN >() / std::declval<ST>() )
Expression return type for the subscript operator.
LeftOperand matrix_
Left-hand side sparse matrix of the division expression.
RightOperand scalar_
Right-hand side scalar of the division expression.
static constexpr bool returnExpr = !IsTemporary_v <RN >
Compilation switch for the selection of the subscript operator return type.
static constexpr bool useAssign = RequiresEvaluation_v <MT>
Compilation switch for the serial evaluation strategy of the division expression.
template<typename MT, typename ST, bool SO>
class blaze::SMatScalarDivExpr< MT, ST, SO >
Expression object for sparse matrix-scalar divisions.
The SMatScalarMult class represents the compile time expression for divisions between a sparse matrix and a scalar value.
◆ SMatScalarDivExpr()
template<typename MT, typename ST, bool SO>
Constructor for the SMatScalarDivExpr class.
Parameters
matrix The left-hand side sparse matrix of the division expression.
scalar The right-hand side scalar of the division expression.
◆ at()
template<typename MT, typename ST, 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 ST, 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 ST, 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.
◆ columns()
template<typename MT, typename ST, bool SO>
Returns the current number of columns of the matrix.
Returns The number of columns of the matrix.
◆ end()
template<typename MT, typename ST, 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 ST, 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 ST, 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.
◆ leftOperand()
template<typename MT, typename ST, bool SO>
Returns the left-hand side sparse matrix operand.
Returns The left-hand side sparse matrix operand.
◆ lowerBound()
template<typename MT, typename ST, 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 ST, 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 ST, bool SO>
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 MT, typename ST, 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.
◆ rightOperand()
template<typename MT, typename ST, bool SO>
Returns the right-hand side scalar operand.
Returns The right-hand side scalar operand.
◆ rows()
template<typename MT, typename ST, bool SO>
Returns the current number of rows of the matrix.
Returns The number of rows of the matrix.
◆ upperBound()
template<typename MT, typename ST, 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.
◆ returnExpr
template<typename MT, typename ST, bool SO>
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 the 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 MT, typename ST, bool SO>
Compilation switch for the serial evaluation strategy of the division expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the division expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the division expression will be evaluated via the assign function family. Otherwise Otherwise useAssign will be set to 0 and the expression will be evaluated via the function call operator.
The documentation for this class was generated from the following files: