std::unordered_map::bucket(3)

💖 std::unordered_map::bucket(3) 💖

okay bestie, welcome to the std::unordered_map::bucket(3) page — it's from the C++ Standard Libary manual, and it's literally about asking an unordered_map which bucket a key belongs to. group-chat energy on, brain on 💅

---

🌸 NAME 🌸

std::unordered_map::bucket — std::unordered_map::bucket. She said what she said, and honestly? iconic. 💅

---

🦋 Synopsis 🦋

size_type bucket( const Key& key ) const; (1) (since C++11)
template< typename K >                    (2) (since C++26)
size_type bucket( const K& x ) const;

1. Returns the index of the bucket for key key. Elements (if any) with keys equivalent to key are always found in this bucket.
2. Returns the index of the bucket for key that compares equivalent to the value x. Elements (if any) with keys that compare equivalent to x are always found in this bucket. This overload participates in overload resolution only if Hash::is_transparent and KeyEqual::is_transparent are valid and each denotes a type. This assumes that such Hash is callable with both K and Key type, and that the KeyEqual is transparent, which, together, allows calling this function without constructing an instance of Key.

⚠️ The returned value is valid only for instances of the container for which bucket_count() returns the same value (e.g., rehash() invalidates a previously obtained value). So don't treat it like a forever value, bestie 😭

💀 The behavior is undefined if bucket_count() is zero. Like, genuinely undefined — do not.

---

🌸 Parameters 🌸

• key — the value of the key to examine.
• x — a value of any type that can be transparently compared with a key.

---

⭐ Return value ⭐

Bucket index for the requested key. That's it, that's the tea. ✨

---

🔥 Complexity 🔥

Constant. No cap, constant. 💅

---

🎀 Notes 🎀

Feature-test macro table vibes — here are all the bits, bestie:

• Feature-test macro: __cpp_lib_associative_heterogeneous_insertion
• Value: 202311L
• Std: (C++26)
• Feature: Heterogeneous overloads for the remaining member functions in ordered and unordered associative containers. (2)

---

🧚 Example 🧚

This section is incomplete — reason: no example. It's giving "left on read" 😭.

---

👑 See also 👑

• bucket_size — returns the number of elements in specific bucket (public member function).

---

🌈 Category 🌈

• Todo no example

---

xoxo, your C++ bestie 🫶 — source: http://cppreference.com, version/date: 2024.06.10, page: std::unordered_map::bucket(3) ✨💖