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

Expression object for the forced evaluation of sparse matrices.The SMatEvalExpr class represents the compile time expression for the forced evaluation of a sparse matrix. More...

#include <SMatEvalExpr.h>

Inherits blaze::SparseMatrix< SMatEvalExpr< MT, SO >, SO >, blaze::Expression, and blaze::Computation.

Public Types

enum  { canAlias = ( !IsComputation<MT>::value || CanAlias<MT>::value ) && !RequiresEvaluation<MT>::value }
 Compilation flag for the detection of aliasing effects.
 
typedef SMatEvalExpr< MT, SO > This
 Type of this SMatEvalExpr instance.
 
typedef MT::ResultType ResultType
 Result type for expression template evaluations.
 
typedef MT::OppositeType OppositeType
 Result type with opposite storage order for expression template evaluations.
 
typedef MT::TransposeType TransposeType
 Transpose type for expression template evaluations.
 
typedef MT::ElementType ElementType
 Resulting element type.
 
typedef MT::ReturnType ReturnType
 Return type for expression template evaluations.
 
typedef const ResultType CompositeType
 Data type for composite expression templates.
 
typedef SelectType
< IsExpression< MT >::value,
const MT, const MT & >::Type 
Operand
 Composite data type of the sparse matrix expression.
 
typedef MT MatrixType
 Type of the matrix.
 

Public Member Functions

 SMatEvalExpr (const MT &sm)
 Constructor for the SMatEvalExpr class.
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements.
 
size_t rows () const
 Returns the current number of rows of the matrix.
 
size_t columns () const
 Returns the current number of columns of the matrix.
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse matrix.
 
size_t nonZeros (size_t i) const
 Returns the number of non-zero elements in the specified row.
 
Operand operand () const
 Returns the sparse matrix operand.
 
template<typename T >
bool isAliased (const T *alias) const
 Returns whether the expression is aliased with the given address alias.
 
MatrixTypeoperator~ ()
 Conversion operator for non-constant matrices.
 
const MatrixTypeoperator~ () const
 Conversion operator for constant matrices.
 

Private Attributes

Operand sm_
 Sparse matrix of the evaluation expression.
 

Detailed Description

template<typename MT, bool SO>
class blaze::SMatEvalExpr< MT, SO >

Expression object for the forced evaluation of sparse matrices.

The SMatEvalExpr class represents the compile time expression for the forced evaluation of a sparse matrix.

Constructor & Destructor Documentation

template<typename MT , bool SO>
blaze::SMatEvalExpr< MT, SO >::SMatEvalExpr ( const MT &  sm)
inlineexplicit

Constructor for the SMatEvalExpr class.

Parameters
smThe sparse matrix operand of the evaluation expression.

Member Function Documentation

template<typename MT , bool SO>
size_t blaze::SMatEvalExpr< MT, SO >::columns ( ) const
inline

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.
template<typename MT , bool SO>
template<typename T >
bool blaze::SMatEvalExpr< MT, SO >::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 MT , bool SO>
size_t blaze::SMatEvalExpr< MT, SO >::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 MT , bool SO>
size_t blaze::SMatEvalExpr< MT, SO >::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 MT , bool SO>
Operand blaze::SMatEvalExpr< MT, SO >::operand ( ) const
inline

Returns the sparse matrix operand.

Returns
The sparse matrix operand.
template<typename MT , bool SO>
ReturnType blaze::SMatEvalExpr< MT, SO >::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.
template<typename MT, bool SO>
MatrixType& blaze::Matrix< MT, SO >::operator~ ( )
inlineinherited

Conversion operator for non-constant matrices.

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

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.
template<typename MT , bool SO>
size_t blaze::SMatEvalExpr< MT, SO >::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 file: