__gnu_parallel::_GuardedIterator< _RAIter, _Compare >(3cxx)

NAME
__gnu_parallel::_GuardedIterator< _RAIter, _Compare > - _Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons.

SYNOPSIS

  Public Member Functions

_GuardedIterator (_RAIter __begin, _RAIter __end, _Compare &__comp)
Constructor. Sets iterator to beginning of sequence.
operator _RAIter ()
Convert to wrapped iterator.
std::iterator_traits< _RAIter >::value_type & operator* ()
Dereference operator.
_GuardedIterator< _RAIter, _Compare > & operator++ ()
Pre-increment operator.

  Friends

bool operator< (_GuardedIterator< _RAIter, _Compare > &__bi1, _GuardedIterator< _RAIter, _Compare > &__bi2)
Compare two elements referenced by guarded iterators.
bool operator<= (_GuardedIterator< _RAIter, _Compare > &__bi1, _GuardedIterator< _RAIter, _Compare > &__bi2)
Compare two elements referenced by guarded iterators.

Detailed Description

  template<typename _RAIter, typename _Compare>
class __gnu_parallel::_GuardedIterator< _RAIter, _Compare >" _Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons.

The implicit supremum comes with a performance cost.

Deriving from _RAIter is not possible since _RAIter need not be a class.

Definition at line 73 of file multiway_merge.h.

Constructor & Destructor Documentation

  template<typename _RAIter , typename _Compare > __gnu_parallel::_GuardedIterator< _RAIter, _Compare >::_GuardedIterator (_RAIter __begin, _RAIter __end, _Compare & __comp) [inline]

Constructor. Sets iterator to beginning of sequence.

Parameters:
    __begin Begin iterator of sequence.
    __end End iterator of sequence.
    __comp Comparator provided for associated overloaded compare operators.

Definition at line 91 of file multiway_merge.h.

Member Function Documentation

  template<typename _RAIter , typename _Compare > __gnu_parallel::_GuardedIterator< _RAIter, _Compare >::operator _RAIter () [inline]

Convert to wrapped iterator.

Returns:
    Wrapped iterator.

Definition at line 112 of file multiway_merge.h.

  template<typename _RAIter , typename _Compare > std::iterator_traits<_RAIter>::value_type& __gnu_parallel::_GuardedIterator< _RAIter, _Compare >::operator* () [inline]

Dereference operator.

Returns:
    Referenced element.

Definition at line 107 of file multiway_merge.h.

  template<typename _RAIter , typename _Compare > _GuardedIterator<_RAIter, _Compare>& __gnu_parallel::_GuardedIterator< _RAIter, _Compare >::operator++ () [inline]

Pre-increment operator.

Returns:
    This.

Definition at line 98 of file multiway_merge.h.

Friends And Related Function Documentation

  template<typename _RAIter , typename _Compare > bool operator< (_GuardedIterator< _RAIter, _Compare > & __bi1, _GuardedIterator< _RAIter, _Compare > & __bi2) [friend]

Compare two elements referenced by guarded iterators.

Parameters:
    __bi1 First iterator.
    __bi2 Second iterator.

Returns:
    true if less.

Definition at line 120 of file multiway_merge.h.

  template<typename _RAIter , typename _Compare > bool operator<= (_GuardedIterator< _RAIter, _Compare > & __bi1, _GuardedIterator< _RAIter, _Compare > & __bi2) [friend]

Compare two elements referenced by guarded iterators.

Parameters:
    __bi1 First iterator.
    __bi2 Second iterator.

Returns:
    True if less equal.

Definition at line 135 of file multiway_merge.h.

Author

Generated automatically by Doxygen for libstdc++ from the source code.