[#BloombergLP-bslh-SeededHash]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslh.adoc[bslh]::SeededHash
:relfileprefix: ../../
:mrdocs:

This class wraps a seeded hash algorithm in a C++11‐compatible hash interface.

== Synopsis

Declared in `<bslh_seededhash.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class SEED_GENERATOR,
    class HASH_ALGORITHM = xref:BloombergLP/bslh/DefaultSeededHashAlgorithm.adoc[bslh::DefaultSeededHashAlgorithm]>
struct SeededHash;
----

== Description

This class wraps the (template parameter) `HASH_ALGORITHM`, which requires a seed, in an interface that satisfies the `hash` requirements of the C++11 standard. The (template parameter) type `SEED_GENERATOR` will be used to generate the seed required by `HASH_ALGORITHM`.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/SeededHash/result_type.adoc[`result_type`] 
| The type of the hash value that will be returned by the function‐call operator.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/SeededHash/2constructor-0e5.adoc[`SeededHash`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslh/SeededHash/operator_call.adoc[`operator()`] 
| Return a hash of the specified `type` using the seeded hash algorithm.
|===



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