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::DVecScalarMultExpr< VT, ST, TF > Class Template Reference

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

#include <DVecScalarMultExpr.h>

Inherits blaze::DenseVector< DVecScalarMultExpr< VT, ST, TF >, TF >, blaze::VecScalarMultExpr, and blaze::Computation.

Classes

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

Public Types

enum  { vectorizable }
 Compilation switch for the expression template evaluation strategy.
 
enum  { smpAssignable = VT::smpAssignable }
 Compilation switch for the expression template assignment strategy.
 
typedef DVecScalarMultExpr< VT,
ST, TF > 
This
 Type of this DVecScalarMultExpr instance.
 
typedef MultTrait< RT, ST >::Type ResultType
 Result type 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
DVecScalarMultExpr & >::Type 
CompositeType
 Data type for composite expression templates.
 
typedef SelectType
< IsExpression< VT >::value,
const VT, const VT & >::Type 
LeftOperand
 Composite type of the left-hand side dense vector expression.
 
typedef ST RightOperand
 Composite type of the right-hand side scalar value.
 
typedef VT VectorType
 Type of the vector.
 

Public Member Functions

 DVecScalarMultExpr (const VT &vector, ST scalar)
 Constructor for the DVecScalarMultExpr class. More...
 
ReturnType operator[] (size_t index) const
 Subscript operator for the direct access to the vector elements. More...
 
IntrinsicType load (size_t index) const
 Access to the intrinsic elements of the vector. More...
 
ConstIterator begin () const
 Returns an iterator to the first non-zero element of the dense vector. More...
 
ConstIterator end () const
 Returns an iterator just past the last non-zero element of the dense vector. More...
 
size_t size () const
 Returns the current size/dimension of the vector. More...
 
LeftOperand leftOperand () const
 Returns the left-hand side dense vector operand. More...
 
RightOperand rightOperand () const
 Returns the right-hand side scalar 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...
 
VectorTypeoperator~ ()
 Conversion operator for non-constant vectors. More...
 
const VectorTypeoperator~ () const
 Conversion operator for constant vectors. More...
 

Private Types

enum  { returnExpr = !IsTemporary<RN>::value }
 Compilation switch for the selection of the subscript operator return type. More...
 
enum  { useAssign = IsComputation<VT>::value && RequiresEvaluation<VT>::value }
 Compilation switch for the serial evaluation strategy of the multiplication expression. More...
 
typedef VT::ResultType RT
 Result type of the dense vector expression.
 
typedef VT::ReturnType RN
 Return type of the dense vector expression.
 
typedef VT::ElementType ET
 Element type of the dense vector expression.
 
typedef VT::CompositeType CT
 Composite type of the dense vector expression.
 
typedef MultExprTrait< RN, ST >
::Type 
ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

LeftOperand vector_
 Left-hand side dense vector of the multiplication expression.
 
RightOperand scalar_
 Right-hand side scalar of the multiplication expression.
 

Detailed Description

template<typename VT, typename ST, bool TF>
class blaze::DVecScalarMultExpr< VT, ST, TF >

Expression object for dense vector-scalar multiplications.

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

Member Enumeration Documentation

template<typename VT, typename ST, bool TF>
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 VT, typename ST, bool TF>
anonymous enum
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 vector expression of type VT 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 VT, typename ST, bool TF>
blaze::DVecScalarMultExpr< VT, ST, TF >::DVecScalarMultExpr ( const VT &  vector,
ST  scalar 
)
inlineexplicit

Constructor for the DVecScalarMultExpr class.

Parameters
vectorThe left-hand side dense vector of the multiplication expression.
scalarThe right-hand side scalar of the multiplication expression.

Member Function Documentation

template<typename VT, typename ST, bool TF>
ConstIterator blaze::DVecScalarMultExpr< VT, ST, TF >::begin ( ) const
inline

Returns an iterator to the first non-zero element of the dense vector.

Returns
Iterator to the first non-zero element of the dense vector.
template<typename VT, typename ST, bool TF>
template<typename T >
bool blaze::DVecScalarMultExpr< VT, ST, TF >::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 VT, typename ST, bool TF>
bool blaze::DVecScalarMultExpr< VT, ST, TF >::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 VT, typename ST, bool TF>
ConstIterator blaze::DVecScalarMultExpr< VT, ST, TF >::end ( ) const
inline

Returns an iterator just past the last non-zero element of the dense vector.

Returns
Iterator just past the last non-zero element of the dense vector.
template<typename VT, typename ST, bool TF>
template<typename T >
bool blaze::DVecScalarMultExpr< VT, ST, TF >::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 VT, typename ST, bool TF>
bool blaze::DVecScalarMultExpr< VT, ST, TF >::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 VT, typename ST, bool TF>
LeftOperand blaze::DVecScalarMultExpr< VT, ST, TF >::leftOperand ( ) const
inline

Returns the left-hand side dense vector operand.

Returns
The left-hand side dense vector operand.
template<typename VT, typename ST, bool TF>
IntrinsicType blaze::DVecScalarMultExpr< VT, ST, TF >::load ( size_t  index) const
inline

Access to the intrinsic elements of the vector.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
Reference to the accessed values.
template<typename VT, typename ST, bool TF>
ReturnType blaze::DVecScalarMultExpr< VT, ST, TF >::operator[] ( size_t  index) const
inline

Subscript operator for the direct access to the vector elements.

Parameters
indexAccess index. The index has to be in the range $[0..N-1]$.
Returns
The resulting value.
template<typename , bool >
VectorType& blaze::Vector< typename, bool >::operator~ ( )
inlineinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.
template<typename , bool >
const VectorType& blaze::Vector< typename, bool >::operator~ ( ) const
inlineinherited

Conversion operator for constant vectors.

Returns
Const reference of the actual type of the vector.
template<typename VT, typename ST, bool TF>
RightOperand blaze::DVecScalarMultExpr< VT, ST, TF >::rightOperand ( ) const
inline

Returns the right-hand side scalar operand.

Returns
The right-hand side scalar operand.
template<typename VT, typename ST, bool TF>
size_t blaze::DVecScalarMultExpr< VT, ST, TF >::size ( ) const
inline

Returns the current size/dimension of the vector.

Returns
The size of the vector.

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