[#BloombergLP-bslstl-HashTable-bucketIndexForKey-00]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslstl.adoc[bslstl]::xref:BloombergLP/bslstl/HashTable.adoc[HashTable]::bucketIndexForKey
:relfileprefix: ../../../
:mrdocs:

Return the bucket index for the specified `key`.

== Synopsis

Declared in `<bslstl_hashtable.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bslstl/HashTable/SizeType.adoc[HashTable<KEY_CONFIG, HASHER, COMPARATOR, ALLOCATOR>::SizeType]
bucketIndexForKey(xref:BloombergLP/bslstl/HashTable/KeyType.adoc[KeyType] const& key) const;
----

== Description

Return the index of the bucket that would contain all the elements having the specified `key`.

== Return Value

index of the bucket that would contain elements with `key`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *key*
| key whose bucket index is returned
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#