Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::TSMatDMatSubExpr< MT1, MT2 > Class Template Reference

Expression object for transpose sparse matrix-dense matrix subtractions.The TSMatDMatSubExpr class represents the compile time expression for subtractions between a column-major sparse matrix and a row-major dense matrix. More...

#include <TSMatDMatSubExpr.h>

Inherits blaze::MatMatSubExpr< DenseMatrix< TSMatDMatSubExpr< MT1, MT2 >, false > >, and blaze::Computation.

Public Types

enum  : bool { simdEnabled = false }
 Compilation switch for the expression template evaluation strategy.
 
enum  : bool { smpAssignable = false }
 Compilation switch for the expression template assignment strategy.
 
using This = TSMatDMatSubExpr< MT1, MT2 >
 Type of this TSMatDMatSubExpr instance.
 
using ResultType = SubTrait_< 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 ReturnType = const IfTrue_< returnExpr, ExprReturnType, ElementType >
 Return type for expression template evaluations.
 
using CompositeType = const ResultType
 Data type for composite expression templates.
 
using LeftOperand = If_< IsExpression< MT1 >, const MT1, const MT1 &>
 Composite type of the left-hand side dense matrix expression.
 
using RightOperand = If_< IsExpression< MT2 >, const MT2, const MT2 &>
 Composite type of the right-hand side sparse matrix expression.
 
using MatrixType = MT
 Type of the matrix.
 

Public Member Functions

 TSMatDMatSubExpr (const MT1 &lhs, const MT2 &rhs) noexcept
 Constructor for the TSMatDMatSubExpr 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...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side transpose sparse matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side dense matrix 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...
 
using RT1 = ResultType_< MT1 >
 Result type of the left-hand side sparse matrix expression.
 
using RT2 = ResultType_< MT2 >
 Result type of the right-hand side dense matrix expression.
 
using RN1 = ReturnType_< MT1 >
 Return type of the left-hand side sparse matrix expression.
 
using RN2 = ReturnType_< MT2 >
 Return type of the right-hand side dense matrix expression.
 
using ExprReturnType = SubExprTrait_< RN1, RN2 >
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side sparse matrix of the subtraction expression.
 
RightOperand rhs_
 Right-hand side dense matrix of the subtraction expression.
 

Detailed Description

template<typename MT1, typename MT2>
class blaze::TSMatDMatSubExpr< MT1, MT2 >

Expression object for transpose sparse matrix-dense matrix subtractions.

The TSMatDMatSubExpr class represents the compile time expression for subtractions between a column-major sparse matrix and a row-major dense matrix.

Member Enumeration Documentation

◆ anonymous enum

template<typename MT1 , typename MT2 >
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 matrix 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

◆ TSMatDMatSubExpr()

template<typename MT1 , typename MT2 >
blaze::TSMatDMatSubExpr< MT1, MT2 >::TSMatDMatSubExpr ( const MT1 &  lhs,
const MT2 &  rhs 
)
inlineexplicitnoexcept

Constructor for the TSMatDMatSubExpr class.

Parameters
lhsThe left-hand side sparse matrix operand of the addition expression.
rhsThe right-hand side dense matrix operand of the addition expression.

Member Function Documentation

◆ at()

template<typename MT1 , typename MT2 >
ReturnType blaze::TSMatDMatSubExpr< MT1, MT2 >::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.

◆ canAlias()

template<typename MT1 , typename MT2 >
template<typename T >
bool blaze::TSMatDMatSubExpr< MT1, MT2 >::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 MT1 , typename MT2 >
size_t blaze::TSMatDMatSubExpr< MT1, MT2 >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.

◆ isAliased()

template<typename MT1 , typename MT2 >
template<typename T >
bool blaze::TSMatDMatSubExpr< MT1, MT2 >::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 MT1 , typename MT2 >
LeftOperand blaze::TSMatDMatSubExpr< MT1, MT2 >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side transpose sparse matrix operand.

Returns
The left-hand side transpose sparse matrix operand.

◆ operator()()

template<typename MT1 , typename MT2 >
ReturnType blaze::TSMatDMatSubExpr< MT1, MT2 >::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 MT1 , typename MT2 >
RightOperand blaze::TSMatDMatSubExpr< MT1, MT2 >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side dense matrix operand.

Returns
The right-hand side dense matrix operand.

◆ rows()

template<typename MT1 , typename MT2 >
size_t blaze::TSMatDMatSubExpr< MT1, MT2 >::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: