NAME

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

SYNOPSIS

       #include <multiway_merge.h>

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

   Friends
       bool operator< (const _GuardedIterator< _RAIter, _Compare > &__bi1, const
           _GuardedIterator< _RAIter, _Compare > &__bi2)
           Compare two elements referenced by guarded iterators.
       bool operator<= (const _GuardedIterator< _RAIter, _Compare > &__bi1, const
           _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.

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.

Member Function Documentation

   template<typename _RAIter , typename _Compare > __gnu_parallel::_GuardedIterator< _RAIter,
       _Compare >::operator _RAIter () const [inline]
       Convert to wrapped iterator.

       Returns
           Wrapped iterator.

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

       Returns
           Referenced element.

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

       Returns
           This.

Friends And Related Symbol Documentation

   template<typename _RAIter , typename _Compare > bool operator< (const _GuardedIterator<
       _RAIter, _Compare > & __bi1, const _GuardedIterator< _RAIter, _Compare > & __bi2) [friend]
       Compare two elements referenced by guarded iterators.

       Parameters
           __bi1 First iterator.
           __bi2 Second iterator.

       Returns
           true if less.

   template<typename _RAIter , typename _Compare > bool operator<= (const _GuardedIterator<
       _RAIter, _Compare > & __bi1, const _GuardedIterator< _RAIter, _Compare > & __bi2) [friend]
       Compare two elements referenced by guarded iterators.

       Parameters
           __bi1 First iterator.
           __bi2 Second iterator.

       Returns
           True if less equal.

Author

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

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