Expression object for dense matrix-dense matrix subtractions.
More...
#include <DMatDMatSubExpr.h >
Inherits blaze::MatMatSubExpr< DenseMatrix< DMatDMatSubExpr< MT1, MT2, SO >, SO > > , and blaze::Computation .
using This = DMatDMatSubExpr <MT1,MT2,SO>
Type of this DMatDMatSubExpr instance.
using BaseType = MatMatSubExpr < DenseMatrix <This ,SO> >
Base type of this DMatDMatSubExpr instance.
using ResultType = SubTrait_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 DMatDMatSubExpr & >
Data type for composite expression templates.
using LeftOperand = If_t < IsExpression_v <MT1>, const MT1, const MT1& >
Composite type of the left-hand side dense 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.
DMatDMatSubExpr (const MT1 &lhs, const MT2 &rhs) noexcept
Constructor for the DMatDMatSubExpr 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.
BLAZE_ALWAYS_INLINE auto load (size_t i, size_t j) const noexcept
Access to the SIMD elements of the matrix.
ConstIterator begin (size_t i) const
Returns an iterator to the first non-zero element of row/column i .
ConstIterator end (size_t i) const
Returns an iterator just past the last non-zero element of row/column 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.
LeftOperand leftOperand () const noexcept
Returns the left-hand side dense 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 .
bool isAligned () const noexcept
Returns whether the operands of the expression are properly aligned in memory.
bool canSMPAssign () const noexcept
Returns whether the expression can be used in SMP assignments.
BLAZE_ALWAYS_INLINE constexpr DMatDMatSubExpr < MT1, MT2, SO > & operator~ () noexcept
CRTP-based conversion operation for non-constant matrices.
BLAZE_ALWAYS_INLINE constexpr const DMatDMatSubExpr < MT1, MT2, SO > & operator~ () const noexcept
CRTP-based conversion operation for constant matrices.
constexpr DMatDMatSubExpr < MT1, MT2, SO > & operator* () noexcept
CRTP-based conversion operation for non-constant matrices.
constexpr const DMatDMatSubExpr < MT1, MT2, SO > & operator* () const noexcept
CRTP-based conversion operation for constant matrices.
static constexpr bool simdEnabled
Compilation switch for the expression template evaluation strategy.
static constexpr bool smpAssignable = ( MT1::smpAssignable && MT2::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.
static constexpr bool storageOrder
Storage order of the matrix.
using RT1 = ResultType_t <MT1>
Result type of the left-hand side dense 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 dense 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 dense matrix expression.
using CT2 = CompositeType_t <MT2>
Composite type of the right-hand side dense matrix expression.
using ET1 = ElementType_t <MT1>
Element type of the left-hand side dense matrix expression.
using ET2 = ElementType_t <MT2>
Element 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.
LeftOperand lhs_
Left-hand side dense matrix of the subtraction expression.
RightOperand rhs_
Right-hand side dense matrix of the subtraction expression.
static constexpr bool returnExpr = ( !IsTemporary_v <RN1 > && !IsTemporary_v <RN2 > )
Compilation switch for the selection of the subscript operator return type.
static constexpr bool useAssign
Compilation switch for the serial evaluation strategy of the subtraction expression.
template<typename MT1, typename MT2, bool SO>
class blaze::DMatDMatSubExpr< MT1, MT2, SO >
Expression object for dense matrix-dense matrix subtractions.
The DMatDMatSubExpr class represents the compile time expression for subtractions between dense matrices with identical storage order.
◆ DMatDMatSubExpr()
template<typename MT1, typename MT2, bool SO>
Constructor for the DMatDMatSubExpr class.
Parameters
lhs The left-hand side operand of the subtraction expression.
rhs The right-hand side operand of the subtraction expression.
◆ at()
template<typename MT1, typename MT2, 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 MT1, typename MT2, 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 MT1, typename MT2, 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 MT1, typename MT2, 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 MT1, typename MT2, bool SO>
Returns the current number of columns of the matrix.
Returns The number of columns of the matrix.
◆ end()
template<typename MT1, typename MT2, 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 MT1, typename MT2, 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 MT1, typename MT2, 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 MT1, typename MT2, bool SO>
Returns the left-hand side dense matrix operand.
Returns The left-hand side dense matrix operand.
◆ load()
template<typename MT1, typename MT2, 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 MT1, typename MT2, 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]
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, bool SO>
Returns the right-hand side dense matrix operand.
Returns The right-hand side dense matrix operand.
◆ rows()
template<typename MT1, typename MT2, bool SO>
Returns the current number of rows of the matrix.
Returns The number of rows of the matrix.
◆ returnExpr
template<typename MT1, typename MT2, 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 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.
◆ simdEnabled
template<typename MT1, typename MT2, bool SO>
Initial value: =
constexpr bool HasSIMDSub_v
Auxiliary variable template for the HasSIMDSub type trait.
Definition HasSIMDSub.h:187
Compilation switch for the expression template evaluation strategy.
◆ useAssign
template<typename MT1, typename MT2, bool SO>
Initial value: =
static constexpr bool returnExpr
Compilation switch for the selection of the subscript operator return type.
Definition DMatDMatAddExpr.h:117
constexpr bool RequiresEvaluation_v
Auxiliary variable template for the RequiresEvaluation type trait.
Definition RequiresEvaluation.h:91
Compilation switch for the serial evaluation strategy of the subtraction expression.
The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the subtraction expression. In case either of the two dense matrix operands requires an intermediate evaluation or the subscript operator can only return by value, useAssign will be set to 1 and the subtraction expression will be evaluated via the assign function family. 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 file: