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::DMatDMatSubExpr< MT1, MT2, SO > Class Template Reference

Expression object for dense matrix-dense matrix subtractions.The DMatDMatSubExpr class represents the compile time expression for subtractions between dense matrices with identical storage order. More...

#include <DMatDMatSubExpr.h>

Inherits blaze::DenseMatrix< DMatDMatSubExpr< MT1, MT2, SO >, SO >, blaze::MatMatSubExpr, and blaze::Computation.

Public Types

enum  { vectorizable }
 Compilation switch for the expression template evaluation strategy.
 
typedef DMatDMatSubExpr< MT1,
MT2, SO > 
This
 Type of this DMatDMatSubExpr instance.
 
typedef SubTrait< 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 IntrinsicTrait
< ElementType >::Type 
IntrinsicType
 Resulting intrinsic element type.
 
typedef const SelectType
< returnExpr, ExprReturnType,
ElementType >::Type 
ReturnType
 Return type for expression template evaluations.
 
typedef SelectType< useAssign,
const ResultType, const
DMatDMatSubExpr & >::Type 
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 dense matrix expression.
 
typedef SelectType
< IsExpression< MT2 >::value,
const MT2, const MT2 & >::Type 
RightOperand
 Composite type of the right-hand side dense matrix expression.
 
typedef MT MatrixType
 Type of the matrix.
 

Public Member Functions

 DMatDMatSubExpr (const MT1 &lhs, const MT2 &rhs)
 Constructor for the DMatDMatSubExpr class. More...
 
ReturnType operator() (size_t i, size_t j) const
 2D-access to the matrix elements. More...
 
IntrinsicType get (size_t i, size_t j) const
 Access to the intrinsic elements of the matrix. 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...
 
LeftOperand leftOperand () const
 Returns the left-hand side dense matrix operand. More...
 
RightOperand rightOperand () const
 Returns the right-hand side 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...
 
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...
 
enum  { useAssign = RequiresEvaluation<MT1>::value || RequiresEvaluation<MT2>::value || !returnExpr }
 Compilation switch for the evaluation strategy of the subtraction expression. More...
 
typedef MT1::ResultType RT1
 Result type of the left-hand side dense matrix expression.
 
typedef MT2::ResultType RT2
 Result type of the right-hand side dense matrix expression.
 
typedef MT1::ReturnType RN1
 Return type of the left-hand side dense matrix expression.
 
typedef MT2::ReturnType RN2
 Return type of the right-hand side dense matrix expression.
 
typedef MT1::CompositeType CT1
 Composite type of the left-hand side dense matrix expression.
 
typedef MT2::CompositeType CT2
 Composite type of the right-hand side dense matrix expression.
 
typedef MT1::ElementType ET1
 Element type of the left-hand side dense matrix expression.
 
typedef MT2::ElementType ET2
 Element type of the right-hand side dense matrix expression.
 
typedef SubExprTrait< RN1, RN2 >
::Type 
ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand lhs_
 Left-hand side dense matrix of the subtraction expression.
 
RightOperand rhs_
 Right-hand side dense matrix of the subtraction expression.
 

Detailed Description

template<typename MT1, typename MT2, bool SO>
class blaze::DMatDMatSubExpr< MT1, MT2, SO >

Expression object for dense matrix-dense matrix subtractions.

The DMatDMatSubExpr class represents the compile time expression for subtractions between dense matrices with identical storage order.

Member Enumeration Documentation

template<typename MT1, typename MT2, 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 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.

template<typename MT1, typename MT2, bool SO>
anonymous enum
private

Compilation switch for the evaluation strategy of the subtraction expression.

The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the subtraction expression. In case either of the two dense matrix operands requires an intermediate evaluation or the subscript operator can only return by value, useAssign will be set to true and the subtraction expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the function call operator.

Constructor & Destructor Documentation

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

Constructor for the DMatDMatSubExpr class.

Parameters
lhsThe left-hand side operand of the subtraction expression.
rhsThe right-hand side operand of the subtraction expression.

Member Function Documentation

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

Returns the current number of columns of the matrix.

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

Returns the left-hand side dense matrix operand.

Returns
The left-hand side dense matrix operand.
template<typename MT1, typename MT2, bool SO>
ReturnType blaze::DMatDMatSubExpr< MT1, MT2, 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 , bool >
MatrixType& blaze::Matrix< typename, bool >::operator~ ( )
inlineinherited

Conversion operator for non-constant matrices.

Returns
Reference of the actual type of the matrix.
template<typename , bool >
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 MT1, typename MT2, bool SO>
RightOperand blaze::DMatDMatSubExpr< MT1, MT2, SO >::rightOperand ( ) const
inline

Returns the right-hand side dense matrix operand.

Returns
The right-hand side dense matrix operand.
template<typename MT1, typename MT2, bool SO>
size_t blaze::DMatDMatSubExpr< MT1, MT2, 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: