STD::__DEBUG::UNORDERED_MAP(3)

👑 std::__debug::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc > 💅

okay bestie, welcome to the Library Functions Manual page for this absolute icon — std::__debug::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc >, no cap. It's the section 3 library-functions vibe, and yes, we are reading it together. 🫶

---

✨ NAME ✨

std::__debug::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc > — it's a Class that is literally std::unordered_map but with safety/checking/debug instrumentation. she's the same girl but with a security detail 💖

---

🌈 SYNOPSIS 🌈

#include <unordered_map>

Inherits __gnu_debug::_Safe_container< _SafeContainer, _Alloc, _SafeBase, _IsCxx11AllocatorAware >. family tree moment ✨

🎀 Public Types 🎀

• allocator_type — typedef _Base::allocator_type allocator_type
• const_iterator — typedef __gnu_debug::_Safe_iterator< _Base_const_iterator, unordered_map > const_iterator
• const_local_iterator — typedef __gnu_debug::_Safe_local_iterator< _Base_const_local_iterator, unordered_map > const_local_iterator
• const_pointer — typedef _Base::const_pointer const_pointer
• const_reference — typedef _Base::const_reference const_reference
• difference_type — typedef _Base::difference_type difference_type
• hasher — typedef _Base::hasher hasher
• iterator — typedef __gnu_debug::_Safe_iterator< _Base_iterator, unordered_map > iterator
• key_equal — typedef _Base::key_equal key_equal
• key_type — typedef _Base::key_type key_type
• local_iterator — typedef __gnu_debug::_Safe_local_iterator< _Base_local_iterator, unordered_map > local_iterator
• mapped_type — typedef _Base::mapped_type mapped_type
• pointer — typedef _Base::pointer pointer
• reference — typedef _Base::reference reference
• size_type — typedef _Base::size_type size_type
• value_type — typedef _Base::value_type value_type

sixteen types, all accounted for, we do not skip a single one in this house 💜

💖 Public Member Functions 💖

🦋 Constructors, the whole roster 🦋

• unordered_map (_Base_ref __x) — builds one from a _Base_ref __x.
• template<typename _InputIterator> unordered_map (_InputIterator __first, _InputIterator __last, const allocator_type &__a) — from the range __first to __last, plus allocator __a.
• template<typename _InputIterator> unordered_map (_InputIterator __first, _InputIterator __last, size_type __n, const allocator_type &__a) — same range, plus bucket count __n and allocator __a.
• template<typename _InputIterator> unordered_map (_InputIterator __first, _InputIterator __last, size_type __n, const hasher &__hf, const allocator_type &__a) — range, plus __n, hasher __hf and allocator __a.
• template<typename _InputIterator> unordered_map (_InputIterator __first, _InputIterator __last, size_type __n=0, const hasher &__hf=hasher(), const key_equal &__eql=key_equal(), const allocator_type &__a=allocator_type()) — the full range glow-up, with defaults size_type __n=0, const hasher &__hf=hasher(), const key_equal &__eql=key_equal(), const allocator_type &__a=allocator_type().
• unordered_map (const allocator_type &__a) — just the allocator __a, minimal queen behavior.
• unordered_map (const unordered_map &)=default — copy constructor, and it's =default so it's free.
• unordered_map (const unordered_map &__umap, const allocator_type &__a) — copy __umap, but with allocator __a.
• unordered_map (initializer_list< value_type > __l, const allocator_type &__a) — from initializer list __l and allocator __a.
• unordered_map (initializer_list< value_type > __l, size_type __n, const allocator_type &__a) — __l, bucket count __n, allocator __a.
• unordered_map (initializer_list< value_type > __l, size_type __n, const hasher &__hf, const allocator_type &__a) — __l, __n, hasher __hf, allocator __a.
• unordered_map (initializer_list< value_type > __l, size_type __n=0, const hasher &__hf=hasher(), const key_equal &__eql=key_equal(), const allocator_type &__a=allocator_type()) — initializer list with the whole default squad: size_type __n=0, const hasher &__hf=hasher(), const key_equal &__eql=key_equal(), const allocator_type &__a=allocator_type().
• unordered_map (size_type __n, const allocator_type &__a) — bucket count __n and allocator __a.
• unordered_map (size_type __n, const hasher &__hf, const allocator_type &__a) — __n, hasher __hf, allocator __a.
• unordered_map (size_type __n, const hasher &__hf=hasher(), const key_equal &__eql=key_equal(), const allocator_type &__a=allocator_type()) — __n with defaults const hasher &__hf=hasher(), const key_equal &__eql=key_equal(), const allocator_type &__a=allocator_type().
• unordered_map (unordered_map &&)=default — move constructor, =default, she moves fast 💅
• unordered_map (unordered_map &&__umap, const allocator_type &__a) noexcept(noexcept(_Base(std::move(__umap), __a))) — move from __umap with allocator __a, and note the exception spec is exactly noexcept(noexcept(_Base(std::move(__umap), __a))).

🌸 The rest of the member function serving 🍓

• const _Base & _M_base () const noexcept — hands you the const _Base &, noexcept.
• _Base & _M_base () noexcept — same energy, non-const, noexcept.
• const_iterator begin () const noexcept — const begin, noexcept.
• iterator begin () noexcept — begin, noexcept.
• local_iterator begin (size_type __b) — begin for bucket __b.
• const_local_iterator begin (size_type __b) const — const version, bucket __b.
• size_type bucket_size (size_type __b) const — how big bucket __b is, as a size_type.
• const_iterator cbegin () const noexcept — cbegin, noexcept.
• const_local_iterator cbegin (size_type __b) const — cbegin for bucket __b.
• const_iterator cend () const noexcept — cend, noexcept.
• const_local_iterator cend (size_type __b) const — cend for bucket __b.
• void clear () noexcept — wipes it, noexcept.
• template<typename... _Args> std::pair< iterator, bool > emplace (_Args &&... __args) — perfect-forwarding emplace over _Args &&... __args, returns std::pair< iterator, bool >.
• template<typename... _Args> iterator emplace_hint (const_iterator __hint, _Args &&... __args) — emplace with a hint __hint, returns iterator.
• const_iterator end () const noexcept — const end, noexcept.
• iterator end () noexcept — end, noexcept.
• local_iterator end (size_type __b) — end for bucket __b.
• const_local_iterator end (size_type __b) const — const version, bucket __b.
• std::pair< iterator, iterator > equal_range (const key_type &__key) — equal_range for __key, returns std::pair< iterator, iterator >.
• std::pair< const_iterator, const_iterator > equal_range (const key_type &__key) const — const one, returns std::pair< const_iterator, const_iterator >.
• _Base_iterator erase (_Base_const_iterator __it) — erase by _Base_const_iterator __it, returns _Base_iterator.
• template<__heterogeneous_hash_key< unordered_map > _Kt> size_type erase (_Kt &&__key) — the fancy heterogeneous one, keyed on _Kt, returns size_type.
• size_type erase (const key_type &__key) — erase by __key, returns size_type.
• iterator erase (const_iterator __first, const_iterator __last) — erase the range __first to __last, returns iterator.
• iterator erase (const_iterator __it) — erase one const_iterator __it, returns iterator.
• iterator erase (iterator __it) — erase one iterator __it, returns iterator.
• iterator find (const key_type &__key) — find by __key, returns iterator.
• const_iterator find (const key_type &__key) const — const find by __key.
• template<typename _InputIterator> void insert (_InputIterator __first, _InputIterator __last) — insert the range __first to __last, returns void.
• template<typename _Pair, typename = typename std::enable_if<std::is_constructible<value_type, _Pair&&>::value>::type> std::pair< iterator, bool > insert (_Pair &&__obj) — the SFINAE-gated one, _Pair &&__obj, returns std::pair< iterator, bool >.
• std::pair< iterator, bool > insert (const value_type &__obj) — insert const value_type &__obj, returns std::pair< iterator, bool >.
• template<typename _Pair, typename = typename std::enable_if<std::is_constructible<value_type, _Pair&&>::value>::type> iterator insert (const_iterator __hint, _Pair &&__obj) — hinted, SFINAE-gated, returns iterator.
• iterator insert (const_iterator __hint, const value_type &__obj) — hinted insert, returns iterator.
• iterator insert (const_iterator __hint, value_type &&__x) — hinted move-y insert with value_type &&__x, returns iterator.
• void insert (std::initializer_list< value_type > __l) — insert the whole initializer list __l, returns void.
• std::pair< iterator, bool > insert (value_type &&__x) — insert value_type &&__x, returns std::pair< iterator, bool >.
• float max_load_factor () const noexcept — getter for the max load factor, returns float, noexcept.
• void max_load_factor (float __f) — setter, takes float __f.
• unordered_map & operator= (const unordered_map &)=default — copy assign, =default.
• unordered_map & operator= (initializer_list< value_type > __l) — assign from __l, returns unordered_map &.
• unordered_map & operator= (unordered_map &&)=default — move assign, =default.
• void swap (unordered_map &__x) noexcept(noexcept(declval< _Base & >().swap(__x))) — swaps with __x, with that very specific noexcept(noexcept(declval< _Base & >().swap(__x))).

🧚 Protected Member Functions 🧚

• constexpr void _M_swap (const _Safe_container &__x) const noexcept — constexpr, takes const _Safe_container &__x, returns void, noexcept. protected, so it's giving inner-circle ✨

👑 Friends 👑

• template<typename _ItT, typename _SeqT, typename _CatT> class ::__gnu_debug::_Safe_iterator
• template<typename _ItT, typename _SeqT> class ::__gnu_debug::_Safe_local_iterator

the friend list is short but she's picky and that's her right 🎀

---

🦄 Detailed Description 🦄

template<typename _Key, typename _Tp, typename _Hash = std::hash<_Key>,
    typename _Pred = std::equal_to<_Key>, typename _Alloc =
    std::allocator<std::pair<const _Key, _Tp> >>
class std::__debug::unordered_map< _Key, _Tp, _Hash, _Pred, _Alloc
>"Class std::unordered_map with safety/checking/debug instrumentation.

so yeah — Class std::unordered_map with safety/checking/debug instrumentation. That's the whole point of her. Same map, extra watching. 👀

---

✍️ Author ✍️

Generated automatically by Doxygen for libstdc++ from the source code. not a human author, just a robot doing its little thing 🤖💜

---

ok and that's the whole page bestie, nothing skipped, every single signature stayed exactly where it was 💅

and for the sign-off: this whole thing is libstdc++, for the page std::__deb..., _Alloc >(3) — that's the version/source stamp down at the bottom, and it's literally the last line of the page. bye pookie, go write some debug-instrumented unordered maps 🦋💖✨