Public API » XXH64 family module

Contains functions used in the classic 64-bit xxHash algorithm.

Classes

struct XXH64_canonical_t

Typedefs

using XXH64_state_t = struct XXH64_state_s
The opaque state struct for the XXH64 streaming API.

Functions

auto XXH64(const void* input, size_t length, XXH64_hash_t seed) -> XXH_PUBLIC_API XXH64_hash_t
Calculates the 64-bit hash of input using xxHash64.
auto XXH64_createState(void) -> XXH_PUBLIC_API XXH64_state_t*
auto XXH64_freeState(XXH64_state_t* statePtr) -> XXH_PUBLIC_API XXH_errorcode
auto XXH64_copyState(XXH64_state_t* dst_state, const XXH64_state_t* src_state) -> XXH_PUBLIC_API void
auto XXH64_reset(XXH64_state_t* statePtr, XXH64_hash_t seed) -> XXH_PUBLIC_API XXH_errorcode
auto XXH64_update(XXH64_state_t* statePtr, const void* input, size_t length) -> XXH_PUBLIC_API XXH_errorcode
auto XXH64_digest(const XXH64_state_t* statePtr) -> XXH_PUBLIC_API XXH64_hash_t
auto XXH64_canonicalFromHash(XXH64_canonical_t* dst, XXH64_hash_t hash) -> XXH_PUBLIC_API void
auto XXH64_hashFromCanonical(const XXH64_canonical_t* src) -> XXH_PUBLIC_API XXH64_hash_t

Typedef documentation

typedef struct XXH64_state_s XXH64_state_t
#include <eckit/contrib/xxhash/xxhash.h>

The opaque state struct for the XXH64 streaming API.

Function documentation

XXH_PUBLIC_API XXH64_hash_t XXH64(const void* input, size_t length, XXH64_hash_t seed)
#include <eckit/contrib/xxhash/xxhash.h>

Calculates the 64-bit hash of input using xxHash64.

Parameters
input The block of data to be hashed, at least length bytes in size.
length The length of input, in bytes.
seed The 64-bit seed to alter the hash's output predictably.
Returns The calculated 64-bit hash.

This function usually runs faster on 64-bit systems, but slower on 32-bit systems (see benchmark).

XXH_PUBLIC_API XXH_errorcode XXH64_freeState(XXH64_state_t* statePtr)
#include <eckit/contrib/xxhash/xxhash.h>

XXH_PUBLIC_API void XXH64_copyState(XXH64_state_t* dst_state, const XXH64_state_t* src_state)
#include <eckit/contrib/xxhash/xxhash.h>

XXH_PUBLIC_API XXH_errorcode XXH64_reset(XXH64_state_t* statePtr, XXH64_hash_t seed)
#include <eckit/contrib/xxhash/xxhash.h>

XXH_PUBLIC_API XXH_errorcode XXH64_update(XXH64_state_t* statePtr, const void* input, size_t length)
#include <eckit/contrib/xxhash/xxhash.h>

XXH_PUBLIC_API XXH64_hash_t XXH64_digest(const XXH64_state_t* statePtr)
#include <eckit/contrib/xxhash/xxhash.h>

XXH_PUBLIC_API void XXH64_canonicalFromHash(XXH64_canonical_t* dst, XXH64_hash_t hash)
#include <eckit/contrib/xxhash/xxhash.h>

XXH_PUBLIC_API XXH64_hash_t XXH64_hashFromCanonical(const XXH64_canonical_t* src)
#include <eckit/contrib/xxhash/xxhash.h>