All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::TSMatTSMatAddExpr< typename, typename > Class Template Reference

Expression object for transpose sparse matrix-transpose sparse matrix additions.The TSMatTSMatAddExpr class represents the compile time expression for additions between two column-major sparse matrices. More...

#include <TSMatTSMatAddExpr.h>

Inherits blaze::SparseMatrix< TSMatTSMatAddExpr< MT1, MT2 >, true >, blaze::MatMatAddExpr, and blaze::Computation.

Public Types

typedef TSMatTSMatAddExpr< MT1,
MT2 > 
This
 Type of this TSMatTSMatAddExpr instance.
 
typedef AddTrait< 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 MT MatrixType
 Type of the matrix.
 

Public Member Functions

 TSMatTSMatAddExpr (const MT1 &lhs, const MT2 &rhs)
 Constructor for the TSMatTSMatAddExpr 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 transpose sparse matrix operand. More...
 
RightOperand rightOperand () const
 Returns the right-hand side transpose 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...
 
MatrixTypeoperator~ ()
 Conversion operator for non-constant matrices. More...
 
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
 Return type of the left-hand side sparse matrix expression.
 
typedef MT2::ReturnType RN2
 Return 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 AddExprTrait< RN1, RN2 >
::Type 
ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

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

Detailed Description

template<typename, typename>
class blaze::TSMatTSMatAddExpr< typename, typename >

Expression object for transpose sparse matrix-transpose sparse matrix additions.

The TSMatTSMatAddExpr class represents the compile time expression for additions between two column-major sparse matrices.

Member Enumeration Documentation

template<typename , typename >
anonymous enum
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

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

Constructor for the TSMatTSMatAddExpr class.

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

Member Function Documentation

template<typename , typename >
template<typename T >
bool blaze::TSMatTSMatAddExpr< typename, typename >::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 , typename >
size_t blaze::TSMatTSMatAddExpr< typename, typename >::columns ( ) const
inline

Returns the current number of columns of the matrix.

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

Returns the left-hand side transpose sparse matrix operand.

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

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.
const MatrixType& blaze::Matrix< typename, bool >::operator~ ( ) const
inlineinherited

Conversion operator for constant matrices.

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

Returns the right-hand side transpose sparse matrix operand.

Returns
The right-hand side transpose sparse matrix operand.
template<typename , typename >
size_t blaze::TSMatTSMatAddExpr< typename, typename >::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: