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

This class wraps an unspecified default hashing algorithm that is appropriate for general purpose use such as generating hashes for a hash table.

== Synopsis

Declared in `<bslh_defaulthashalgorithm.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class DefaultHashAlgorithm;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/DefaultHashAlgorithm/result_type.adoc[`result_type`] 
| Typedef indicating the value type returned by this algorithm.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/DefaultHashAlgorithm/2constructor.adoc[`DefaultHashAlgorithm`]         [.small]#[constructor]#
| Create a `bslh::DefaultHashAlgorithm`, default constructing the algorithm being used internally.
| xref:BloombergLP/bslh/DefaultHashAlgorithm/computeHash.adoc[`computeHash`] 
| Return the finalized version of the hash that has been accumulated. Note that this changes the internal state of the object, so calling `computeHash()` multiple times in a row will return different results, and only the first result returned will match the expected result of the algorithm. Also note that a value will be returned, even if data has not been passed into `operator()`
| xref:BloombergLP/bslh/DefaultHashAlgorithm/operator_call.adoc[`operator()`] 
| Incorporate the specified `data`, of at least the specified `numBytes`, into the internal state of the hashing algorithm. Every bit of data incorporated into the internal state of the algorithm will contribute to the final hash produced by `computeHash()`. The same hash will be produced regardless of whether a sequence of bytes is passed in all at once or through multiple calls to this member function. Input where `numBytes` is 0 will have no effect on the internal state of the algorithm. The behaviour is undefined unless `data` points to a valid memory location with at least `numBytes` bytes of initialized memory or `numBytes` is zero.
|===



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