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

Expression object for the dense matrix generate() function. More...

#include <DMatGenExpr.h>

Inherits blaze::MatGenExpr< DenseMatrix< DMatGenExpr< MT, OP, SO >, SO > >, and blaze::Computation.

Classes

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

Public Types

using This = DMatGenExpr< MT, OP, SO >
 Type of this DMatGenExpr instance.
 
using BaseType = MatGenExpr< DenseMatrix< This, SO > >
 Base type of this DMatGenExpr instance.
 
using ResultType = RemoveCVRef_t< MT >
 Result type 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 = decltype(std::declval< OP >()(std::declval< size_t >(), std::declval< size_t >()))
 Return type for expression template evaluations.
 
using CompositeType = const DMatGenExpr &
 Data type for composite expression templates.
 
using Operation = OP
 Data type of the custom binary operation.
 
using MatrixType = DMatGenExpr< MT, OP, SO >
 Type of the matrix.
 

Public Member Functions

 DMatGenExpr (size_t m, size_t n, OP &&op) noexcept
 Constructor for the DMatGenExpr 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...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row/column i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row/column 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...
 
Operation operation () const
 Returns a copy of the custom binary 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...
 
Conversion operators
BLAZE_ALWAYS_INLINE constexpr DMatGenExpr< MT, OP, SO > & operator~ () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const DMatGenExpr< MT, OP, SO > & operator~ () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 
constexpr DMatGenExpr< MT, OP, SO > & operator* () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
constexpr const DMatGenExpr< MT, OP, 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 = true
 Compilation switch for the expression template assignment strategy.
 
static constexpr bool storageOrder
 Storage order of the matrix.
 

Private Attributes

size_t m_
 The number of rows of the dense matrix generator.
 
size_t n_
 The number of columns of the dense matrix generator.
 
Operation op_
 The custom binary operation.
 

Detailed Description

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

Expression object for the dense matrix generate() function.

The DMatGenExpr class represents the compile time expression for the generation of a custom dense matrix via the generate() function.

Constructor & Destructor Documentation

◆ DMatGenExpr()

template<typename MT , typename OP , bool SO>
blaze::DMatGenExpr< MT, OP, SO >::DMatGenExpr ( size_t  m,
size_t  n,
OP &&  op 
)
inlinenoexcept

Constructor for the DMatGenExpr class.

Parameters
mThe number of rows of the dense matrix generator.
nThe number of columns of the dense matrix generator.
opThe custom binary operation.

Member Function Documentation

◆ at()

template<typename MT , typename OP , bool SO>
ReturnType blaze::DMatGenExpr< 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::DMatGenExpr< MT, OP, SO >::begin ( size_t  i) const
inline

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

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

◆ canAlias()

template<typename MT , typename OP , bool SO>
template<typename T >
bool blaze::DMatGenExpr< 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::DMatGenExpr< 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::DMatGenExpr< 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::DMatGenExpr< MT, OP, SO >::end ( size_t  i) const
inline

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

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

◆ isAliased()

template<typename MT , typename OP , bool SO>
template<typename T >
bool blaze::DMatGenExpr< 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::DMatGenExpr< 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.

◆ operation()

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

Returns a copy of the custom binary operation.

Returns
A copy of the custom binary operation.

◆ operator()()

template<typename MT , typename OP , bool SO>
ReturnType blaze::DMatGenExpr< 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]

BLAZE_ALWAYS_INLINE constexpr const DMatGenExpr< MT, OP, SO > & blaze::Matrix< DMatGenExpr< MT, OP, 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 DMatGenExpr< MT, OP, SO > & blaze::Matrix< DMatGenExpr< MT, OP, 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 DMatGenExpr< MT, OP, SO > & blaze::Matrix< DMatGenExpr< MT, OP, 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 DMatGenExpr< MT, OP, SO > & blaze::Matrix< DMatGenExpr< MT, OP, 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 , typename OP , bool SO>
size_t blaze::DMatGenExpr< 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: