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

This class wraps an implementation of the "WyHash" hash algorithm in an interface that is usable in the modular hashing system in `bslh`.

== Synopsis

Declared in `<bslh_wyhashincrementalalgorithm.h>`

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

== Type Aliases

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


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/WyHashIncrementalAlgorithm/_04enum.adoc[`Unnamed enum`] 
| Length in bytes of the hash seed.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/WyHashIncrementalAlgorithm/2constructor-0c9f.adoc[`WyHashIncrementalAlgorithm`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bslh/WyHashIncrementalAlgorithm/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/WyHashIncrementalAlgorithm/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 value 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]#