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

Legacy STLPort hash container storing unique values.

== Synopsis

Declared in `<bslstp_hashset.h>`

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

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:bsl/hash_set/allocator_type.adoc[`allocator_type`] 
| Allocator type used by this set.
| xref:bsl/hash_set/const_iterator.adoc[`const_iterator`] 
| Iterator providing non‐modifiable access to elements.
| xref:bsl/hash_set/const_pointer.adoc[`const_pointer`] 
| Pointer to a non‐modifiable element.
| xref:bsl/hash_set/const_reference.adoc[`const_reference`] 
| Reference to a non‐modifiable element.
| xref:bsl/hash_set/difference_type.adoc[`difference_type`] 
| Signed integral type used for iterator distances.
| xref:bsl/hash_set/hasher.adoc[`hasher`] 
| Hash functor type.
| xref:bsl/hash_set/iterator.adoc[`iterator`] 
| Iterator type; identical to `const_iterator`.
| xref:bsl/hash_set/key_equal.adoc[`key_equal`] 
| Key‐equality functor type.
| xref:bsl/hash_set/key_type.adoc[`key_type`] 
| Key type used by this container.
| xref:bsl/hash_set/pointer.adoc[`pointer`] 
| Pointer to a modifiable element.
| xref:bsl/hash_set/reference.adoc[`reference`] 
| Reference to a modifiable element.
| xref:bsl/hash_set/size_type.adoc[`size_type`] 
| Unsigned integral type used for sizes.
| xref:bsl/hash_set/value_type.adoc[`value_type`] 
| Element type stored in the set.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/hash_set/2constructor-0ef.adoc[`hash_set`]         [.small]#[constructor]#
| Constructors
| xref:bsl/hash_set/begin.adoc[`begin`] 
| Return an iterator to the first element.
| xref:bsl/hash_set/bucket_count.adoc[`bucket_count`] 
| Return the number of buckets in this container.
| xref:bsl/hash_set/clear.adoc[`clear`] 
| Remove all elements from this set.
| xref:bsl/hash_set/count.adoc[`count`] 
| Return the number of elements matching the specified key.
| xref:bsl/hash_set/elems_in_bucket.adoc[`elems_in_bucket`] 
| Return the number of elements in the specified bucket.
| xref:bsl/hash_set/empty.adoc[`empty`] 
| Return `true` if this set contains no elements.
| xref:bsl/hash_set/end.adoc[`end`] 
| Return the past‐the‐end iterator for this set.
| xref:bsl/hash_set/equal_range.adoc[`equal_range`] 
| Return iterators delimiting all elements with the specified `__key`.
| xref:bsl/hash_set/erase-05.adoc[`erase`] 
| `erase` overloads
| xref:bsl/hash_set/find.adoc[`find`] 
| Return an iterator to an element with the specified `__key`, or `end`.
| xref:bsl/hash_set/get_allocator.adoc[`get_allocator`] 
| Return the allocator used by this set.
| xref:bsl/hash_set/hash_funct.adoc[`hash_funct`] 
| Return the hash functor used by this set.
| xref:bsl/hash_set/insert-07.adoc[`insert`] 
| `insert` overloads
| xref:bsl/hash_set/insert_noresize.adoc[`insert_noresize`] 
| Insert the specified `__obj` if no equivalent element exists.
| xref:bsl/hash_set/key_eq.adoc[`key_eq`] 
| Return the key‐equality functor used by this set.
| xref:bsl/hash_set/max_bucket_count.adoc[`max_bucket_count`] 
| Return the maximum number of buckets this container can use.
| xref:bsl/hash_set/max_size.adoc[`max_size`] 
| Return an upper bound on the number of elements this set can hold.
| xref:bsl/hash_set/resize.adoc[`resize`] 
| Rebuild the bucket vector using a size suggested by the specified hint.
| xref:bsl/hash_set/size.adoc[`size`] 
| Return the number of elements in this set.
| xref:bsl/hash_set/swap.adoc[`swap`] 
| Exchange the contents of this set with those of the specified set.
|===


== Static Member Functions

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


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:bsl/operator_not_eq-090e.adoc[`operator!=`]
| Return `true` if the specified hash sets do not contain the same elements.
| xref:bsl/operator_eq-017.adoc[`operator==`]
| Return `true` if the specified hash sets contain the same elements.
| xref:bsl/swap-075.adoc[`swap`]
| Exchange the contents of the specified hash sets.
|===


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