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

Expression object for sparse vector-dense vector outer products.The SVecDVecOuterExpr class represents the compile time expression for sparse vector-dense vector outer products. More...

#include <SVecDVecOuterExpr.h>

Inherits blaze::VecTVecMultExpr< SparseMatrix< SVecDVecOuterExpr< VT1, VT2 >, true > >, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse vector-dense vector outer product expression. More...
 

Public Types

using This = SVecDVecOuterExpr< VT1, VT2 >
 Type of this SVecDVecOuterExpr instance.
 
using BaseType = SparseMatrix< This, true >
 Base type of this SVecDVecOuterExpr instance.
 
using ResultType = MultTrait_t< RT1, RT2 >
 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 = const If_t< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = If_t< useAssign, const ResultType, const SVecDVecOuterExpr & >
 Data type for composite expression templates.
 
using LeftOperand = If_t< IsExpression_v< VT1 >, const VT1, const VT1 & >
 Composite type of the left-hand side sparse vector expression.
 
using RightOperand = If_t< IsExpression_v< VT2 >, const VT2, const VT2 & >
 Composite type of the right-hand side dense vector expression.
 
using LT = If_t< IsComputation_v< VT1 >, const RT1, CT1 >
 Type for the assignment of the left-hand side dense vector operand.
 
using RT = If_t< IsComputation_v< VT2 >, const RT2, CT2 >
 Type for the assignment of the right-hand side dense vector operand.
 
using MatrixType = SVecDVecOuterExpr< VT1, VT2 >
 Type of the matrix.
 

Public Member Functions

 SVecDVecOuterExpr (const VT1 &lhs, const VT2 &rhs) noexcept
 Constructor for the SVecDVecOuterExpr 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...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of column i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of 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...
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse matrix. More...
 
size_t nonZeros (size_t i) const
 Returns the number of non-zero elements in the specified column. More...
 
ConstIterator find (size_t i, size_t j) const
 Searches for a specific matrix element. More...
 
ConstIterator lowerBound (size_t i, size_t j) const
 Returns an iterator to the first index not less then the given index. More...
 
ConstIterator upperBound (size_t i, size_t j) const
 Returns an iterator to the first index greater then the given index. More...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side sparse 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...
 
BLAZE_ALWAYS_INLINE constexpr MatrixTypeoperator~ () noexcept
 Conversion operator for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE constexpr const MatrixTypeoperator~ () const noexcept
 Conversion operator for constant matrices. More...
 

Static Public Attributes

static constexpr bool smpAssignable = false
 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 sparse vector expression.
 
using RT2 = ResultType_t< VT2 >
 Result type of the right-hand side dense vector expression.
 
using RN1 = ReturnType_t< VT1 >
 Return type of the left-hand side sparse 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 sparse vector expression.
 
using CT2 = CompositeType_t< VT2 >
 Composite type of the right-hand side dense vector expression.
 
using ET1 = ElementType_t< VT1 >
 Element type of the left-hand side sparse vector expression.
 
using ET2 = ElementType_t< VT2 >
 Element type of the right-hand side dense vector expression.
 
using ExprReturnType = decltype(std::declval< RN1 >() *std::declval< RN2 >())
 Expression return type for the subscript operator.
 

Private Attributes

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

Static Private Attributes

static constexpr bool returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> )
 Compilation switch for the selection of the subscript operator return type. More...
 
static constexpr bool useAssign
 Compilation switch for the evaluation strategy of the multiplication expression. More...
 

Detailed Description

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

Expression object for sparse vector-dense vector outer products.

The SVecDVecOuterExpr class represents the compile time expression for sparse vector-dense vector outer products.

Constructor & Destructor Documentation

◆ SVecDVecOuterExpr()

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

Constructor for the SVecDVecOuterExpr class.

Parameters
lhsThe left-hand side sparse 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::SVecDVecOuterExpr< 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::SVecDVecOuterExpr< VT1, VT2 >::begin ( size_t  i) const
inline

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

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

◆ canAlias()

template<typename VT1 , typename VT2 >
template<typename T >
bool blaze::SVecDVecOuterExpr< 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.

◆ columns()

template<typename VT1 , typename VT2 >
size_t blaze::SVecDVecOuterExpr< 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::SVecDVecOuterExpr< VT1, VT2 >::end ( size_t  i) const
inline

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

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

◆ find()

template<typename VT1 , typename VT2 >
ConstIterator blaze::SVecDVecOuterExpr< VT1, VT2 >::find ( size_t  i,
size_t  j 
) const
inline

Searches for a specific matrix element.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the element in case the index is found, end() iterator otherwise.

◆ isAliased()

template<typename VT1 , typename VT2 >
template<typename T >
bool blaze::SVecDVecOuterExpr< 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.

◆ leftOperand()

template<typename VT1 , typename VT2 >
LeftOperand blaze::SVecDVecOuterExpr< VT1, VT2 >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side sparse vector operand.

Returns
The left-hand side sparse vector operand.

◆ lowerBound()

template<typename VT1 , typename VT2 >
ConstIterator blaze::SVecDVecOuterExpr< VT1, VT2 >::lowerBound ( size_t  i,
size_t  j 
) const
inline

Returns an iterator to the first index not less then the given index.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the first index not less then the given index, end() iterator otherwise.

◆ nonZeros() [1/2]

template<typename VT1 , typename VT2 >
size_t blaze::SVecDVecOuterExpr< VT1, VT2 >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the sparse matrix.

Returns
The number of non-zero elements in the sparse matrix.

◆ nonZeros() [2/2]

template<typename VT1 , typename VT2 >
size_t blaze::SVecDVecOuterExpr< VT1, VT2 >::nonZeros ( size_t  i) const
inline

Returns the number of non-zero elements in the specified column.

Parameters
iThe index of the column.
Returns
The number of non-zero elements of column i.

◆ operator()()

template<typename VT1 , typename VT2 >
ReturnType blaze::SVecDVecOuterExpr< 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]

BLAZE_ALWAYS_INLINE constexpr MatrixType& blaze::Matrix< SVecDVecOuterExpr< VT1, VT2 > , SO >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.

◆ operator~() [2/2]

BLAZE_ALWAYS_INLINE constexpr const MatrixType& blaze::Matrix< SVecDVecOuterExpr< VT1, VT2 > , 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::SVecDVecOuterExpr< 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::SVecDVecOuterExpr< VT1, VT2 >::rows ( ) const
inlinenoexcept

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.

◆ upperBound()

template<typename VT1 , typename VT2 >
ConstIterator blaze::SVecDVecOuterExpr< VT1, VT2 >::upperBound ( size_t  i,
size_t  j 
) const
inline

Returns an iterator to the first index greater then the given index.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the first index greater then the given index, end() iterator otherwise.

Member Data Documentation

◆ returnExpr

template<typename VT1 , typename VT2 >
constexpr bool blaze::SVecDVecOuterExpr< VT1, VT2 >::returnExpr = ( !IsTemporary_v<RN1> && !IsTemporary_v<RN2> )
staticprivate

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.

◆ useAssign

template<typename VT1 , typename VT2 >
constexpr bool blaze::SVecDVecOuterExpr< VT1, VT2 >::useAssign
staticprivate
Initial value:
=
( IsComputation_v<VT1> || !IsNumeric_v<ET1> || IsComputation_v<VT2> || !IsNumeric_v<ET2> )

Compilation switch for the evaluation strategy of the multiplication expression.

The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the multiplication expression. In case either the sparse or the dense vector operand is an expression or if any of two involved element types is not a numeric data type, useAssign will be set to true and the multiplication expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the subscript operator.


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