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

Expression object for dense matrix transpositions.The DMatTransExpr class represents the compile time expression for transpositions of dense matrices. More...

#include <DMatTransExpr.h>

Inherits blaze::DenseMatrix< DMatTransExpr< MT, SO >, SO >, blaze::MatTransExpr, and Type< IsComputation< MT >::value, Computation, EmptyType >.

Classes

class  ConstIterator
 Iterator over the elements of the dense matrix. More...
 

Public Types

enum  { vectorizable = MT::vectorizable }
 Compilation switch for the expression template evaluation strategy.
 
enum  { smpAssignable = MT::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
typedef DMatTransExpr< MT, SO > This
 Type of this DMatTransExpr instance.
 
typedef MT::TransposeType ResultType
 Result type for expression template evaluations.
 
typedef ResultType::OppositeType OppositeType
 Result type with opposite storage order for expression template evaluations.
 
typedef MT::ResultType TransposeType
 Transpose type for expression template evaluations.
 
typedef MT::ElementType ElementType
 Resulting element type.
 
typedef IntrinsicTrait< ElementType >::Type IntrinsicType
 Resulting intrinsic element type.
 
typedef MT::ReturnType ReturnType
 Return type for expression template evaluations.
 
typedef SelectType< useAssign, const ResultType, const DMatTransExpr & >::Type CompositeType
 Data type for composite expression templates.
 
typedef SelectType< IsExpression< MT >::value, const MT, const MT & >::Type Operand
 Composite data type of the dense matrix expression.
 
typedef MT MatrixType
 Type of the matrix.
 

Public Member Functions

 DMatTransExpr (const MT &dm)
 Constructor for the DMatTransExpr 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...
 
BLAZE_ALWAYS_INLINE IntrinsicType load (size_t i, size_t j) const
 Access to the intrinsic elements of the matrix. More...
 
const ElementTypedata () const
 Low-level data access to the matrix elements. More...
 
ConstIterator begin (size_t i) const
 Returns an iterator to the first non-zero element of row/column i. More...
 
ConstIterator end (size_t i) const
 Returns an iterator just past the last non-zero element of row/column 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 spacing () const
 Returns the spacing between the beginning of two rows/columns. More...
 
size_t nonZeros () const
 Returns the number of non-zero elements in the dense matrix. More...
 
size_t nonZeros (size_t i) const
 Returns the number of non-zero elements in the specified row/column. More...
 
Operand operand () const
 Returns the dense 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 isAligned () const
 Returns whether the operands of the expression are properly aligned in memory. 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  { useAssign = RequiresEvaluation<MT>::value }
 Compilation switch for the serial evaluation strategy of the transposition expression. More...
 
typedef MT::ResultType RT
 Result type of the dense matrix expression.
 
typedef MT::CompositeType CT
 Composite type of the dense matrix expression.
 

Private Attributes

Operand dm_
 Dense matrix of the transposition expression.
 

Detailed Description

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

Expression object for dense matrix transpositions.

The DMatTransExpr class represents the compile time expression for transpositions of dense matrices.

Member Enumeration Documentation

template<typename MT , bool SO>
anonymous enum
private

Compilation switch for the serial evaluation strategy of the transposition expression.

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

Constructor for the DMatTransExpr class.

Parameters
dmThe dense matrix operand of the transposition expression.

Member Function Documentation

template<typename MT , bool SO>
ReturnType blaze::DMatTransExpr< 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::DMatTransExpr< MT, SO >::begin ( size_t  i) const
inline

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

Parameters
iThe row/column index.
Returns
Iterator to the first non-zero element of row/column i.
template<typename MT , bool SO>
template<typename T >
bool blaze::DMatTransExpr< 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::DMatTransExpr< 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::DMatTransExpr< 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>
const ElementType* blaze::DMatTransExpr< MT, SO >::data ( ) const
inline

Low-level data access to the matrix elements.

Returns
Pointer to the internal element storage.
template<typename MT , bool SO>
ConstIterator blaze::DMatTransExpr< MT, SO >::end ( size_t  i) const
inline

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

Parameters
iThe row/column index.
Returns
Iterator just past the last non-zero element of row/column i.
template<typename MT , bool SO>
template<typename T >
bool blaze::DMatTransExpr< 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>
bool blaze::DMatTransExpr< MT, SO >::isAligned ( ) const
inline

Returns whether the operands of the expression are properly aligned in memory.

Returns
true in case the operands are aligned, false if not.
template<typename MT , bool SO>
BLAZE_ALWAYS_INLINE IntrinsicType blaze::DMatTransExpr< MT, SO >::load ( size_t  i,
size_t  j 
) const
inline

Access to the intrinsic elements of the matrix.

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
Reference to the accessed values.
template<typename MT , bool SO>
size_t blaze::DMatTransExpr< MT, SO >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the dense matrix.

Returns
The number of non-zero elements in the dense matrix.
template<typename MT , bool SO>
size_t blaze::DMatTransExpr< MT, SO >::nonZeros ( size_t  i) const
inline

Returns the number of non-zero elements in the specified row/column.

Parameters
iThe index of the row/column.
Returns
The number of non-zero elements of row/column i.
template<typename MT , bool SO>
Operand blaze::DMatTransExpr< MT, SO >::operand ( ) const
inline

Returns the dense matrix operand.

Returns
The dense matrix operand.
template<typename MT , bool SO>
ReturnType blaze::DMatTransExpr< 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>
BLAZE_ALWAYS_INLINE 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>
BLAZE_ALWAYS_INLINE 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::DMatTransExpr< 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>
size_t blaze::DMatTransExpr< MT, SO >::spacing ( ) const
inline

Returns the spacing between the beginning of two rows/columns.

Returns
The spacing between the beginning of two rows/columns.

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