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

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

#include <DVecDVecSubExpr.h>

Public Types

typedef
std::random_access_iterator_tag 
IteratorCategory
 The iterator category.
 
typedef ElementType ValueType
 Type of the underlying elements.
 
typedef ElementTypePointerType
 Pointer return type.
 
typedef ElementTypeReferenceType
 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 elements.
 
typedef PointerType pointer
 Pointer return type.
 
typedef ReferenceType reference
 Reference return type.
 
typedef DifferenceType difference_type
 Difference between two iterators.
 
typedef VT1::ConstIterator LeftIteratorType
 ConstIterator type of the left-hand side dense vector expression.
 
typedef VT2::ConstIterator RightIteratorType
 ConstIterator type of the right-hand side dense vector expression.
 

Public Member Functions

 ConstIterator (LeftIteratorType left, RightIteratorType right)
 Constructor for the ConstIterator class. More...
 
ConstIteratoroperator+= (size_t inc)
 Addition assignment operator. More...
 
ConstIteratoroperator-= (size_t dec)
 Subtraction assignment operator. More...
 
ConstIteratoroperator++ ()
 Pre-increment operator. More...
 
const ConstIterator operator++ (int)
 Post-increment operator. More...
 
ConstIteratoroperator-- ()
 Pre-decrement operator. More...
 
const ConstIterator operator-- (int)
 Post-decrement operator. More...
 
ReturnType operator* () const
 Direct access to the element at the current iterator position. More...
 
IntrinsicType load () const
 Access to the intrinsic elements of the vector. 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...
 
bool operator< (const ConstIterator &rhs) const
 Less-than comparison between two ConstIterator objects. More...
 
bool operator> (const ConstIterator &rhs) const
 Greater-than comparison between two ConstIterator objects. More...
 
bool operator<= (const ConstIterator &rhs) const
 Less-than comparison between two ConstIterator objects. More...
 
bool operator>= (const ConstIterator &rhs) const
 Greater-than comparison between two ConstIterator objects. More...
 
DifferenceType operator- (const ConstIterator &rhs) const
 Calculating the number of elements between two iterators. More...
 

Private Attributes

LeftIteratorType left_
 Iterator to the current left-hand side element.
 
RightIteratorType right_
 Iterator to the current right-hand side element.
 

Friends

const ConstIterator operator+ (const ConstIterator &it, size_t inc)
 Addition between a ConstIterator and an integral value. More...
 
const ConstIterator operator+ (size_t inc, const ConstIterator &it)
 Addition between an integral value and a ConstIterator. More...
 
const ConstIterator operator- (const ConstIterator &it, size_t dec)
 Subtraction between a ConstIterator and an integral value. More...
 

Detailed Description

template<typename VT1, typename VT2, bool TF>
class blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator

Iterator over the elements of the dense vector.

Constructor & Destructor Documentation

template<typename VT1, typename VT2, bool TF>
blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::ConstIterator ( LeftIteratorType  left,
RightIteratorType  right 
)
inlineexplicit

Constructor for the ConstIterator class.

Parameters
leftIterator to the initial left-hand side element.
rightIterator to the initial right-hand side element.

Member Function Documentation

template<typename VT1, typename VT2, bool TF>
IntrinsicType blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::load ( ) const
inline

Access to the intrinsic elements of the vector.

Returns
The resulting intrinsic value.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator!= ( const ConstIterator rhs) const
inline

Inequality comparison between two ConstIterator objects.

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

Direct access to the element at the current iterator position.

Returns
The resulting value.
template<typename VT1, typename VT2, bool TF>
ConstIterator& blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator++ ( )
inline

Pre-increment operator.

Returns
Reference to the incremented iterator.
template<typename VT1, typename VT2, bool TF>
const ConstIterator blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator++ ( int  )
inline

Post-increment operator.

Returns
The previous position of the iterator.
template<typename VT1, typename VT2, bool TF>
ConstIterator& blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator+= ( size_t  inc)
inline

Addition assignment operator.

Parameters
incThe increment of the iterator.
Returns
The incremented iterator.
template<typename VT1, typename VT2, bool TF>
DifferenceType blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator- ( const ConstIterator rhs) const
inline

Calculating the number of elements between two iterators.

Parameters
rhsThe right-hand side iterator.
Returns
The number of elements between the two iterators.
template<typename VT1, typename VT2, bool TF>
ConstIterator& blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator-- ( )
inline

Pre-decrement operator.

Returns
Reference to the decremented iterator.
template<typename VT1, typename VT2, bool TF>
const ConstIterator blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator-- ( int  )
inline

Post-decrement operator.

Returns
The previous position of the iterator.
template<typename VT1, typename VT2, bool TF>
ConstIterator& blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator-= ( size_t  dec)
inline

Subtraction assignment operator.

Parameters
decThe decrement of the iterator.
Returns
The decremented iterator.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator< ( const ConstIterator rhs) const
inline

Less-than comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is smaller, false if not.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator<= ( const ConstIterator rhs) const
inline

Less-than comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is smaller or equal, false if not.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator== ( const ConstIterator rhs) const
inline

Equality comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side iterator.
Returns
true if the iterators refer to the same element, false if not.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator> ( const ConstIterator rhs) const
inline

Greater-than comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is greater, false if not.
template<typename VT1, typename VT2, bool TF>
bool blaze::DVecDVecSubExpr< VT1, VT2, TF >::ConstIterator::operator>= ( const ConstIterator rhs) const
inline

Greater-than comparison between two ConstIterator objects.

Parameters
rhsThe right-hand side iterator.
Returns
true if the left-hand side iterator is greater or equal, false if not.

Friends And Related Function Documentation

template<typename VT1, typename VT2, bool TF>
const ConstIterator operator+ ( const ConstIterator it,
size_t  inc 
)
friend

Addition between a ConstIterator and an integral value.

Parameters
itThe iterator to be incremented.
incThe number of elements the iterator is incremented.
Returns
The incremented iterator.
template<typename VT1, typename VT2, bool TF>
const ConstIterator operator+ ( size_t  inc,
const ConstIterator it 
)
friend

Addition between an integral value and a ConstIterator.

Parameters
incThe number of elements the iterator is incremented.
itThe iterator to be incremented.
Returns
The incremented iterator.
template<typename VT1, typename VT2, bool TF>
const ConstIterator operator- ( const ConstIterator it,
size_t  dec 
)
friend

Subtraction between a ConstIterator and an integral value.

Parameters
itThe iterator to be decremented.
decThe number of elements the iterator is decremented.
Returns
The decremented iterator.

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