[#SipHashState]
= SipHashState
:mrdocs:

Shared SipHash state (v0..v3) with its round, compression, and finalization primitives. Internal building block, only meant to be composed by the hasher classes below.

== Synopsis

Declared in `<crypto/siphash.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:SipHashState/2constructor-0d.adoc[`SipHashState`]         [.small]#[constructor]#
| Construct a SipHashState initialized with the specified key.
| xref:SipHashState/Compress1.adoc[`Compress1`] 
| Mutably compress one block into this state, with 1 SipRound.
| xref:SipHashState/Compress1Jumbo.adoc[`Compress1Jumbo`] 
| Mutably compress one jumbo block into this state, with 1 SipRound.
| xref:SipHashState/Compress2.adoc[`Compress2`] 
| Mutably compress one block into this state, with 2 SipRounds.
| xref:SipHashState/Copy.adoc[`Copy`] 
| Construct a copy of this state.
| xref:SipHashState/Finalize3U.adoc[`Finalize3U`] 
| Mutably finalize this state with 3 SipRounds using the unpadded finalizer, and return the resulting hash.
| xref:SipHashState/Finalize4.adoc[`Finalize4`] 
| Mutably finalize this state with 4 SipRounds, and return the resulting hash.
|===



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