__GNU_PBDS::DETAIL::BINARY_HEAP_POINT_CONST_ITERATOR_(3cxx)

🌸 __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc > πŸ’…

okay bestie, so this is the <3cxx> manual page for libstdc++'s <pink>const point-type iterator</pink> β€” yes that's the whole vibe. it lives in __gnu_pbds::detail (the backstage area, iykyk) and it's genuinely iconic. read on, i promise it slaps ✨


πŸŽ€ NAME πŸŽ€

__gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc > β€” Const point-type iterator. that's literally her whole job 🫢


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <point_const_iterator.hpp>

Inherited by __gnu_pbds::detail::binary_heap_const_iterator_< Value_Type, Entry, Simple, _Alloc >. so she's the parent, the main character, the blueprint β€” the other one gets everything from her πŸ’β€β™€οΈ

✨ Public Types ✨

  • typedef rebind_traits< _Alloc, value_type >::const_pointer const_pointer β€” iterator's const pointer type. no cap, read-only energy only πŸ”’
  • typedef rebind_traits< _Alloc, value_type >::const_reference const_reference β€” iterator's const reference type.
  • typedef trivial_iterator_difference_type difference_type β€” difference type. it's giving "how far apart are we" 🧚
  • typedef trivial_iterator_tag iterator_category β€” category. the vibe check of what kind of iterator this even is 🏷️
  • typedef rebind_traits< _Alloc, value_type >::pointer pointer β€” iterator's pointer type.
  • typedef rebind_traits< _Alloc, value_type >::reference reference β€” iterator's reference type.
  • typedef Value_Type value_type β€” iterator's value type.

🌸 Public Member Functions 🌸

  • binary_heap_point_const_iterator_ () β€” default constructor. the "no thoughts, just vibes" start state πŸ™ˆ
  • binary_heap_point_const_iterator_ (const binary_heap_point_const_iterator_ &other) β€” copy constructor. twin energy, exactly like the original πŸ’–
  • binary_heap_point_const_iterator_ (entry_pointer p_e) β€” constructor that takes an entry_pointer πŸŽ€
  • bool operator!= (const binary_heap_point_const_iterator_ &other) const β€” compares content (negatively) to a different iterator object. the "you're not them" check πŸ’€
  • const_reference operator* () const β€” access. peek at the goods ✨
  • const_pointer operator-> () const β€” access. also access, just pointer-flavored 🫢
  • bool operator== (const binary_heap_point_const_iterator_ &other) const β€” compares content to a different iterator object. the "omg same" check πŸ‘‘

πŸ“ Public Attributes πŸ“

  • entry_pointer m_p_e β€” the actual member doing the holding. she's right there, no secrets πŸ’…

πŸ”₯ Protected Types πŸ”₯

  • typedef rebind_traits< _Alloc, Entry >::pointer entry_pointer β€” the protected one, so mind your business bestie πŸ™ˆ

πŸ’œ Detailed Description πŸ’œ

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

Const point-type iterator. that's the whole mood. four template params: Value_Type, Entry, Simple (a bool, icon behavior), and _Alloc β€” all of them doing their little part ✨


🧚 Member Typedef Documentation 🧚

  • const_pointer β€” template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>, defined as typedef rebind_traits<_Alloc,value_type>::const_pointer __gnu_pbds::detail::binary_heap_point_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>, defined as typedef rebind_traits<_Alloc,value_type>::const_reference __gnu_pbds::detail::binary_heap_point_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>, defined as typedef trivial_iterator_difference_type __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::difference_type. difference type. πŸ¦‹
  • iterator_category β€” template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>, defined as typedef trivial_iterator_tag __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::iterator_category. category.
  • pointer β€” template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>, defined as typedef rebind_traits<_Alloc,value_type>::pointer __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::pointer. iterator's pointer type.
  • reference β€” template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>, defined as typedef rebind_traits<_Alloc,value_type>::reference __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::reference. iterator's reference type.
  • value_type β€” template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>, defined as typedef Value_Type __gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::value_type. iterator's value type. πŸ’–

🌈 Constructor & Destructor Documentation 🌈

⭐ Default constructor

template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>

__gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::binary_heap_point_const_iterator_ () [inline]

default constructor. does what it says on the tin, and it's [inline] so she's efficient πŸ’…

⭐ Copy constructor

template <typename Value_Type , typename Entry , bool Simple, typename _Alloc>

__gnu_pbds::detail::binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc >::binary_heap_point_const_iterator_ (const binary_heap_point_const_iterator_< Value_Type, Entry, Simple, _Alloc > & other) [inline]

copy constructor. also [inline]. duplicate-and-slay behavior 🫢


πŸ‘‘ Member Function Documentation πŸ‘‘

πŸ’« operator!=

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]

compares content (negatively) to a different iterator object. so it's the "nope, not equal" girly πŸ’€

πŸ’« 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]

access. that's it, that's the whole description, and honestly? she ate ✨

πŸ’« 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]

access. yes again. iconic of her πŸ’…

πŸ’« operator==

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]

compares content to a different iterator object. the wholesome positive counterpart to operator!= πŸ’–


🌟 Author 🌟

generated automatically by Doxygen for libstdc++ from the source code. no human wrote this prose, only robot magic πŸ€–βœ¨


ok that's the whole page bestie, every typedef, every [inline], every template param β€” nothing skipped, periodt πŸ’…

and for the cute sign-off: this beauty comes to you from libstdc++, documented via Doxygen, and the footer of the original page just repeats the title on the 3cxx manual β€” so consider this your little goodbye kiss πŸŽ€ mwah, go read some iterators πŸ’–