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

Expression object for the dense vector-dense vector outer map() function. More...

#include <DVecDVecOuterExpr.h>

Inherits blaze::VecTVecMapExpr< DenseMatrix< DVecDVecOuterExpr< VT1, VT2, OP >, false > >, and blaze::Computation.

Classes

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

Public Types

using This = DVecDVecOuterExpr< VT1, VT2, OP >
 Type of this DVecDVecOuterExpr instance.
 
using BaseType = VecTVecMapExpr< DenseMatrix< This, false > >
 Base type of this DVecDVecOuterExpr instance.
 
using ResultType = MapTrait_t< RT1, RT2, OP >
 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 = decltype(std::declval< OP >()(std::declval< RN1 >(), std::declval< RN2 >()))
 Return type for expression template evaluations.
 
using CompositeType = If_t< useAssign, const ResultType, const DVecDVecOuterExpr & >
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< VT1 >, const VT1, const VT1 & >
 Composite type of the left-hand side dense vector expression.
 
using RightOperand = If_t< IsExpression_v< VT2 >, const VT2, const VT2 & >
 Composite type of the right-hand side dense vector expression.
 
using Operation = OP
 Data type of the custom binary operation.
 
using LT = If_t< RequiresEvaluation_v< VT1 >, const RT1, CT1 >
 Type for the assignment of the left-hand side dense vector operand.
 
using RT = If_t< RequiresEvaluation_v< VT2 >, const RT2, CT2 >
 Type for the assignment of the right-hand side dense vector operand.
 
using MatrixType = DVecDVecOuterExpr< VT1, VT2, OP >
 Type of the matrix.
 

Public Member Functions

 DVecDVecOuterExpr (const VT1 &lhs, const VT2 &rhs, OP op) noexcept
 Constructor for the DVecDVecOuterExpr 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 vector operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side dense vector 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...
 
Conversion operators
BLAZE_ALWAYS_INLINE constexpr DVecDVecOuterExpr< VT1, VT2, OP > & operator~ () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const DVecDVecOuterExpr< VT1, VT2, OP > & operator~ () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 
constexpr DVecDVecOuterExpr< VT1, VT2, OP > & operator* () noexcept
 CRTP-based conversion operation for non-constant matrices. More...
 
constexpr const DVecDVecOuterExpr< VT1, VT2, OP > & operator* () const noexcept
 CRTP-based conversion operation for constant matrices. More...
 

Static Public Attributes

static constexpr bool simdEnabled
 Compilation switch for the expression template evaluation strategy. More...
 
static constexpr bool smpAssignable = ( VT1::smpAssignable && VT2::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.
 

Private Types

using RT1 = ResultType_t< VT1 >
 Result type of the left-hand side dense vector expression.
 
using RT2 = ResultType_t< VT2 >
 Result type of the right-hand side dense vector expression.
 
using ET1 = ElementType_t< VT1 >
 Element type of the left-hand side dense vector expression.
 
using ET2 = ElementType_t< VT2 >
 Element type of the right-hand side dense vector expression.
 
using RN1 = ReturnType_t< VT1 >
 Return type of the left-hand side dense vector expression.
 
using RN2 = ReturnType_t< VT2 >
 Return type of the right-hand side dense vector expression.
 
using CT1 = CompositeType_t< VT1 >
 Composite type of the left-hand side dense vector expression.
 
using CT2 = CompositeType_t< VT2 >
 Composite type of the right-hand side dense vector expression.
 

Private Attributes

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

Static Private Attributes

static constexpr bool evaluateLeft = ( IsComputation_v<VT1> || RequiresEvaluation_v<VT1> )
 Compilation switch for the composite type of the left-hand side dense vector expression.
 
static constexpr bool evaluateRight = ( IsComputation_v<VT2> || RequiresEvaluation_v<VT2> )
 Compilation switch for the composite type of the right-hand side dense vector expression.
 
static constexpr bool useAssign = ( evaluateLeft || evaluateRight )
 Compilation switch for the serial evaluation strategy of the map expression. More...
 

Detailed Description

template<typename VT1, typename VT2, typename OP>
class blaze::DVecDVecOuterExpr< VT1, VT2, OP >

Expression object for the dense vector-dense vector outer map() function.

The DVecDVecOuterExpr class represents the compile time expression for the pairwise (outer) evaluation of a binary custom operation on the elements of two dense vectors via the map() function.

Constructor & Destructor Documentation

◆ DVecDVecOuterExpr()

template<typename VT1 , typename VT2 , typename OP >
blaze::DVecDVecOuterExpr< VT1, VT2, OP >::DVecDVecOuterExpr ( const VT1 &  lhs,
const VT2 &  rhs,
OP  op 
)
inlinenoexcept

Constructor for the DVecDVecOuterExpr class.

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

Member Function Documentation

◆ at()

template<typename VT1 , typename VT2 , typename OP >
ReturnType blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
ConstIterator blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
template<typename T >
bool blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
bool blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
size_t blaze::DVecDVecOuterExpr< VT1, VT2, OP >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ end()

template<typename VT1 , typename VT2 , typename OP >
ConstIterator blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
template<typename T >
bool blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
bool blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
LeftOperand blaze::DVecDVecOuterExpr< VT1, VT2, OP >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.

◆ load()

template<typename VT1 , typename VT2 , typename OP >
BLAZE_ALWAYS_INLINE auto blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 VT1 , typename VT2 , typename OP >
Operation blaze::DVecDVecOuterExpr< VT1, VT2, OP >::operation ( ) const
inline

Returns a copy of the custom operation.

Returns
A copy of the custom operation.

◆ operator()()

template<typename VT1 , typename VT2 , typename OP >
ReturnType blaze::DVecDVecOuterExpr< VT1, VT2, OP >::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 DVecDVecOuterExpr< VT1, VT2, OP > & blaze::Matrix< DVecDVecOuterExpr< VT1, VT2, OP > , 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 DVecDVecOuterExpr< VT1, VT2, OP > & blaze::Matrix< DVecDVecOuterExpr< VT1, VT2, OP > , 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 DVecDVecOuterExpr< VT1, VT2, OP > & blaze::Matrix< DVecDVecOuterExpr< VT1, VT2, OP > , 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 DVecDVecOuterExpr< VT1, VT2, OP > & blaze::Matrix< DVecDVecOuterExpr< VT1, VT2, OP > , 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.

◆ rightOperand()

template<typename VT1 , typename VT2 , typename OP >
RightOperand blaze::DVecDVecOuterExpr< VT1, VT2, OP >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side dense vector operand.

Returns
The right-hand side dense vector operand.

◆ rows()

template<typename VT1 , typename VT2 , typename OP >
size_t blaze::DVecDVecOuterExpr< VT1, VT2, OP >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

Member Data Documentation

◆ simdEnabled

template<typename VT1 , typename VT2 , typename OP >
constexpr bool blaze::DVecDVecOuterExpr< VT1, VT2, OP >::simdEnabled
staticconstexpr
Initial value:
=
( VT1::simdEnabled && VT2::simdEnabled &&
If_t< HasSIMDEnabled_v<OP>, GetSIMDEnabled<OP,ET1,ET2>, HasLoad<OP> >::value )

Compilation switch for the expression template evaluation strategy.

◆ useAssign

template<typename VT1 , typename VT2 , typename OP >
constexpr bool blaze::DVecDVecOuterExpr< VT1, VT2, OP >::useAssign = ( evaluateLeft || evaluateRight )
staticconstexprprivate

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 vector operands requires an intermediate evaluation, useAssign will be set to true and the map expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the function call operator.


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