Classes | Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
blaze::SVecScalarDivExpr< VT, ST, TF > Class Template Reference

Expression object for divisions of a sparse vector by a scalar.The SVecScalarDivExpr class represents the compile time expression for divisions of sparse vectors by scalar values. More...

#include <SVecScalarDivExpr.h>

Inherits blaze::SparseVector< SVecScalarDivExpr< VT, ST, TF >, TF >, blaze::VecScalarDivExpr, 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 SVecScalarDivExpr< VT, ST, TF > This
 Type of this SVecScalarDivExpr instance.
 
typedef DivTrait< 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 SVecScalarDivExpr & >::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 SVecScalarDivExpr< VT, ST, TF > VectorType
 Type of the vector.
 

Public Member Functions

 SVecScalarDivExpr (const VT &vector, ST scalar)
 Constructor for the SVecScalarDivExpr 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...
 
ConstIterator find (size_t index) const
 Searches for a specific vector element. More...
 
ConstIterator lowerBound (size_t index) const
 Returns an iterator to the first index not less then the given index. More...
 
ConstIterator upperBound (size_t index) const
 Returns an iterator to the first index greater then the given index. 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...
 
BLAZE_ALWAYS_INLINE VectorTypeoperator~ ()
 Conversion operator for non-constant vectors. More...
 
BLAZE_ALWAYS_INLINE 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 serial 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 DivExprTrait< RN, ST >::Type ExprReturnType
 Expression return type for the subscript operator.
 

Private Attributes

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

Detailed Description

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

Expression object for divisions of a sparse vector by a scalar.

The SVecScalarDivExpr class represents the compile time expression for divisions of sparse vectors by scalar values.

Constructor & Destructor Documentation

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

Constructor for the SVecScalarDivExpr class.

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

Member Function Documentation

template<typename VT , typename ST , bool TF>
ConstIterator blaze::SVecScalarDivExpr< VT, ST, TF >::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 VT , typename ST , bool TF>
template<typename T >
bool blaze::SVecScalarDivExpr< 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>
ConstIterator blaze::SVecScalarDivExpr< VT, ST, TF >::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 VT , typename ST , bool TF>
ConstIterator blaze::SVecScalarDivExpr< VT, ST, TF >::find ( size_t  index) const
inline

Searches for a specific vector element.

Parameters
indexThe index of the search element.
Returns
Iterator to the element in case the index is found, end() iterator otherwise.
template<typename VT , typename ST , bool TF>
template<typename T >
bool blaze::SVecScalarDivExpr< 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>
LeftOperand blaze::SVecScalarDivExpr< VT, ST, TF >::leftOperand ( ) const
inline

Returns the left-hand side sparse vector operand.

Returns
The left-hand side sparse vector operand.
template<typename VT , typename ST , bool TF>
ConstIterator blaze::SVecScalarDivExpr< VT, ST, TF >::lowerBound ( size_t  index) const
inline

Returns an iterator to the first index not less then the given index.

Parameters
indexThe index of the search element.
Returns
Iterator to the first index not less then the given index, end() iterator otherwise.
template<typename VT , typename ST , bool TF>
size_t blaze::SVecScalarDivExpr< VT, ST, TF >::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 VT , typename ST , bool TF>
ReturnType blaze::SVecScalarDivExpr< 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.
BLAZE_ALWAYS_INLINE VectorType& blaze::Vector< SVecScalarDivExpr< VT, ST, TF > , TF >::operator~ ( )
inlineinherited

Conversion operator for non-constant vectors.

Returns
Reference of the actual type of the vector.
BLAZE_ALWAYS_INLINE const VectorType& blaze::Vector< SVecScalarDivExpr< VT, ST, TF > , TF >::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::SVecScalarDivExpr< 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::SVecScalarDivExpr< VT, ST, TF >::size ( ) const
inline

Returns the current size/dimension of the vector.

Returns
The size of the vector.
template<typename VT , typename ST , bool TF>
ConstIterator blaze::SVecScalarDivExpr< VT, ST, TF >::upperBound ( size_t  index) const
inline

Returns an iterator to the first index greater then the given index.

Parameters
indexThe index of the search element.
Returns
Iterator to the first index greater then the given index, end() iterator otherwise.

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