__gnu_parallel::guarded_iterator(3)

NAME
__gnu_parallel::guarded_iterator - Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons.

SYNOPSIS

  Public Member Functions
guarded_iterator (RandomAccessIterator begin, RandomAccessIterator end, Comparator &comp)
operator RandomAccessIterator ()
std::iterator_traits< RandomAccessIterator >::value_type & operator* ()
guarded_iterator< RandomAccessIterator, Comparator > & operator++ ()

  Friends
bool operator (guarded_iterator< RandomAccessIterator, Comparator > &bi1, guarded_iterator< RandomAccessIterator, Comparator > &bi2)
bool operator (guarded_iterator< RandomAccessIterator, Comparator > &bi1, guarded_iterator< RandomAccessIterator, Comparator > &bi2)

Detailed Description

  template<typename RandomAccessIterator, typename Comparator> class __gnu_parallel::guarded_iterator< RandomAccessIterator, Comparator >
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 RandomAccessIterator is not possible since RandomAccessIterator need not be a class.

Definition at line 90 of file multiway_merge.h.

Constructor & Destructor Documentation

  template<typename RandomAccessIterator, typename Comparator> __gnu_parallel::guarded_iterator< RandomAccessIterator, Comparator >::guarded_iterator (RandomAccessIterator begin, RandomAccessIterator end, Comparator & 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 108 of file multiway_merge.h.

Member Function Documentation

  template<typename RandomAccessIterator, typename Comparator> __gnu_parallel::guarded_iterator< RandomAccessIterator, Comparator >::operator RandomAccessIterator () [inline]

Convert to wrapped iterator.

Returns:
    Wrapped iterator.

Definition at line 130 of file multiway_merge.h.

  template<typename RandomAccessIterator, typename Comparator> std::iterator_traits<RandomAccessIterator>::value_type& __gnu_parallel::guarded_iterator< RandomAccessIterator, Comparator >::operator* () [inline]

Dereference operator.

Returns:
    Referenced element.

Definition at line 125 of file multiway_merge.h.

  template<typename RandomAccessIterator, typename Comparator> guarded_iterator<RandomAccessIterator, Comparator>& __gnu_parallel::guarded_iterator< RandomAccessIterator, Comparator >::operator++ () [inline]

Pre-increment operator.

Returns:
    This.

Definition at line 116 of file multiway_merge.h.

Author

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