public member function
<unordered_set>

std::unordered_multiset::bucket

size_type bucket ( const key_type& k ) const;
Locate element's bucket
Returns the bucket number where the elements with value k is located.

A bucket is a slot in the container's internal hash table to which elements are assigned based on their hash value. Elements with the same value are located in the same bucket. Buckets are numbered from 0 to (bucket_count-1).

Individual elements in a bucket can be accessed by means of the range iterators returned by unordered_multiset::begin and unordered_multiset::end.

Parameters

k
Value whose bucket is to be located.
Member type key_type is the type of the elements in the container. In unordered_set containers it is the same as value_type, defined as an alias of the class's first template parameter (Key).

Return value

The order number of the bucket corresponding to k.

Member type size_type is an unsigned integral type.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
// unordered_multiset::bucket
#include <iostream>
#include <string>
#include <unordered_set>

int main ()
{
  std::unordered_multiset<std::string> myums =
  {"water","sand","ice","water"};

  for (const std::string& x: myums) {
    std::cout << x << " is in bucket #" << myums.bucket(x) << std::endl;
  }

  return 0;
}


Possible output:
ice is in bucket #0
sand is in bucket #2
water is in bucket #4
water is in bucket #4

Complexity

Constant.

Iterator validity

No changes.

See also

unordered_multiset::find
Get iterator to element (public member function)
unordered_multiset::bucket_size
Return bucket size (public member type )
unordered_multiset::bucket_count
Return number of buckets (public member function)

C++