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

Expression object for dense matrix-scalar multiplications.The DMatScalarMultExpr class represents the compile time expression for multiplications between a dense matrix and a scalar value. More...

#include <DMatScalarMultExpr.h>

Inherits blaze::DenseMatrix< DMatScalarMultExpr< MT, ST, SO >, SO >, blaze::MatScalarMultExpr, and blaze::Computation.

Classes

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

Public Types

enum  : bool { simdEnabled }
 Compilation switch for the expression template evaluation strategy.
 
enum  : bool { smpAssignable = MT::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
enum  : size_t { SIMDSIZE = SIMDTrait<ElementType>::size }
 The number of elements packed within a single SIMD element.
 
typedef DMatScalarMultExpr< MT, ST, SO > This
 Type of this DMatScalarMultExpr instance.
 
typedef MultTrait_< RT, ST > ResultType
 Result type for expression template evaluations.
 
typedef OppositeType_< ResultTypeOppositeType
 Result type with opposite storage order for expression template evaluations.
 
typedef TransposeType_< ResultTypeTransposeType
 Transpose type for expression template evaluations.
 
typedef ElementType_< ResultTypeElementType
 Resulting element type.
 
typedef const IfTrue_< returnExpr, ExprReturnType, ElementTypeReturnType
 Return type for expression template evaluations.
 
typedef IfTrue_< useAssign, const ResultType, const DMatScalarMultExpr & > CompositeType
 Data type for composite expression templates.
 
typedef If_< IsExpression< MT >, const MT, const MT & > LeftOperand
 Composite type of the left-hand side dense matrix expression.
 
typedef ST RightOperand
 Composite type of the right-hand side scalar value.
 
typedef MT MatrixType
 Type of the matrix.
 

Public Member Functions

 DMatScalarMultExpr (const MT &matrix, ST scalar) noexcept
 Constructor for the DMatScalarMultExpr 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 auto load (size_t i, size_t j) const noexcept
 Access to the SIMD elements of the matrix. 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 noexcept
 Returns the current number of rows of the matrix. More...
 
size_t columns () const noexcept
 Returns the current number of columns of the matrix. More...
 
LeftOperand leftOperand () const noexcept
 Returns the left-hand side dense matrix operand. More...
 
RightOperand rightOperand () const noexcept
 Returns the right-hand side scalar operand. More...
 
template<typename T >
bool canAlias (const T *alias) const noexcept
 Returns whether the expression can alias with the given address alias. More...
 
template<typename T >
bool isAliased (const T *alias) const noexcept
 Returns whether the expression is aliased with the given address alias. More...
 
bool isAligned () const noexcept
 Returns whether the operands of the expression are properly aligned in memory. More...
 
bool canSMPAssign () const noexcept
 Returns whether the expression can be used in SMP assignments. More...
 
BLAZE_ALWAYS_INLINE MatrixTypeoperator~ () noexcept
 Conversion operator for non-constant matrices. More...
 
BLAZE_ALWAYS_INLINE const MatrixTypeoperator~ () const noexcept
 Conversion operator for constant matrices. More...
 

Private Types

enum  : bool { returnExpr = !IsTemporary<RN>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  : bool { useAssign = IsComputation<MT>::value && RequiresEvaluation<MT>::value }
 Compilation switch for the serial evaluation strategy of the multiplication expression. More...
 
typedef ResultType_< MT > RT
 Result type of the dense matrix expression.
 
typedef ReturnType_< MT > RN
 Return type of the dense matrix expression.
 
typedef ElementType_< MT > ET
 Element type of the dense matrix expression.
 
typedef CompositeType_< MT > CT
 Composite type of the dense matrix expression.
 
typedef MultExprTrait_< RN, ST > ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand matrix_
 Left-hand side dense matrix of the multiplication expression.
 
RightOperand scalar_
 Right-hand side scalar of the multiplication expression.
 

Detailed Description

template<typename MT, typename ST, bool SO>
class blaze::DMatScalarMultExpr< MT, ST, SO >

Expression object for dense matrix-scalar multiplications.

The DMatScalarMultExpr class represents the compile time expression for multiplications between a dense matrix and a scalar value.

Member Enumeration Documentation

template<typename MT, typename ST, bool SO>
anonymous enum : bool
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, typename ST, bool SO>
anonymous enum : bool
private

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

The useAssign compile time constant expression represents a compilation switch for the serial evaluation strategy of the multiplication expression. In case the given dense matrix expression of type MT is a computation expression and requires an intermediate evaluation, useAssign will be set to 1 and the multiplication 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, typename ST, bool SO>
blaze::DMatScalarMultExpr< MT, ST, SO >::DMatScalarMultExpr ( const MT &  matrix,
ST  scalar 
)
inlineexplicitnoexcept

Constructor for the DMatScalarMultExpr class.

Parameters
matrixThe left-hand side dense matrix of the multiplication expression.
scalarThe right-hand side scalar of the multiplication expression.

Member Function Documentation

template<typename MT, typename ST, bool SO>
ReturnType blaze::DMatScalarMultExpr< MT, ST, 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, typename ST, bool SO>
ConstIterator blaze::DMatScalarMultExpr< MT, ST, 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, typename ST, bool SO>
template<typename T >
bool blaze::DMatScalarMultExpr< MT, ST, SO >::canAlias ( const T *  alias) const
inlinenoexcept

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, typename ST, bool SO>
bool blaze::DMatScalarMultExpr< MT, ST, SO >::canSMPAssign ( ) const
inlinenoexcept

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, typename ST, bool SO>
size_t blaze::DMatScalarMultExpr< MT, ST, SO >::columns ( ) const
inlinenoexcept

Returns the current number of columns of the matrix.

Returns
The number of columns of the matrix.
template<typename MT, typename ST, bool SO>
ConstIterator blaze::DMatScalarMultExpr< MT, ST, 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, typename ST, bool SO>
template<typename T >
bool blaze::DMatScalarMultExpr< MT, ST, SO >::isAliased ( const T *  alias) const
inlinenoexcept

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, typename ST, bool SO>
bool blaze::DMatScalarMultExpr< MT, ST, SO >::isAligned ( ) const
inlinenoexcept

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, typename ST, bool SO>
LeftOperand blaze::DMatScalarMultExpr< MT, ST, SO >::leftOperand ( ) const
inlinenoexcept

Returns the left-hand side dense matrix operand.

Returns
The left-hand side dense matrix operand.
template<typename MT, typename ST, bool SO>
BLAZE_ALWAYS_INLINE auto blaze::DMatScalarMultExpr< MT, ST, SO >::load ( size_t  i,
size_t  j 
) const
inlinenoexcept

Access to the SIMD 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, typename ST, bool SO>
ReturnType blaze::DMatScalarMultExpr< MT, ST, 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~ ( )
inlinenoexceptinherited

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
inlinenoexceptinherited

Conversion operator for constant matrices.

Returns
Constant reference of the actual type of the matrix.
template<typename MT, typename ST, bool SO>
RightOperand blaze::DMatScalarMultExpr< MT, ST, SO >::rightOperand ( ) const
inlinenoexcept

Returns the right-hand side scalar operand.

Returns
The right-hand side scalar operand.
template<typename MT, typename ST, bool SO>
size_t blaze::DMatScalarMultExpr< MT, ST, SO >::rows ( ) const
inlinenoexcept

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: