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

Expression object for the dense matrix map() function.The DMatMapExpr class represents the compile time expression for the evaluation of a custom operation on each element of a dense matrix via the map() function. More...

#include <DMatMapExpr.h>

Inherits blaze::MatMapExpr< DenseMatrix< DMatMapExpr< MT, 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 = MT::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 = DMatMapExpr< MT, OP, SO >
 Type of this DMatMapExpr instance.
 
using ResultType = UnaryMapTrait_< RT, 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< RN >()))
 Return type for expression template evaluations.
 
using CompositeType = IfTrue_< useAssign, const ResultType, const DMatMapExpr &>
 Data type for composite expression templates.
 
using Operand = If_< IsExpression< MT >, const MT, const MT &>
 Composite data type of the dense matrix expression.
 
using Operation = OP
 Data type of the custom unary operation.
 
using MatrixType = MT
 Type of the matrix.
 

Public Member Functions

 DMatMapExpr (const MT &dm, OP op) noexcept
 Constructor for the DMatMapExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const noexcept
 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...
 
Operand operand () const noexcept
 Returns the 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<MT>::value }
 Compilation switch for the serial evaluation strategy of the map expression. More...
 
using RT = ResultType_< MT >
 Result type of the dense matrix expression.
 
using OT = OppositeType_< MT >
 Opposite type of the dense matrix expression.
 
using ET = ElementType_< MT >
 Element type of the dense matrix expression.
 
using RN = ReturnType_< MT >
 Return type of the 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

Operand dm_
 Dense matrix of the map expression.
 
Operation op_
 The custom unary operation.
 

Detailed Description

template<typename MT, typename OP, bool SO>
class blaze::DMatMapExpr< MT, OP, SO >

Expression object for the dense matrix map() function.

The DMatMapExpr class represents the compile time expression for the evaluation of a custom operation on each element of a dense matrix via the map() function.

Member Enumeration Documentation

◆ anonymous enum

template<typename MT, 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 the given dense matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the map 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

◆ DMatMapExpr()

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

Constructor for the DMatMapExpr class.

Parameters
dmThe dense matrix operand of the map expression.
opThe custom unary operation.

Member Function Documentation

◆ at()

template<typename MT, typename OP, bool SO>
ReturnType blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
ConstIterator blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
template<typename T >
bool blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
bool blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
size_t blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
ConstIterator blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
template<typename T >
bool blaze::DMatMapExpr< MT, 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 MT, typename OP, bool SO>
bool blaze::DMatMapExpr< MT, 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.

◆ load()

template<typename MT, typename OP, bool SO>
BLAZE_ALWAYS_INLINE auto blaze::DMatMapExpr< MT, 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.

◆ operand()

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

Returns the dense matrix operand.

Returns
The dense matrix operand.

◆ operation()

template<typename MT, typename OP, bool SO>
Operation blaze::DMatMapExpr< MT, OP, SO >::operation ( ) const
inline

Returns a copy of the custom operation.

Returns
A copy of the custom operation.

◆ operator()()

template<typename MT, typename OP, bool SO>
ReturnType blaze::DMatMapExpr< MT, OP, SO >::operator() ( size_t  i,
size_t  j 
) const
inlinenoexcept

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.

◆ rows()

template<typename MT, typename OP, bool SO>
size_t blaze::DMatMapExpr< MT, 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: