__GNU_PARALLEL::_GUARDEDITERATOR(3)

📦
version 16.2.1+r23+gd564253eb6c8 · 5 versions
, in arch rolling, centos-stream 10, fedora 43, fedora 44

💖 NAME 💖

ok so bestie, gather round: __gnu_parallel::_GuardedIterator< _RAIter, _Compare > — an Iterator wrapper supporting an implicit supremum at the end of the sequence, dominating all comparisons. no cap, that's literally what it is 💅

✨ SYNOPSIS ✨

#include <multiway_merge.h>

🎀 Public Member Functions

  • _GuardedIterator (_RAIter __begin, _RAIter __end, _Compare &__comp) — the Constructor. sets the iterator to the beginning of the sequence, iconic behavior honestly 🫶
  • 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 way it just shows up at the end of your sequence and outranks EVERYTHING? main character energy fr fr 👑

ok but the tea: the implicit supremum comes with a performance cost. bestie, nothing in this life is free 😭

and also, super important: Deriving from _RAIter is not possible since _RAIter need not be a class. like. it literally cannot be a base class. not me finding out the hard way 💀

🧚 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. yes babe, we start at the start, groundbreaking ✨

Parameters

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

Referenced by operator<, and operator<=. (they literally could not do their job without it 🫶)

🌈 Member Function Documentation 🌈

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

Convert to wrapped iterator.

Returns

  • Wrapped iterator. that's it, that's the whole vibe ⭐
template<typename _RAIter, typename _Compare> std::iterator_traits< _RAIter
>::value_type & __gnu_parallel::_GuardedIterator< _RAIter, _Compare
>::operator* () const [inline]

Dereference operator.

Returns

  • Referenced element. give me the thing 💅
template<typename _RAIter, typename _Compare> _GuardedIterator< _RAIter,
_Compare > & __gnu_parallel::_GuardedIterator< _RAIter, _Compare
>::operator++ () [inline]

Pre-increment operator.

Returns

  • This. returns itself, so self-obsessed, we love that for it 😌
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.

References _GuardedIterator().

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.

References _GuardedIterator().

🫶 lowkey both of these are besties with the constructor, hence the references. it's giving found family.

🍓 Author 🍓

Generated automatically by Doxygen for libstdc++ from the source code. yeah bestie, a robot wrote this, not me — I just gave it the glow-up 💖✨

ok that's the whole page!! thanks for reading my little manpage, you're doing amazing sweetie 🌸 this was __gnu_para... _Compare >(3), brought to you by libstdc++ — mwah, slay, periodt 💅🎀

📦 where this page comes from
  • arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 · GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
  • centos-stream 10: gcc-toolset-15-libstdc++-docs 15.2.1-8.1.el10 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • centos-stream 10: gcc-toolset-16-libstdc++-docs 16.2.1-1.3.el10 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • centos-stream 10: libstdc++-docs 14.4.1-4.el10 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 43: libstdc++-docs 15.2.1-2.fc43 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 43: libstdc++-docs 15.3.1-1.fc43 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 44: libstdc++-docs 16.0.1-0.10.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • fedora 44: libstdc++-docs 16.2.1-2.fc44
  • fedora 44: libstdc++-docs 16.2.1-3.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
  • 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms