Expression object for dense matrix-scalar multiplications.
More...
#include <DMatScalarMultExpr.h >
Inherits blaze::MatScalarMultExpr< DenseMatrix< DMatScalarMultExpr< MT, ST, SO >, SO > > , and blaze::Computation .
using This = DMatScalarMultExpr <MT,ST,SO>
Type of this DMatScalarMultExpr instance.
using BaseType = MatScalarMultExpr < DenseMatrix <This ,SO> >
Base type of this DMatScalarMultExpr 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 DMatScalarMultExpr & >
Data type for composite expression templates.
using LeftOperand = If_t < IsExpression_v <MT>, const MT, const MT& >
Composite type of the left-hand side dense matrix expression.
using RightOperand = ST
Composite type of the right-hand side scalar value.
static constexpr bool simdEnabled
Compilation switch for the expression template evaluation strategy.
static constexpr bool smpAssignable = MT::smpAssignable
Compilation switch for the expression template assignment strategy.
static constexpr size_t SIMDSIZE = SIMDTrait <ElementType >::size
The number of elements packed within a single SIMD element.
using RT = ResultType_t <MT>
Result type of the dense matrix expression.
using RN = ReturnType_t <MT>
Return type of the dense matrix expression.
using ET = ElementType_t <MT>
Element type of the dense matrix expression.
using CT = CompositeType_t <MT>
Composite type of the dense matrix expression.
using ExprReturnType = decltype( std::declval<RN >() * std::declval<ST>() )
Expression return type for the subscript operator.
LeftOperand matrix_
Left-hand side dense matrix of the multiplication expression.
RightOperand scalar_
Right-hand side scalar of the multiplication expression.
template<typename MT, typename ST, bool SO>
class blaze::DMatScalarMultExpr< MT, ST, SO >
Expression object for dense matrix-scalar multiplications.
The DMatScalarMultExpr class represents the compile time expression for multiplications between a dense matrix and a scalar value.
◆ DMatScalarMultExpr()
template<typename MT, typename ST, bool SO>
Constructor for the DMatScalarMultExpr class.
Parameters
matrix The left-hand side dense matrix of the multiplication expression.
scalar The right-hand side scalar of the multiplication 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.
◆ canSMPAssign()
template<typename MT, typename ST, 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, 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 .
◆ 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.
◆ isAligned()
template<typename MT, typename ST, bool SO>
Returns whether the operands of the expression are properly aligned in memory.
Returns true in case the operands are aligned, false if not.
◆ leftOperand()
template<typename MT, typename ST, bool SO>
Returns the left-hand side dense matrix operand.
Returns The left-hand side dense matrix operand.
◆ load()
template<typename MT, typename ST, bool SO>
Access to the SIMD elements of the matrix.
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 Reference to the accessed values.
◆ 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.
◆ 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.
◆ simdEnabled
template<typename MT, typename ST, bool SO>
Initial value: =
constexpr bool HasSIMDMult_v
Auxiliary variable template for the HasSIMDMult type trait.
Definition HasSIMDMult.h:188
constexpr bool IsNumeric_v
Auxiliary variable template for the IsNumeric type trait.
Definition IsNumeric.h:132
Compilation switch for the expression template evaluation strategy.
◆ useAssign
template<typename MT, typename ST, bool SO>
Compilation switch for the serial evaluation strategy of the multiplication expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the multiplication expression. In case the given dense matrix expression of type MT is a computation expression and requires an intermediate evaluation, useAssign will be set to 1 and the multiplication 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 file: