[#bsl-hash_multimap]
= xref:bsl.adoc[bsl]::hash_multimap
:relfileprefix: ../
:mrdocs:

Legacy STLPort hash container mapping keys to possibly duplicate values.

== Synopsis

Declared in `<bslstp_hashmap.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class _Key,
    class _Tp,
    class _HashFcn = BloombergLP::bslstp::HashSelector<_Key>::Type,
    class _EqualKey = bsl::ComparatorSelector<_Key>::Type,
    class _Alloc = xref:bsl/allocator-0df.adoc[bsl::allocator<pair<_Key const, _Tp>>]>
class hash_multimap;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/hash_multimap/_value_type.adoc[`_value_type`] 
| Internal synonym for the element `pair` type.
| xref:bsl/hash_multimap/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this multimap.
| xref:bsl/hash_multimap/const_iterator.adoc[`const_iterator`] 
| Iterator providing non‐modifiable access to elements.
| xref:bsl/hash_multimap/const_pointer.adoc[`const_pointer`] 
| Pointer to a non‐modifiable element.
| xref:bsl/hash_multimap/const_reference.adoc[`const_reference`] 
| Reference to a non‐modifiable element.
| xref:bsl/hash_multimap/data_type.adoc[`data_type`] 
| Mapped value type (synonym for `mapped_type`).
| xref:bsl/hash_multimap/difference_type.adoc[`difference_type`] 
| Signed integral type used for iterator distances.
| xref:bsl/hash_multimap/hasher.adoc[`hasher`] 
| Hash functor type.
| xref:bsl/hash_multimap/iterator.adoc[`iterator`] 
| Iterator providing modifiable access to elements.
| xref:bsl/hash_multimap/key_equal.adoc[`key_equal`] 
| Key‐equality functor type.
| xref:bsl/hash_multimap/key_type.adoc[`key_type`] 
| Key type used by this container.
| xref:bsl/hash_multimap/mapped_type.adoc[`mapped_type`] 
| Type of the mapped value associated with each key.
| xref:bsl/hash_multimap/pointer.adoc[`pointer`] 
| Pointer to a modifiable element.
| xref:bsl/hash_multimap/reference.adoc[`reference`] 
| Reference to a modifiable element.
| xref:bsl/hash_multimap/size_type.adoc[`size_type`] 
| Unsigned integral type used for sizes.
| xref:bsl/hash_multimap/value_type.adoc[`value_type`] 
| Element type stored in the multimap (`pair<const key, mapped>`).
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/hash_multimap/2constructor-086.adoc[`hash_multimap`]         [.small]#[constructor]#
| Constructors
| xref:bsl/hash_multimap/begin-011.adoc[`begin`] 
| `begin` overloads
| xref:bsl/hash_multimap/bucket_count.adoc[`bucket_count`] 
| Return the number of buckets in this container.
| xref:bsl/hash_multimap/clear.adoc[`clear`] 
| Remove all elements from this multimap.
| xref:bsl/hash_multimap/count.adoc[`count`] 
| Return the number of elements matching the specified key.
| xref:bsl/hash_multimap/elems_in_bucket.adoc[`elems_in_bucket`] 
| Return the number of elements in the specified bucket.
| xref:bsl/hash_multimap/empty.adoc[`empty`] 
| Return `true` if this multimap contains no elements.
| xref:bsl/hash_multimap/end-03.adoc[`end`] 
| `end` overloads
| xref:bsl/hash_multimap/equal_range-00.adoc[`equal_range`] 
| `equal_range` overloads
| xref:bsl/hash_multimap/erase-066.adoc[`erase`] 
| `erase` overloads
| xref:bsl/hash_multimap/find-05.adoc[`find`] 
| `find` overloads
| xref:bsl/hash_multimap/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this multimap.
| xref:bsl/hash_multimap/hash_funct.adoc[`hash_funct`] 
| Return the hash functor used by this multimap.
| xref:bsl/hash_multimap/insert-048.adoc[`insert`] 
| `insert` overloads
| xref:bsl/hash_multimap/insert_noresize.adoc[`insert_noresize`] 
| Insert `__obj` without resizing the bucket vector.
| xref:bsl/hash_multimap/key_eq.adoc[`key_eq`] 
| Return the key‐equality functor used by this multimap.
| xref:bsl/hash_multimap/max_bucket_count.adoc[`max_bucket_count`] 
| Return the maximum number of buckets this container can use.
| xref:bsl/hash_multimap/max_size.adoc[`max_size`] 
| Return an upper bound on the number of elements this multimap can hold.
| xref:bsl/hash_multimap/resize.adoc[`resize`] 
| Rebuild the bucket vector using a size suggested by the specified hint.
| xref:bsl/hash_multimap/size.adoc[`size`] 
| Return the number of elements in this multimap.
| xref:bsl/hash_multimap/swap.adoc[`swap`] 
| Exchange the contents of this multimap with those of the specified multimap.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/hash_multimap/_M_equal.adoc[`_M_equal`] 
| Return `true` if the specified multimaps contain the same elements.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/operator_not_eq-02b.adoc[`operator!=`]
| Return `true` if the specified hash multimaps do not contain the same elements.
| xref:bsl/operator_eq-0e6.adoc[`operator==`]
| Return `true` if the specified hash multimaps contain the same elements.
| xref:bsl/swap-046.adoc[`swap`]
| Exchange the contents of the specified hash multimaps.
|===


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