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

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

== Synopsis

Declared in `<bslh_siphashalgorithm.h>`

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

== Type Aliases

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


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/SipHashAlgorithm/_04enum.adoc[`Unnamed enum`] 
| Compile‐time constants for the SipHash algorithm.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/SipHashAlgorithm/2constructor.adoc[`SipHashAlgorithm`]         [.small]#[constructor]#
| Create a `bslh::SipHashAlgorithm` seeded with the specified `seed`.
| xref:BloombergLP/bslh/SipHashAlgorithm/computeHash.adoc[`computeHash`] 
| Return the finalized hash value accumulated by this algorithm.
| xref:BloombergLP/bslh/SipHashAlgorithm/operator_call.adoc[`operator()`] 
| Incorporate the specified `data` of `numBytes` into the hash state.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslh/SipHashAlgorithm/d_alignment.adoc[`d_alignment`] [.small]#[variant member]#
| Ensures proper alignment for buffered data.
| xref:BloombergLP/bslh/SipHashAlgorithm/d_buf.adoc[`d_buf`] [.small]#[variant member]#
| Used to buffer data until we have enough to do a full round of computation as specified by the algorithm.
|===



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