Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
blaze::DMatDMatMapExpr< MT1, MT2, OP, SO > Class Template Reference

Expression object for the dense matrix-dense matrix map() function.The DMatDMatMapExpr class represents the compile time expression for the pairwise evaluation of a binary custom operation on the elements of two dense matrices with identical storage order via the map() function. More...

#include <DMatDMatMapExpr.h>

Inherits blaze::MatMatMapExpr< DenseMatrix< DMatDMatMapExpr< MT1, MT2, OP, SO >, SO > >, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the dense matrix map expression. More...
 

Public Types

enum  : bool { simdEnabled }
 Compilation switch for the expression template evaluation strategy.
 
enum  : bool { smpAssignable = MT1::smpAssignable && MT2::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
enum  : size_t { SIMDSIZE = SIMDTrait<ElementType>::size }
 The number of elements packed within a single SIMD element.
 
using This = DMatDMatMapExpr< MT1, MT2, OP, SO >
 Type of this DMatDMatMapExpr instance.
 
using ResultType = BinaryMapTrait_< RT1, RT2, OP >
 Result type for expression template evaluations.
 
using OppositeType = OppositeType_< ResultType >
 Result type with opposite storage order for expression template evaluations.
 
using TransposeType = TransposeType_< ResultType >
 Transpose type for expression template evaluations.
 
using ElementType = ElementType_< ResultType >
 Resulting element type.
 
using ReturnType = decltype(std::declval< OP >()(std::declval< RN1 >(), std::declval< RN2 >()))
 Return type for expression template evaluations.
 
using CompositeType = IfTrue_< useAssign, const ResultType, const DMatDMatMapExpr &>
 Data type for composite expression templates.
 
using LeftOperand = If_< IsExpression< MT1 >, const MT1, const MT1 &>
 Composite type of the left-hand side dense matrix expression.
 
using RightOperand = If_< IsExpression< MT2 >, const MT2, const MT2 &>
 Composite type of the right-hand side dense matrix expression.
 
using Operation = OP
 Data type of the custom unary operation.
 
using LT = If_< RequiresEvaluation< MT1 >, const RT1, CT1 >
 Type for the assignment of the left-hand side dense matrix operand.
 
using RT = If_< RequiresEvaluation< MT2 >, const RT2, CT2 >
 Type for the assignment of the right-hand side dense matrix operand.
 
using MatrixType = MT
 Type of the matrix.
 

Public Member Functions

 DMatDMatMapExpr (const MT1 &lhs, const MT2 &rhs, OP op) noexcept
 Constructor for the DMatDMatMapExpr 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...
 
BLAZE_ALWAYS_INLINE auto load (size_t i, size_t j) const noexcept
 Access to the SIMD elements of the matrix. More...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row i. 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...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side dense matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side dense matrix operand. More...
 
Operation operation () const
 Returns a copy of the custom operation. 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...
 
BLAZE_ALWAYS_INLINE MatrixTypeoperator~ () noexcept
 Conversion operator for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE const MatrixTypeoperator~ () const noexcept
 Conversion operator for constant matrices. More...
 

Private Types

enum  : bool { useAssign = ( RequiresEvaluation<MT1>::value || RequiresEvaluation<MT2>::value ) }
 Compilation switch for the serial evaluation strategy of the map expression. More...
 
using RT1 = ResultType_< MT1 >
 Result type of the left-hand side dense matrix expression.
 
using RT2 = ResultType_< MT2 >
 Result type of the right-hand side dense matrix expression.
 
using ET1 = ElementType_< MT1 >
 Element type of the left-hand side dense matrix expression.
 
using ET2 = ElementType_< MT2 >
 Element type of the right-hand side dense matrix expression.
 
using RN1 = ReturnType_< MT1 >
 Return type of the left-hand side dense matrix expression.
 
using RN2 = ReturnType_< MT2 >
 Return type of the right-hand side dense matrix expression.
 
using CT1 = CompositeType_< MT1 >
 Composite type of the left-hand side dense matrix expression.
 
using CT2 = CompositeType_< MT2 >
 Composite type of the right-hand side dense matrix expression.
 

Private Member Functions

 BLAZE_CREATE_HAS_DATA_OR_FUNCTION_MEMBER_TYPE_TRAIT (HasSIMDEnabled, simdEnabled)
 Definition of the HasSIMDEnabled type trait.
 
 BLAZE_CREATE_HAS_DATA_OR_FUNCTION_MEMBER_TYPE_TRAIT (HasLoad, load)
 Definition of the HasLoad type trait.
 

Private Attributes

LeftOperand lhs_
 Left-hand side dense matrix of the map expression.
 
RightOperand rhs_
 Right-hand side dense matrix of the map expression.
 
Operation op_
 The custom unary operation.
 

Detailed Description

template<typename MT1, typename MT2, typename OP, bool SO>
class blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >

Expression object for the dense matrix-dense matrix map() function.

The DMatDMatMapExpr class represents the compile time expression for the pairwise evaluation of a binary custom operation on the elements of two dense matrices with identical storage order via the map() function.

Member Enumeration Documentation

◆ anonymous enum

template<typename MT1 , typename MT2 , typename OP , bool SO>
anonymous enum : bool
private

Compilation switch for the serial evaluation strategy of the map expression.

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the map expression. In case either of the two dense matrix operands requires an intermediate evaluation, useAssign will be set to 1 and the addition 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.

Constructor & Destructor Documentation

◆ DMatDMatMapExpr()

template<typename MT1 , typename MT2 , typename OP , bool SO>
blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::DMatDMatMapExpr ( const MT1 &  lhs,
const MT2 &  rhs,
OP  op 
)
inlineexplicitnoexcept

Constructor for the DMatDMatMapExpr class.

Parameters
lhsThe left-hand side dense matrix operand of the map expression.
rhsThe right-hand side dense matrix operand of the map expression.
opThe custom unary operation.

Member Function Documentation

◆ at()

template<typename MT1 , typename MT2 , typename OP , bool SO>
ReturnType blaze::DMatDMatMapExpr< MT1, MT2, OP, 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.

◆ begin()

template<typename MT1 , typename MT2 , typename OP , bool SO>
ConstIterator blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::begin ( size_t  i) const
inline

Returns an iterator to the first non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator to the first non-zero element of row i.

◆ canAlias()

template<typename MT1 , typename MT2 , typename OP , bool SO>
template<typename T >
bool blaze::DMatDMatMapExpr< MT1, MT2, OP, 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 MT1 , typename MT2 , typename OP , bool SO>
bool blaze::DMatDMatMapExpr< MT1, MT2, OP, 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 MT1 , typename MT2 , typename OP , bool SO>
size_t blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ end()

template<typename MT1 , typename MT2 , typename OP , bool SO>
ConstIterator blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::end ( size_t  i) const
inline

Returns an iterator just past the last non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator just past the last non-zero element of row i.

◆ isAliased()

template<typename MT1 , typename MT2 , typename OP , bool SO>
template<typename T >
bool blaze::DMatDMatMapExpr< MT1, MT2, OP, 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 MT1 , typename MT2 , typename OP , bool SO>
bool blaze::DMatDMatMapExpr< MT1, MT2, OP, 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.

◆ leftOperand()

template<typename MT1 , typename MT2 , typename OP , bool SO>
LeftOperand blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side dense matrix operand.

Returns
The left-hand side dense matrix operand.

◆ load()

template<typename MT1 , typename MT2 , typename OP , bool SO>
BLAZE_ALWAYS_INLINE auto blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::load ( size_t  i,
size_t  j 
) const
inlinenoexcept

Access to the SIMD elements of the matrix.

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
Reference to the accessed values.

◆ operation()

template<typename MT1 , typename MT2 , typename OP , bool SO>
Operation blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::operation ( ) const
inline

Returns a copy of the custom operation.

Returns
A copy of the custom operation.

◆ operator()()

template<typename MT1 , typename MT2 , typename OP , bool SO>
ReturnType blaze::DMatDMatMapExpr< MT1, MT2, OP, 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]

template<typename MT, bool SO>
BLAZE_ALWAYS_INLINE MatrixType& blaze::Matrix< MT, SO >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.

◆ operator~() [2/2]

template<typename MT, bool SO>
BLAZE_ALWAYS_INLINE const MatrixType& blaze::Matrix< MT, SO >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.

◆ rightOperand()

template<typename MT1 , typename MT2 , typename OP , bool SO>
RightOperand blaze::DMatDMatMapExpr< MT1, MT2, OP, SO >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side dense matrix operand.

Returns
The right-hand side dense matrix operand.

◆ rows()

template<typename MT1 , typename MT2 , typename OP , bool SO>
size_t blaze::DMatDMatMapExpr< MT1, MT2, OP, 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: