Blaze 3.9
Public Types | Public Member Functions | Static Public Attributes | Private Attributes | List of all members
blaze::DMatEvalExpr< MT, SO > Class Template Reference

Expression object for the forced evaluation of dense matrices. More...

#include <DMatEvalExpr.h>

Inherits blaze::MatEvalExpr< DenseMatrix< DMatEvalExpr< MT, SO >, SO > >, and blaze::Computation.

Public Types

using This = DMatEvalExpr< MT, SO >
 Type of this DMatEvalExpr instance.
 
using BaseType = MatEvalExpr< DenseMatrix< This, SO > >
 Base type of this DMatEvalExpr instance.
 
using ResultType = ResultType_t< MT >
 Result type for expression template evaluations.
 
using OppositeType = OppositeType_t< MT >
 Result type with opposite storage order for expression template evaluations.
 
using TransposeType = TransposeType_t< MT >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_t< MT >
 Resulting element type.
 
using ReturnType = ReturnType_t< MT >
 Return type for expression template evaluations.
 
using CompositeType = const ResultType
 Data type for composite expression templates.
 
using Operand = If_t< IsExpression_v< MT >, const MT, const MT & >
 Composite data type of the dense matrix expression.
 
using MatrixType = DMatEvalExpr< MT, SO >
 Type of the matrix.
 

Public Member Functions

 DMatEvalExpr (const MT &dm) noexcept
 Constructor for the DMatEvalExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
ReturnType at (size_t i, size_t j) const
 Checked access to the matrix elements. More...
 
size_t rows () const noexcept
 Returns the current number of rows of the matrix. More...
 
size_t columns () const noexcept
 Returns the current number of columns of the matrix. More...
 
Operand operand () const noexcept
 Returns the dense matrix operand. More...
 
template<typename T >
bool canAlias (const T *alias) const noexcept
 Returns whether the expression can alias with the given address alias. More...
 
template<typename T >
bool isAliased (const T *alias) const noexcept
 Returns whether the expression is aliased with the given address alias. More...
 
bool isAligned () const noexcept
 Returns whether the operands of the expression are properly aligned in memory. More...
 
bool canSMPAssign () const noexcept
 Returns whether the expression can be used in SMP assignments. More...
 
Conversion operators
BLAZE_ALWAYS_INLINE constexpr DMatEvalExpr< MT, SO > & operator~ () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const DMatEvalExpr< MT, SO > & operator~ () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 
constexpr DMatEvalExpr< MT, SO > & operator* () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
constexpr const DMatEvalExpr< MT, SO > & operator* () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 

Static Public Attributes

static constexpr bool simdEnabled = false
 Compilation switch for the expression template evaluation strategy.
 
static constexpr bool smpAssignable = MT::smpAssignable
 Compilation switch for the expression template assignment strategy.
 
static constexpr bool storageOrder
 Storage order of the matrix.
 

Private Attributes

Operand dm_
 Dense matrix of the evaluation expression.
 

Detailed Description

template<typename MT, bool SO>
class blaze::DMatEvalExpr< MT, SO >

Expression object for the forced evaluation of dense matrices.

The DMatEvalExpr class represents the compile time expression for the forced evaluation of a dense matrix.

Constructor & Destructor Documentation

◆ DMatEvalExpr()

template<typename MT , bool SO>
blaze::DMatEvalExpr< MT, SO >::DMatEvalExpr ( const MT &  dm)
inlineexplicitnoexcept

Constructor for the DMatEvalExpr class.

Parameters
dmThe dense matrix operand of the evaluation expression.

Member Function Documentation

◆ at()

template<typename MT , bool SO>
ReturnType blaze::DMatEvalExpr< MT, SO >::at ( size_t  i,
size_t  j 
) const
inline

Checked access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
Exceptions
std::out_of_rangeInvalid matrix access index.

◆ canAlias()

template<typename MT , bool SO>
template<typename T >
bool blaze::DMatEvalExpr< MT, SO >::canAlias ( const T *  alias) const
inlinenoexcept

Returns whether the expression can alias with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case the expression can alias, false otherwise.

◆ canSMPAssign()

template<typename MT , bool SO>
bool blaze::DMatEvalExpr< MT, SO >::canSMPAssign ( ) const
inlinenoexcept

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>
size_t blaze::DMatEvalExpr< MT, SO >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ isAliased()

template<typename MT , bool SO>
template<typename T >
bool blaze::DMatEvalExpr< MT, SO >::isAliased ( const T *  alias) const
inlinenoexcept

Returns whether the expression is aliased with the given address alias.

Parameters
aliasThe alias to be checked.
Returns
true in case an alias effect is detected, false otherwise.

◆ isAligned()

template<typename MT , bool SO>
bool blaze::DMatEvalExpr< MT, SO >::isAligned ( ) const
inlinenoexcept

Returns whether the operands of the expression are properly aligned in memory.

Returns
true in case the operands are aligned, false if not.

◆ operand()

template<typename MT , bool SO>
Operand blaze::DMatEvalExpr< MT, SO >::operand ( ) const
inlinenoexcept

Returns the dense matrix operand.

Returns
The dense matrix operand.

◆ operator()()

template<typename MT , bool SO>
ReturnType blaze::DMatEvalExpr< MT, SO >::operator() ( size_t  i,
size_t  j 
) const
inline

2D-access to the matrix elements.

Parameters
iAccess index for the row. The index has to be in the range $[0..M-1]$.
jAccess index for the column. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.

◆ operator*() [1/2]

BLAZE_ALWAYS_INLINE constexpr const DMatEvalExpr< MT, SO > & blaze::Matrix< DMatEvalExpr< MT, SO > , SO >::operator*
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]

BLAZE_ALWAYS_INLINE constexpr DMatEvalExpr< MT, SO > & blaze::Matrix< DMatEvalExpr< MT, SO > , SO >::operator*
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]

BLAZE_ALWAYS_INLINE constexpr const DMatEvalExpr< MT, SO > & blaze::Matrix< DMatEvalExpr< MT, SO > , SO >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for constant matrices.

Parameters
matrixThe 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]

BLAZE_ALWAYS_INLINE constexpr DMatEvalExpr< MT, SO > & blaze::Matrix< DMatEvalExpr< MT, SO > , SO >::operator~
constexprnoexceptinherited

CRTP-based conversion operation for non-constant matrices.

Parameters
matrixThe 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>
size_t blaze::DMatEvalExpr< MT, SO >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

The documentation for this class was generated from the following file: