__GNU_PBDS::DETAIL::BIN_SEARCH_TREE_CONST_IT_(3)

💖 NAME 💖

__gnu_pbds::detail::bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > — Const iterator. 🦋

okay bestie so this little icon lives in the Library Functions Manual section of the libstdc++ docs, and it is literally the const iterator of a binary search tree. eight template parameters. she's a lot but she's worth it 💅

---

✨ SYNOPSIS ✨

#include <point_iterators.hpp>

🫶 Inherited by

Like, three whole classes are out here claiming her as their mother:

• __gnu_pbds::detail::bin_search_tree_it_< typename node_alloc_traits::pointer, typename type_traits::value_type, typename type_traits::pointer, typename type_traits::const_pointer, typename type_traits::reference, typename type_traits::const_reference, true, _Alloc >
• __gnu_pbds::detail::bin_search_tree_it_< typename node_alloc_traits::pointer, typename type_traits::value_type, typename type_traits::pointer, typename type_traits::const_pointer, typename type_traits::reference, typename type_traits::const_reference, false, _Alloc >
• __gnu_pbds::detail::bin_search_tree_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc >

---

🎀 Public Types

the glow-up glossary, no cap:

• typedef Const_Pointer const_pointer — the pointer-but-make-it-const type ✨
• typedef Const_Reference const_reference — the reference-but-make-it-const type ✨
• typedef _Alloc::difference_type difference_type — how far apart two of these are, type-wise 📏
• typedef std::bidirectional_iterator_tag iterator_category — hi yes she's a bidirectional iterator, so she walks both ways 🚶♀️🚶♀️
• typedef Pointer pointer — the pointer type
• typedef Reference reference — the reference type
• typedef Value_Type value_type — the actual value type, the moment 💜

💅 Public Member Functions

every single one, because we do NOT skip:

• bin_search_tree_const_it_ (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, !Is_Forward_Iterator, _Alloc > &other) — constructor that takes the opposite-flavor iterator, note the !Is_Forward_Iterator, it's giving flip 🔄
• bin_search_tree_const_it_ (const Node_Pointer p_nd=0) — constructor from a node pointer, and yes the default is 0
• bool operator!= (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, !Is_Forward_Iterator, _Alloc > &other) const — "not equal" against the opposite-flavor iterator
• bool operator!= (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > &other) const — "not equal" against the same-flavor iterator
• const_reference operator* () const — dereference, but const, respect her boundaries 🫶
• bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > & operator++ () — pre-increment, returns a reference to herself (main character energy) 👑
• bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > operator++ (int) — post-increment, returns a copy, the classic
• bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > & operator-- () — pre-decrement, also returns herself
• bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > operator-- (int) — post-decrement, returns a copy
• const_pointer operator-> () const — the arrow, const edition 🏹
• bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > & operator= (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, !Is_Forward_Iterator, _Alloc > &other) — assign from the opposite-flavor iterator
• bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > & operator= (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > &other) — assign from the same-flavor iterator
• bool operator== (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, !Is_Forward_Iterator, _Alloc > &other) const — equality against the opposite-flavor iterator
• bool operator== (const bin_search_tree_const_it_< Node_Pointer, Value_Type, Pointer, Const_Pointer, Reference, Const_Reference, Is_Forward_Iterator, _Alloc > &other) const — equality against the same-flavor iterator

🌸 Public Attributes

• Node_Pointer m_p_nd — the node pointer, just sitting there, public, unbothered, moisturized 🌿

🧚 Protected Member Functions

protected = family only, bestie:

• void dec (false_type) — decrement, false_type flavor
• void dec (true_type) — decrement, true_type flavor
• void inc (false_type) — increment, false_type flavor
• void inc (true_type) — increment, true_type flavor

---

🔥 Detailed Description 🔥

the full declaration, verbatim, because we respect the source:

template<typename Node_Pointer, typename Value_Type, typename Pointer,
    typename Const_Pointer, typename Reference, typename Const_Reference,
    bool Is_Forward_Iterator, typename _Alloc>
class __gnu_pbds::detail::bin_search_tree_const_it_< Node_Pointer,
Value_Type, Pointer, Const_Pointer, Reference, Const_Reference,
Is_Forward_Iterator, _Alloc >"Const iterator.

not me spotting that stray " right before Const iterator. in the original 💀 it's literally in the docs, so it stays in my version too, no cap

---

💜 Author 💜

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

---

and that's the whole page, bestie — every type, every operator, every !Is_Forward_Iterator, every protected inc/dec, all of it, nothing skipped 🎀 this one shipped as part of libstdc++ under the __gnu_pbds..., _Alloc >(3) header in the Library Functions Manual, and yes she was auto-generated by Doxygen straight from the source, so go thank a build script 🫶💖