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

Expression object for sparse matrix-sparse matrix subtractions.The SMatSMatSubExpr class represents the compile time expression for subtractions between sparse matrices. More...

#include <SMatSMatSubExpr.h>

Inherits blaze::SparseMatrix< SMatSMatSubExpr< MT1, MT2 >, false >, blaze::MatMatSubExpr, and blaze::Computation.

Public Types

enum  { smpAssignable = 0 }
 Compilation switch for the expression template assignment strategy.
 
typedef SMatSMatSubExpr< MT1, MT2 > This
 Type of this SMatSMatSubExpr instance.
 
typedef SubTrait< RT1, RT2 >::Type ResultType
 Result type for expression template evaluations.
 
typedef ResultType::OppositeType OppositeType
 Result type with opposite storage order for expression template evaluations.
 
typedef ResultType::TransposeType TransposeType
 Transpose type for expression template evaluations.
 
typedef ResultType::ElementType ElementType
 Resulting element type.
 
typedef const SelectType< returnExpr, ExprReturnType, ElementType >::Type ReturnType
 Return type for expression template evaluations.
 
typedef const ResultType CompositeType
 Data type for composite expression templates.
 
typedef SelectType< IsExpression< MT1 >::value, const MT1, const MT1 & >::Type LeftOperand
 Composite type of the left-hand side sparse matrix expression.
 
typedef SelectType< IsExpression< MT2 >::value, const MT2, const MT2 & >::Type RightOperand
 Composite type of the right-hand side sparse matrix expression.
 
typedef SMatSMatSubExpr< MT1, MT2 > MatrixType
 Type of the matrix.
 

Public Member Functions

 SMatSMatSubExpr (const MT1 &lhs, const MT2 &rhs)
 Constructor for the SMatSMatSubExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
size_t rows () const
 Returns the current number of rows of the matrix. More...
 
size_t columns () const
 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
 Returns the left-hand side sparse matrix operand. More...
 
RightOperand rightOperand () const
 Returns the right-hand side sparse matrix operand. More...
 
template<typename T >
bool canAlias (const T *alias) const
 Returns whether the expression can alias with the given address alias. More...
 
template<typename T >
bool isAliased (const T *alias) const
 Returns whether the expression is aliased with the given address alias. More...
 
BLAZE_ALWAYS_INLINE MatrixTypeoperator~ ()
 Conversion operator for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE const MatrixTypeoperator~ () const
 Conversion operator for constant matrices. More...
 

Private Types

enum  { returnExpr = !IsTemporary<RN1>::value && !IsTemporary<RN2>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
typedef MT1::ResultType RT1
 Result type of the left-hand side sparse matrix expression.
 
typedef MT2::ResultType RT2
 Result type of the right-hand side sparse matrix expression.
 
typedef MT1::ReturnType RN1
 ReturnType type of the left-hand side sparse matrix expression.
 
typedef MT2::ReturnType RN2
 ReturnType type of the right-hand side sparse matrix expression.
 
typedef MT1::CompositeType CT1
 Composite type of the left-hand side sparse matrix expression.
 
typedef MT2::CompositeType CT2
 Composite type of the right-hand side sparse matrix expression.
 
typedef SubExprTrait< RN1, RN2 >::Type ExprReturnType
 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 sparse matrix of the subtraction expression.
 

Detailed Description

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

Expression object for sparse matrix-sparse matrix subtractions.

The SMatSMatSubExpr class represents the compile time expression for subtractions between sparse matrices.

Constructor & Destructor Documentation

template<typename MT1 , typename MT2 >
blaze::SMatSMatSubExpr< MT1, MT2 >::SMatSMatSubExpr ( const MT1 &  lhs,
const MT2 &  rhs 
)
inlineexplicit

Constructor for the SMatSMatSubExpr class.

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

Member Function Documentation

template<typename MT1 , typename MT2 >
template<typename T >
bool blaze::SMatSMatSubExpr< MT1, MT2 >::canAlias ( const T *  alias) const
inline

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 MT1 , typename MT2 >
size_t blaze::SMatSMatSubExpr< MT1, MT2 >::columns ( ) const
inline

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.
template<typename MT1 , typename MT2 >
template<typename T >
bool blaze::SMatSMatSubExpr< MT1, MT2 >::isAliased ( const T *  alias) const
inline

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 MT1 , typename MT2 >
LeftOperand blaze::SMatSMatSubExpr< MT1, MT2 >::leftOperand ( ) const
inline

Returns the left-hand side sparse matrix operand.

Returns
The left-hand side sparse matrix operand.
template<typename MT1 , typename MT2 >
size_t blaze::SMatSMatSubExpr< MT1, MT2 >::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 MT1 , typename MT2 >
size_t blaze::SMatSMatSubExpr< MT1, MT2 >::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 MT1 , typename MT2 >
ReturnType blaze::SMatSMatSubExpr< 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.
BLAZE_ALWAYS_INLINE MatrixType& blaze::Matrix< SMatSMatSubExpr< MT1, MT2 > , SO >::operator~ ( )
inlineinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.
BLAZE_ALWAYS_INLINE const MatrixType& blaze::Matrix< SMatSMatSubExpr< MT1, MT2 > , SO >::operator~ ( ) const
inlineinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.
template<typename MT1 , typename MT2 >
RightOperand blaze::SMatSMatSubExpr< MT1, MT2 >::rightOperand ( ) const
inline

Returns the right-hand side sparse matrix operand.

Returns
The right-hand side sparse matrix operand.
template<typename MT1 , typename MT2 >
size_t blaze::SMatSMatSubExpr< MT1, MT2 >::rows ( ) const
inline

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: