[#BloombergLP-bslstl-HashTable-bucketIndexForKey-06]
= 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 transparent `key`.

== Synopsis

Declared in `<bslstl_hashtable.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class LOOKUP_KEY>
xref:BloombergLP/bslstl/HashTable/SizeType.adoc[SizeType]
bucketIndexForKey(LOOKUP_KEY const& key) const
requires BloombergLP::bslmf::IsTransparentPredicate<HASHER,    LOOKUP_KEY>::value
   && BloombergLP::bslmf::IsTransparentPredicate<COMPARATOR,LOOKUP_KEY>::value;
----

== Description

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

== Return Value

index of the bucket that would contain elements equivalent to `key`

== Parameters

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


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