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

Expression object for outer products between two dense vectors.The DVecDVecOuterExpr class represents the compile time expression for outer products between dense vectors. More...

#include <DVecDVecOuterExpr.h>

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

Classes

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

Public Types

enum  : bool { simdEnabled }
 Compilation switch for the expression template evaluation strategy.
 
enum  : bool { smpAssignable = VT1::smpAssignable && !evaluateRight }
 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 = DVecDVecOuterExpr< VT1, VT2 >
 Type of this DVecDVecOuterExpr instance.
 
using ResultType = MultTrait_< RT1, RT2 >
 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 SIMDType = SIMDTrait_< ElementType >
 Resulting SIMD element type.
 
using ReturnType = const IfTrue_< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = IfTrue_< useAssign, const ResultType, const DVecDVecOuterExpr &>
 Data type for composite expression templates.
 
using LeftOperand = If_< IsExpression< VT1 >, const VT1, const VT1 &>
 Composite type of the left-hand side dense vector expression.
 
using RightOperand = If_< IsExpression< VT2 >, const VT2, const VT2 &>
 Composite type of the right-hand side dense vector expression.
 
using LT = IfTrue_< evaluateLeft, const RT1, CT1 >
 Type for the assignment of the left-hand side dense vector operand.
 
using RT = IfTrue_< evaluateRight, const RT2, CT2 >
 Type for the assignment of the right-hand side dense vector operand.
 
using MatrixType = MT
 Type of the matrix.
 

Public Member Functions

 DVecDVecOuterExpr (const VT1 &lhs, const VT2 &rhs) 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...
 
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 { evaluateLeft = IsComputation<VT1>::value || RequiresEvaluation<VT1>::value }
 Compilation switch for the composite type of the left-hand side dense vector expression.
 
enum  : bool { evaluateRight = IsComputation<VT2>::value || RequiresEvaluation<VT2>::value }
 Compilation switch for the composite type of the right-hand side dense vector expression.
 
enum  : bool { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  : bool { useAssign = ( evaluateLeft || evaluateRight ) }
 Compilation switch for the serial evaluation strategy of the outer product expression. More...
 
using RT1 = ResultType_< VT1 >
 Result type of the left-hand side dense vector expression.
 
using RT2 = ResultType_< VT2 >
 Result type of the right-hand side dense vector expression.
 
using ET1 = ElementType_< RT1 >
 Element type of the left-hand side dense vector expression.
 
using ET2 = ElementType_< RT2 >
 Element type of the right-hand side dense vector expression.
 
using RN1 = ReturnType_< VT1 >
 Return type of the left-hand side dense vector expression.
 
using RN2 = ReturnType_< VT2 >
 Return type of the right-hand side dense vector expression.
 
using CT1 = CompositeType_< VT1 >
 Composite type of the left-hand side dense vector expression.
 
using CT2 = CompositeType_< VT2 >
 Composite type of the right-hand side dense vector expression.
 
using ExprReturnType = MultExprTrait_< RN1, RN2 >
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side dense vector of the multiplication expression.
 
RightOperand rhs_
 Right-hand side dense vector of the multiplication expression.
 

Detailed Description

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

Expression object for outer products between two dense vectors.

The DVecDVecOuterExpr class represents the compile time expression for outer products between dense vectors.

Member Enumeration Documentation

◆ anonymous enum

template<typename VT1 , typename VT2 >
anonymous enum : bool
private

Compilation switch for the selection of the subscript operator return type.

The returnExpr compile time constant expression is a compilation switch for the selection of the ReturnType. If either vector operand returns a temporary vector or matrix, returnExpr will be set to false and the subscript operator will return it's result by value. Otherwise returnExpr will be set to true and the subscript operator may return it's result as an expression.

◆ anonymous enum

template<typename VT1 , typename VT2 >
anonymous enum : bool
private

Compilation switch for the serial evaluation strategy of the outer product expression.

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

Constructor & Destructor Documentation

◆ DVecDVecOuterExpr()

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

Constructor for the DVecDVecOuterExpr class.

Parameters
lhsThe left-hand side dense vector operand of the multiplication expression.
rhsThe right-hand side dense vector operand of the multiplication expression.

Member Function Documentation

◆ at()

template<typename VT1 , typename VT2 >
ReturnType blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
ConstIterator blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
template<typename T >
bool blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
bool blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
size_t blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
ConstIterator blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
template<typename T >
bool blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
bool blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
LeftOperand blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
BLAZE_ALWAYS_INLINE auto blaze::DVecDVecOuterExpr< VT1, VT2 >::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.

◆ operator()()

template<typename VT1 , typename VT2 >
ReturnType blaze::DVecDVecOuterExpr< VT1, VT2 >::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 VT1 , typename VT2 >
RightOperand blaze::DVecDVecOuterExpr< VT1, VT2 >::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 >
size_t blaze::DVecDVecOuterExpr< VT1, VT2 >::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: