__GNU_PBDS::DETAIL::PAT_TRIE_BASE__NODE_ITER(3)

💖 NAME 💖

__gnu_pbds::detail::pat_trie_base::_Node_iter< Node, Leaf, Head, Inode, _CIterator, Iterator, _Alloc > — Node iterator.

okay so this is straight out of the Library Functions Manual, and it's giving deep-library-internals energy. Node iterator. that's the whole vibe. 🫶

---

✨ SYNOPSIS ✨

#include <pat_trie_base.hpp>

Inherits __gnu_pbds::detail::pat_trie_base::_Node_citer< Node, Leaf, Head, Inode, _CIterator, Iterator, _Alloc >.

---

🦋 Public Types 🦋

• typedef value_type const_reference
• typedef trivial_iterator_difference_type difference_type
• typedef trivial_iterator_tag iterator_category
• typedef rebind_traits< _Alloc, metadata_type >::const_reference metadata_const_reference — Const metadata reference type.
• typedef Node::metadata_type metadata_type — Metadata type.
• typedef value_type reference
• typedef base_type::size_type size_type
• typedef Iterator value_type

---

🌸 Public Member Functions 🌸

• _Node_iter (node_pointer p_nd=0, a_const_pointer p_traits=0)
• _Node_iter get_child (size_type i) const — Returns a node __iterator to the corresponding node's i-th child.
• metadata_const_reference get_metadata () const — Metadata access.
• size_type num_children () const — Returns the number of children in the corresponding node.
• bool operator!= (const _Node_citer &other) const — Compares content (negatively) to a different iterator object.
• reference operator* () const — Access; returns the iterator* associated with the current leaf.
• bool operator== (const _Node_citer &other) const — Compares content to a different iterator object.
• std::pair< a_const_iterator, a_const_iterator > valid_prefix () const — Subtree valid prefix.

---

💅 Public Attributes 💅

• node_pointer m_p_nd
• a_const_pointer m_p_traits

---

🎀 Protected Types 🎀

• typedef Node::a_const_iterator a_const_iterator
• typedef rebind_traits< _Alloc, Inode >::const_pointer inode_const_pointer
• typedef rebind_traits< _Alloc, Leaf >::const_pointer leaf_const_pointer
• typedef rebind_traits< _Alloc, Leaf >::pointer leaf_pointer

---

🌈 Detailed Description 🌈

no cap, here's the whole class declaration vibe:

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc>
class __gnu_pbds::detail::pat_trie_base::_Node_iter< Node, Leaf, Head,
    Inode, _CIterator, Iterator, _Alloc >"Node iterator.

Node iterator. iconic. 👑

---

⭐ Member Typedef Documentation ⭐

🧚 metadata_const_reference (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> typedef
    rebind_traits<_Alloc,metadata_type>::const_reference
    __gnu_pbds::detail::pat_trie_base::_Node_citer< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::metadata_const_reference [inherited]

Const metadata reference type. literally just a const ref to metadata, bestie, nothing scary. ✨

🧚 metadata_type (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> typedef
    Node::metadata_type __gnu_pbds::detail::pat_trie_base::_Node_citer<
    Node, Leaf, Head, Inode, _CIterator, Iterator, _Alloc >::metadata_type
    [inherited]

Metadata type. the metadata's type. that's it, that's the tea. 🍓

---

🔥 Member Function Documentation 🔥

💜 get_child — the one that gives you a child iterator

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> _Node_iter
    __gnu_pbds::detail::pat_trie_base::_Node_iter< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::get_child (size_type i) const [inline]

Returns a node __iterator to the corresponding node's i-th child. hand it an i, get back the iterator for that child. slay. 🌟

💜 get_metadata — metadata access (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc>
    metadata_const_reference __gnu_pbds::detail::pat_trie_base::_Node_citer<
    Node, Leaf, Head, Inode, _CIterator, Iterator, _Alloc >::get_metadata ()
    const [inline],  [inherited]

Metadata access. go get your metadata, you deserve it. 🎀

💜 num_children — how many kiddos (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> size_type
    __gnu_pbds::detail::pat_trie_base::_Node_citer< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::num_children () const [inline],
    [inherited]

Returns the number of children in the corresponding node.

Referenced by __gnu_pbds::detail::pat_trie_base::_Node_citer< node, leaf, head, inode, const_iterator, iterator, _Alloc >::operator*().

💜 operator!= — the "not equal" check (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> bool
    __gnu_pbds::detail::pat_trie_base::_Node_citer< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::operator!= (const _Node_citer< Node,
    Leaf, Head, Inode, _CIterator, Iterator, _Alloc > & other) const
    [inline],  [inherited]

Compares content (negatively) to a different iterator object. negatively = it's the not-equal one, bestie, don't overthink it. 💀

💜 operator* — the dereference moment

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> reference
    __gnu_pbds::detail::pat_trie_base::_Node_iter< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::operator* () const [inline]

Access; returns the iterator* associated with the current leaf. dereference and get your prize. 🔥

💜 operator== — the "equal" check (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> bool
    __gnu_pbds::detail::pat_trie_base::_Node_citer< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::operator== (const _Node_citer< Node,
    Leaf, Head, Inode, _CIterator, Iterator, _Alloc > & other) const
    [inline],  [inherited]

Compares content to a different iterator object. same energy as operator!= but the positive version. 🫶

💜 valid_prefix — subtree valid prefix (inherited)

template<typename Node, typename Leaf, typename Head, typename Inode,
    typename _CIterator, typename Iterator, typename _Alloc> std::pair<
    a_const_iterator, a_const_iterator >
    __gnu_pbds::detail::pat_trie_base::_Node_citer< Node, Leaf, Head, Inode,
    _CIterator, Iterator, _Alloc >::valid_prefix () const [inline],
    [inherited]

Subtree valid prefix. returns you a std::pair of a_const_iterators, and yes that's the whole description, iykyk. 🦋

---

👑 Author 👑

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

---

k that's the whole page, bestie 💖 this was page 3 of the Library Functions Manual, brought to you by libstdc++ and its Doxygen overlords — go forth and iterate responsibly. periodt. 💅✨