Classes | Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::SMatRealExpr< MT, SO > Class Template Reference

Expression object for the sparse matrix real() function.The SMatRealExpr class represents the compile time expression for the calculation of the real part of each element of a sparse matrix via the real() function. More...

#include <SMatRealExpr.h>

Inherits blaze::SparseMatrix< SMatRealExpr< MT, SO >, SO >, blaze::MatRealExpr, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse matrix real part expression. More...
 

Public Types

enum  { smpAssignable = MT::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
typedef SMatRealExpr< MT, SO > This
 Type of this SMatRealExpr instance.
 
typedef RealTrait< RT >::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 SelectType< useAssign, const ResultType, const SMatRealExpr & >::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 SMatRealExpr< MT, SO > MatrixType
 Type of the matrix.
 

Public Member Functions

 SMatRealExpr (const MT &sm)
 Constructor for the SMatRealExpr 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...
 
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...
 
ConstIterator find (size_t i, size_t j) const
 Searches for a specific matrix element. More...
 
ConstIterator lowerBound (size_t i, size_t j) const
 Returns an iterator to the first index not less then the given index. More...
 
ConstIterator upperBound (size_t i, size_t j) const
 Returns an iterator to the first index greater then the given index. 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...
 
bool canSMPAssign () const
 Returns whether the expression can be used in SMP assignments. 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<RN>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  { useAssign = RequiresEvaluation<MT>::value }
 Compilation switch for the serial evaluation strategy of the real part 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 RealExprTrait< RN >::Type ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

Operand sm_
 Sparse matrix of the real part expression.
 

Detailed Description

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

Expression object for the sparse matrix real() function.

The SMatRealExpr class represents the compile time expression for the calculation of the real part of each element of a sparse matrix via the real() function.

Member Enumeration Documentation

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

template<typename MT , bool SO>
anonymous enum
private

Compilation switch for the serial evaluation strategy of the real part expression.

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the real part expression. In case the given sparse matrix expression of type MT requires an intermediate evaluation, useAssign will be set to 1 and the real part 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 MT , bool SO>
blaze::SMatRealExpr< MT, SO >::SMatRealExpr ( const MT &  sm)
inlineexplicit

Constructor for the SMatRealExpr class.

Parameters
smThe sparse matrix operand of the real part expression.

Member Function Documentation

template<typename MT , bool SO>
ReturnType blaze::SMatRealExpr< MT, SO >::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.
template<typename MT , bool SO>
ConstIterator blaze::SMatRealExpr< MT, SO >::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 MT , bool SO>
template<typename T >
bool blaze::SMatRealExpr< MT, SO >::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 MT , bool SO>
bool blaze::SMatRealExpr< MT, SO >::canSMPAssign ( ) const
inline

Returns whether the expression can be used in SMP assignments.

Returns
true in case the expression can be used in SMP assignments, false if not.
template<typename MT , bool SO>
size_t blaze::SMatRealExpr< 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>
ConstIterator blaze::SMatRealExpr< MT, SO >::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 MT , bool SO>
ConstIterator blaze::SMatRealExpr< MT, SO >::find ( size_t  i,
size_t  j 
) const
inline

Searches for a specific matrix element.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the element in case the index is found, end() iterator otherwise.
template<typename MT , bool SO>
template<typename T >
bool blaze::SMatRealExpr< 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>
ConstIterator blaze::SMatRealExpr< MT, SO >::lowerBound ( size_t  i,
size_t  j 
) const
inline

Returns an iterator to the first index not less then the given index.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the first index not less then the given index, end() iterator otherwise.
template<typename MT , bool SO>
size_t blaze::SMatRealExpr< 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::SMatRealExpr< 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::SMatRealExpr< MT, SO >::operand ( ) const
inline

Returns the sparse matrix operand.

Returns
The sparse matrix operand.
template<typename MT , bool SO>
ReturnType blaze::SMatRealExpr< 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.
BLAZE_ALWAYS_INLINE MatrixType& blaze::Matrix< SMatRealExpr< MT, SO > , 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< SMatRealExpr< MT, SO > , 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::SMatRealExpr< MT, SO >::rows ( ) const
inline

Returns the current number of rows of the matrix.

Returns
The number of rows of the matrix.
template<typename MT , bool SO>
ConstIterator blaze::SMatRealExpr< MT, SO >::upperBound ( size_t  i,
size_t  j 
) const
inline

Returns an iterator to the first index greater then the given index.

Parameters
iThe row index of the search element.
jThe column index of the search element.
Returns
Iterator to the first index greater then the given index, end() iterator otherwise.

The documentation for this class was generated from the following files: