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::SVecScalarMultExpr< typename, typename, bool > Class Template Reference

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

#include <SVecScalarMultExpr.h>

Inherits blaze::SparseVector< SVecScalarMultExpr< VT, ST, TF >, TF >, blaze::VecScalarMultExpr, and blaze::Computation.

Classes

class  ConstIterator
 Iterator over the elements of the sparse vector/scalar multiplication expression. More...
 

Public Types

enum  { smpAssignable = 0 }
 Compilation switch for the expression template assignment strategy.
 
typedef SVecScalarMultExpr< VT,
ST, TF > 
This
 Type of this SVecScalarMultExpr 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 const SelectType
< returnExpr, ExprReturnType,
ElementType >::Type 
ReturnType
 Return type for expression template evaluations.
 
typedef SelectType< useAssign,
const ResultType, const
SVecScalarMultExpr & >::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 sparse vector expression.
 
typedef ST RightOperand
 Composite type of the right-hand side scalar value.
 
typedef VT VectorType
 Type of the vector.
 

Public Member Functions

 SVecScalarMultExpr (const VT &vector, ST scalar)
 Constructor for the SVecScalarMultExpr class. More...
 
ReturnType operator[] (size_t index) const
 Subscript operator for the direct access to the vector elements. More...
 
ConstIterator begin () const
 Returns an iterator to the first non-zero element of the sparse vector. More...
 
ConstIterator end () const
 Returns an iterator just past the last non-zero element of the sparse vector. More...
 
size_t size () const
 Returns the current size/dimension of the vector. More...
 
size_t nonZeros () const
 Returns the number of non-zero elements in the sparse vector. More...
 
LeftOperand leftOperand () const
 Returns the left-hand side sparse 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...
 
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 = RequiresEvaluation<VT>::value }
 Compilation switch for the evaluation strategy of the multiplication expression. More...
 
typedef VT::ResultType RT
 Result type of the sparse vector expression.
 
typedef VT::ReturnType RN
 Return type of the sparse vector expression.
 
typedef VT::CompositeType CT
 Composite type of the sparse vector expression.
 
typedef MultExprTrait< RN, ST >
::Type 
ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

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

Detailed Description

template<typename, typename, bool>
class blaze::SVecScalarMultExpr< typename, typename, bool >

Expression object for sparse vector-scalar multiplications.

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

Member Enumeration Documentation

template<typename , typename , bool >
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 , typename , bool >
anonymous enum
private

Compilation switch for the evaluation strategy of the multiplication expression.

The useAssign compile time constant expression represents a compilation switch for the evaluation strategy of the multiplication expression. In case the sparse vector operand requires an intermediate evaluation, useAssign will be set to true and the multiplication expression will be evaluated via the assign function family. Otherwise useAssign will be set to false and the expression will be evaluated via the subscript operator.

Constructor & Destructor Documentation

template<typename , typename , bool >
blaze::SVecScalarMultExpr< typename, typename, bool >::SVecScalarMultExpr ( const VT &  vector,
ST  scalar 
)
inlineexplicit

Constructor for the SVecScalarMultExpr class.

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

Member Function Documentation

template<typename , typename , bool >
ConstIterator blaze::SVecScalarMultExpr< typename, typename, bool >::begin ( ) const
inline

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

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

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

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

Returns the left-hand side sparse vector operand.

Returns
The left-hand side sparse vector operand.
template<typename , typename , bool >
size_t blaze::SVecScalarMultExpr< typename, typename, bool >::nonZeros ( ) const
inline

Returns the number of non-zero elements in the sparse vector.

Returns
The number of non-zero elements in the sparse vector.
template<typename , typename , bool >
ReturnType blaze::SVecScalarMultExpr< typename, typename, bool >::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.
VectorType& blaze::Vector< typename, bool >::operator~ ( )
inlineinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.
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 , typename , bool >
RightOperand blaze::SVecScalarMultExpr< typename, typename, bool >::rightOperand ( ) const
inline

Returns the right-hand side scalar operand.

Returns
The right-hand side scalar operand.
template<typename , typename , bool >
size_t blaze::SVecScalarMultExpr< typename, typename, bool >::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 files: