__GNU_PBDS::DETAIL::BINARY_HEAP_CONST_ITERATOR_(3)

📦
version 16.2.1+r23+gd564253eb6c8 · 6 versions
, in arch rolling, fedora 44

💖 NAME 💖

okay bestie, meet __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc > — she's a Const point-type iterator. that's it, that's the whole job description, and she does it flawlessly. 💅

this page lives in the Library Functions Manual (section 3, iykyk) and it's all about libstdc++'s GNU PBDS internals. ngl, it's giving "you're deep in the implementation and you know exactly why you're here." 🎀

✨ SYNOPSIS ✨

#include <const_iterator.hpp>

Inherits __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >.

so like, she's not doing this alone — she's got a whole parent class holding her up. main character with a support system fr fr. 🫶

🌸 Public Types 🌸

  • typedef base_type::const_pointer const_pointer — the iterator's const pointer type.
  • typedef base_type::const_reference const_reference — the iterator's const reference type.
  • typedef _Alloc::difference_type difference_type — difference type.
  • typedef std::forward_iterator_tag iterator_category — category. yes she's tagged. yes it matters.
  • typedef base_type::pointer pointer — the iterator's pointer type.
  • typedef base_type::reference reference — the iterator's reference type.
  • typedef base_type::value_type value_type — the iterator's value type.

🦋 Public Member Functions 🦋

  • binary_heap_const_iterator_ () — Default constructor. the humble beginnings era.
  • binary_heap_const_iterator_ (const binary_heap_const_iterator_ &other) — Copy constructor. she's her own twin. iconic.
  • binary_heap_const_iterator_ (entry_pointer p_e) — (no description on the original page, so we just vibe with the signature 💀)
  • bool operator!= (const binary_heap_const_iterator_ &other) const — Compares content (negatively) to a different iterator object. so basically "not you, babe."
  • bool operator!= (const binary_heap_point_const_iterator_ &other) const — Compares content (negatively) to a different iterator object. same energy, different type.
  • const_reference operator* () const — Access. ✨
  • binary_heap_const_iterator_ & operator++ () — (no description, just the increment. periodt.)
  • binary_heap_const_iterator_ operator++ (int) — (postfix version, also undescribed, also valid, we respect her 🙈)
  • const_pointer operator-> () const — Access. ✨
  • bool operator== (const binary_heap_const_iterator_ &other) const — Compares content to a different iterator object. "omg it's literally you."
  • bool operator== (const binary_heap_point_const_iterator_ &other) const — Compares content to a different iterator object. same but the other flavor.

💜 Public Attributes 💜

  • entry_pointer m_p_e — (she's just there, living her best life, no description attached)

🌈 Detailed Description 🌈

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
class __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >

"Const point-type iterator.

lowkey the whole personality is in that one line and honestly? it eats. 🔥

🎀 Member Typedef Documentation 🎀

⭐ const_pointer

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef base_type::const_pointer __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::const_pointer

Iterator's const pointer type.

⭐ const_reference

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef base_type::const_reference __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::const_reference

Iterator's const reference type.

⭐ difference_type

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef _Alloc::difference_type __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::difference_type

Difference type.

⭐ iterator_category

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef std::forward_iterator_tag __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::iterator_category

Category.

⭐ pointer

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef base_type::pointer __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::pointer

Iterator's pointer type.

⭐ reference

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef base_type::reference __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::reference

Iterator's reference type.

⭐ value_type

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
typedef base_type::value_type __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::value_type

Iterator's value type.

🌸 Constructor & Destructor Documentation 🌸

🫶 binary_heap_const_iterator_ () — Default constructor

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
__gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::binary_heap_const_iterator_ () [inline]

Default constructor. everyone starts somewhere bestie. ✨

🫶 binary_heap_const_iterator_ (const binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) — Copy constructor

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
__gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::binary_heap_const_iterator_ (const binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) [inline]

Copy constructor. clone behavior, she understood the assignment. 💅

💖 Member Function Documentation 💖

🔥 operator!= — against binary_heap_const_iterator_

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
bool __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::operator!= (const binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) const [inline]

Compares content (negatively) to a different iterator object.

🔥 operator!= — against binary_heap_point_const_iterator_

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
bool __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::operator!= (const binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) const [inline], [inherited]

Compares content (negatively) to a different iterator object.

✨ operator*

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
const_reference __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::operator* () const [inline], [inherited]

Access.

✨ operator->

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
const_pointer __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::operator-> () const [inline], [inherited]

Access.

💜 operator== — against binary_heap_const_iterator_

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
bool __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >::operator== (const binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) const [inline]

Compares content to a different iterator object.

💜 operator== — against binary_heap_point_const_iterator_

template<typename Value_Type, typename Entry, bool Simple, typename _Alloc>
bool __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::operator== (const binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) const [inline], [inherited]

Compares content to a different iterator object.

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code. no human author to thank here, it's literally the robots. and honestly? they ate. 🤖✨

and that's the whole page bestie — this one came out of the libstdc++ crew (that's the __gnu_pbds..., _Alloc >(3) manual page, Library Functions Manual, section 3), generated straight from the source code. go forth and iterate, const-ly. 💖🎀🦋
📦 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
  • 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