All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Attributes | List of all members
blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator Class Reference

Iterator over the elements of the sparse matrix/scalar multiplication expression. More...

#include <SMatScalarMultExpr.h>

Public Types

typedef ValueIndexPair
< ElementType
Element
 Element type of the sparse matrix expression.
 
typedef RemoveReference
< LeftOperand >
::Type::ConstIterator 
IteratorType
 Iterator type of the sparse matrix expression.
 
typedef std::forward_iterator_tag IteratorCategory
 The iterator category.
 
typedef Element ValueType
 Type of the underlying pointers.
 
typedef ValueTypePointerType
 Pointer return type.
 
typedef ValueTypeReferenceType
 Reference return type.
 
typedef ptrdiff_t DifferenceType
 Difference between two iterators.
 
typedef IteratorCategory iterator_category
 The iterator category.
 
typedef ValueType value_type
 Type of the underlying pointers.
 
typedef PointerType pointer
 Pointer return type.
 
typedef ReferenceType reference
 Reference return type.
 
typedef DifferenceType difference_type
 Difference between two iterators.
 

Public Member Functions

 ConstIterator (IteratorType matrix, RightOperand scalar)
 Constructor for the ConstIterator class.
 
ConstIteratoroperator++ ()
 Pre-increment operator. More...
 
const Element operator* () const
 Direct access to the sparse matrix element at the current iterator position. More...
 
const ConstIteratoroperator-> () const
 Direct access to the sparse matrix element at the current iterator position. More...
 
ReturnType value () const
 Access to the current value of the sparse element. More...
 
size_t index () const
 Access to the current index of the sparse element. More...
 
bool operator== (const ConstIterator &rhs) const
 Equality comparison between two ConstIterator objects. More...
 
bool operator!= (const ConstIterator &rhs) const
 Inequality comparison between two ConstIterator objects. More...
 
DifferenceType operator- (const ConstIterator &rhs) const
 Calculating the number of elements between two expression iterators. More...
 

Private Attributes

IteratorType matrix_
 Iterator over the elements of the left-hand side sparse matrix expression.
 
RightOperand scalar_
 Right-hand side scalar of the multiplication expression.
 

Detailed Description

template<typename, typename, bool>
class blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator

Iterator over the elements of the sparse matrix/scalar multiplication expression.

Member Function Documentation

template<typename , typename , bool >
size_t blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::index ( ) const
inline

Access to the current index of the sparse element.

Returns
The current index of the sparse element.
template<typename , typename , bool >
bool blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::operator!= ( const ConstIterator rhs) const
inline

Inequality comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side expression iterator.
Returns
true if the iterators don't refer to the same element, false if they do.
template<typename , typename , bool >
const Element blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::operator* ( ) const
inline

Direct access to the sparse matrix element at the current iterator position.

Returns
The element at the current iterator position.
template<typename , typename , bool >
ConstIterator& blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::operator++ ( )
inline

Pre-increment operator.

Returns
Reference to the incremented expression iterator.
template<typename , typename , bool >
DifferenceType blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::operator- ( const ConstIterator rhs) const
inline

Calculating the number of elements between two expression iterators.

Parameters
rhsThe right-hand side expression iterator.
Returns
The number of elements between the two expression iterators.
template<typename , typename , bool >
const ConstIterator* blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::operator-> ( ) const
inline

Direct access to the sparse matrix element at the current iterator position.

Returns
Reference to the sparse matrix element at the current iterator position.
template<typename , typename , bool >
bool blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::operator== ( const ConstIterator rhs) const
inline

Equality comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side expression iterator.
Returns
true if the iterators refer to the same element, false if not.
template<typename , typename , bool >
ReturnType blaze::SMatScalarMultExpr< typename, typename, bool >::ConstIterator::value ( ) const
inline

Access to the current value of the sparse element.

Returns
The current value of the sparse element.

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