__GNU_PARALLEL::_GUARDEDITERATOR(3cxx)

💅 NAME 💅

ok so bestie, meet __gnu_parallel::_GuardedIterator< _RAIter, _Compare > — it's an _Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons. yes that's a real sentence, and yes it's kind of iconic 💖

this page lives in the libstdc++ manual, section 3cxx — noted, we'll circle back at the sign-off 🎀

---

✨ SYNOPSIS ✨

#include <multiway_merge.h>

🫶 Public Member Functions

• _GuardedIterator (_RAIter __begin, _RAIter __end, _Compare &__comp) — the Constructor. Sets iterator to beginning of sequence. hi bestie 👋
• operator _RAIter () const — Convert to wrapped iterator.
• std::iterator_traits< _RAIter >::value_type & operator* () const — Dereference operator. yes queen, get the value 💅
• _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."

ok so real talk: the implicit supremum comes with a performance cost. 😭 that's not me being dramatic, that's literally in the docs — the convenience has a price tag, ngl.

and why isn't this thing just derived from _RAIter like a normal class hierarchy moment? because deriving from _RAIter is not possible since _RAIter need not be a class. lowkey humbling 🙈

---

🎀 Constructor & Destructor Documentation 🎀

_GuardedIterator (_RAIter __begin, _RAIter __end, _Compare & __comp) [inline]

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. first-day-of-school energy fr fr ✨

Parameters

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

---

💜 Member Function Documentation 💜

operator _RAIter () const [inline]

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

Convert to wrapped iterator. it's giving glow-up-to-your-true-form 🦋

Returns

Wrapped iterator.

operator* () const [inline]

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

Dereference operator. the main character of operators, honestly 👑

Returns

Referenced element.

operator++ () [inline]

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

Pre-increment operator. moving forward, always moving forward 💅

Returns

This.

---

🔥 Friends And Related Symbol Documentation 🔥

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

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. a little comparison date, we love to see it 🍓

Parameters

• __bi1 — First iterator.
• __bi2 — Second iterator.

Returns

true if less.

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

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. same vibes, slightly more generous 💖

Parameters

• __bi1 — First iterator.
• __bi2 — Second iterator.

Returns

true if less equal.

---

⭐ Author ⭐

Generated automatically by Doxygen for libstdc++ from the source code. not a human author, just Doxygen doing its little autogenerated thing 🤖✨

---

ok that's the whole page, bestie — every member, every parameter, every [inline] and [friend], nothing skipped. go forth and guard those iterators 🫶

🌈 that's a wrap! this was the libstdc++ page for __gnu_parallel::_GuardedIterator< _RAIter, _Compare >, manual section 3cxx — mwah, slay, periodt 💅🎀