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

Expression object for the sparse matrix abs() function.The SMatAbsExpr class represents the compile time expression for the calculation of the absolute value of each element of a sparse matrix via the abs() function. More...

#include <SMatAbsExpr.h>

Inherits blaze::SparseMatrix< SMatAbsExpr< MT, SO >, SO >, blaze::MatAbsExpr, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse matrix absolute value expression. More...
 

Public Types

typedef SMatAbsExpr< MT, SO > This
 Type of this SMatAbsExpr 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 const SelectType
< returnExpr, ExprReturnType,
ElementType >::Type 
ReturnType
 Return type for expression template evaluations.
 
typedef SelectType< useAssign,
const ResultType, const
SMatAbsExpr & >::Type 
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

 SMatAbsExpr (const MT &sm)
 Constructor for the SMatAbsExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row i. 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...
 
Operand operand () const
 Returns the 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<RN>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  { useAssign = RequiresEvaluation<MT>::value }
 Compilation switch for the evaluation strategy of the absolute value expression. More...
 
typedef MT::ResultType RT
 Result type of the sparse matrix expression.
 
typedef MT::ReturnType RN
 Return type of the sparse matrix expression.
 
typedef MT::CompositeType CT
 Composite type of the sparse matrix expression.
 
typedef AbsExprTrait< RN >::Type ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

Operand sm_
 Sparse matrix of the absolute value expression.
 

Detailed Description

template<typename, bool>
class blaze::SMatAbsExpr< typename, bool >

Expression object for the sparse matrix abs() function.

The SMatAbsExpr class represents the compile time expression for the calculation of the absolute value of each element of a sparse matrix via the abs() function.

Member Enumeration Documentation

template<typename , bool >
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 the 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.

template<typename , bool >
anonymous enum
private

Compilation switch for the evaluation strategy of the absolute value expression.

The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the absolute value expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the absolute value expression will be evaluated via the assign function family. Otherwise useAssign will be set to 0 and the expression will be evaluated via the subscript operator.

Constructor & Destructor Documentation

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

Constructor for the SMatAbsExpr class.

Parameters
smThe sparse matrix operand of the absolute value expression.

Member Function Documentation

template<typename , bool >
ConstIterator blaze::SMatAbsExpr< typename, bool >::begin ( size_t  i) const
inline

Returns an iterator to the first non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator to the first non-zero element of row i.
template<typename , bool >
template<typename T >
bool blaze::SMatAbsExpr< typename, bool >::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 , bool >
size_t blaze::SMatAbsExpr< typename, bool >::columns ( ) const
inline

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.
template<typename , bool >
ConstIterator blaze::SMatAbsExpr< typename, bool >::end ( size_t  i) const
inline

Returns an iterator just past the last non-zero element of row i.

Parameters
iThe row index.
Returns
Iterator just past the last non-zero element of row i.
template<typename , bool >
template<typename T >
bool blaze::SMatAbsExpr< typename, bool >::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 , bool >
size_t blaze::SMatAbsExpr< typename, bool >::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 , bool >
size_t blaze::SMatAbsExpr< typename, bool >::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 , bool >
Operand blaze::SMatAbsExpr< typename, bool >::operand ( ) const
inline

Returns the sparse matrix operand.

Returns
The sparse matrix operand.
template<typename , bool >
ReturnType blaze::SMatAbsExpr< typename, bool >::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 , bool >
size_t blaze::SMatAbsExpr< typename, bool >::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: