std::unorde...imap::bucket(3)

💖 NAME 💖

okay so this page is std::unordered_multimap::bucket — the header shows it as std::unorde...imap::bucket(3), and it's from the C++ Standard Libary manual. bestie, we're checking which bucket a key lands in, and the vibes are very C++. 💅

---

✨ 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;

Overload (1) is the classic since C++11. Overload (2) is the newer template one since C++26. 🎀

🦋 DESCRIPTION 🦋

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.

Important vibe check: the returned value is valid only for instances of the container for which bucket_count() returns the same value (e.g., rehash() invalidates previously obtained value).

fr fr undefined behavior alert: the behavior is undefined if bucket_count() is zero. 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. periodt. ✨

💜 Complexity 💜

Constant. no cap, constant.

👑 Notes 👑

Feature-test macro tea:

• 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.
• This note is for overload (2).

🍓 Example 🍓

This section is incomplete
Reason: no example

bestie the example section is literally incomplete 😭

🌈 See also 🌈

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

Category: * Todo no example

---

okay that's the whole page, ily 💖 source: http://cppreference.com — date: 2024.06.10 — page: std::unorde...imap::bucket(3).