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

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

#include <SVecTSVecMultExpr.h>

Inherits blaze::SparseMatrix< SVecTSVecMultExpr< VT1, VT2 >, false >, blaze::VecTVecMultExpr, and blaze::Computation.

Public Types

enum  : bool { smpAssignable = false }
 Compilation switch for the expression template assignment strategy.
 
typedef SVecTSVecMultExpr< VT1, VT2 > This
 Type of this SVecTSVecMultExpr instance.
 
typedef MultTrait_< RT1, RT2ResultType
 Result type for expression template evaluations.
 
typedef OppositeType_< ResultTypeOppositeType
 Result type with opposite storage order for expression template evaluations.
 
typedef TransposeType_< ResultTypeTransposeType
 Transpose type for expression template evaluations.
 
typedef ElementType_< ResultTypeElementType
 Resulting element type.
 
typedef const IfTrue_< returnExpr, ExprReturnType, ElementTypeReturnType
 Return type for expression template evaluations.
 
typedef const ResultType CompositeType
 Data type for composite expression templates.
 
typedef If_< IsExpression< VT1 >, const VT1, const VT1 & > LeftOperand
 Composite type of the left-hand side sparse vector expression.
 
typedef If_< IsExpression< VT2 >, const VT2, const VT2 & > RightOperand
 Composite type of the right-hand side sparse vector expression.
 
typedef If_< IsComputation< VT1 >, const RT1, CT1LT
 Type for the assignment of the left-hand side dense vector operand.
 
typedef If_< IsComputation< VT2 >, const RT2, CT2RT
 Type for the assignment of the right-hand side dense vector operand.
 
typedef SVecTSVecMultExpr< VT1, VT2 > MatrixType
 Type of the matrix.
 

Public Member Functions

 SVecTSVecMultExpr (const VT1 &lhs, const VT2 &rhs) noexcept
 Constructor for the SVecTSVecMultExpr 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...
 
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 row. More...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side sparse vector operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side sparse 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 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 { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
typedef ResultType_< VT1 > RT1
 Result type of the left-hand side sparse vector expression.
 
typedef ResultType_< VT2 > RT2
 Result type of the right-hand side sparse vector expression.
 
typedef ReturnType_< VT1 > RN1
 Return type of the left-hand side sparse vector expression.
 
typedef ReturnType_< VT2 > RN2
 Return type of the right-hand side sparse vector expression.
 
typedef CompositeType_< VT1 > CT1
 Composite type of the left-hand side sparse vector expression.
 
typedef CompositeType_< VT2 > CT2
 Composite type of the right-hand side sparse vector expression.
 
typedef MultExprTrait_< RN1, RN2ExprReturnType
 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 sparse vector of the multiplication expression.
 

Detailed Description

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

Expression object for sparse vector-sparse vector outer products.

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

Member Enumeration Documentation

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.

Constructor & Destructor Documentation

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

Constructor for the SVecTSVecMultExpr class.

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

Member Function Documentation

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

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.
template<typename VT1 , typename VT2 >
template<typename T >
bool blaze::SVecTSVecMultExpr< 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.
template<typename VT1 , typename VT2 >
LeftOperand blaze::SVecTSVecMultExpr< VT1, VT2 >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side sparse vector operand.

Returns
The left-hand side sparse vector operand.
template<typename VT1 , typename VT2 >
size_t blaze::SVecTSVecMultExpr< 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.
template<typename VT1 , typename VT2 >
size_t blaze::SVecTSVecMultExpr< VT1, VT2 >::nonZeros ( size_t  i) const
inline

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

Parameters
iThe index of the row.
Returns
The number of non-zero elements of row i.
template<typename VT1 , typename VT2 >
ReturnType blaze::SVecTSVecMultExpr< 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.
BLAZE_ALWAYS_INLINE MatrixType& blaze::Matrix< SVecTSVecMultExpr< VT1, VT2 > , SO >::operator~ ( )
inlinenoexceptinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.
BLAZE_ALWAYS_INLINE const MatrixType& blaze::Matrix< SVecTSVecMultExpr< VT1, VT2 > , SO >::operator~ ( ) const
inlinenoexceptinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.
template<typename VT1 , typename VT2 >
RightOperand blaze::SVecTSVecMultExpr< VT1, VT2 >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side sparse vector operand.

Returns
The right-hand side sparse vector operand.
template<typename VT1 , typename VT2 >
size_t blaze::SVecTSVecMultExpr< 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 files: