Conscience Core
Modules | Macros | Enumerations
Public API

Contains details on the public xxHash functions. More...

Modules

 XXH32 family
 
 XXH64 family
 

Macros

#define XXH_versionNumber(void)   XXH_NAME2(XXH_NAMESPACE, XXH_versionNumber)
 Obtains the xxHash version. More...
 
#define XXH_CAT(A, B)   A##B
 
#define XXH_NAME2(A, B)   XXH_CAT(A,B)
 
#define XXH32   XXH_NAME2(XXH_NAMESPACE, XXH32)
 
#define XXH32_freeState   XXH_NAME2(XXH_NAMESPACE, XXH32_freeState)
 
#define XXH32_reset   XXH_NAME2(XXH_NAMESPACE, XXH32_reset)
 
#define XXH32_update   XXH_NAME2(XXH_NAMESPACE, XXH32_update)
 
#define XXH32_digest   XXH_NAME2(XXH_NAMESPACE, XXH32_digest)
 
#define XXH32_copyState   XXH_NAME2(XXH_NAMESPACE, XXH32_copyState)
 
#define XXH32_canonicalFromHash   XXH_NAME2(XXH_NAMESPACE, XXH32_canonicalFromHash)
 
#define XXH32_hashFromCanonical   XXH_NAME2(XXH_NAMESPACE, XXH32_hashFromCanonical)
 
#define XXH64   XXH_NAME2(XXH_NAMESPACE, XXH64)
 
#define XXH64_freeState   XXH_NAME2(XXH_NAMESPACE, XXH64_freeState)
 
#define XXH64_reset   XXH_NAME2(XXH_NAMESPACE, XXH64_reset)
 
#define XXH64_update   XXH_NAME2(XXH_NAMESPACE, XXH64_update)
 
#define XXH64_digest   XXH_NAME2(XXH_NAMESPACE, XXH64_digest)
 
#define XXH64_copyState   XXH_NAME2(XXH_NAMESPACE, XXH64_copyState)
 
#define XXH64_canonicalFromHash   XXH_NAME2(XXH_NAMESPACE, XXH64_canonicalFromHash)
 
#define XXH64_hashFromCanonical   XXH_NAME2(XXH_NAMESPACE, XXH64_hashFromCanonical)
 
#define XXH3_64bits   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits)
 
#define XXH3_64bits_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecret)
 
#define XXH3_64bits_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSeed)
 
#define XXH3_64bits_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecretandSeed)
 
#define XXH3_createState   XXH_NAME2(XXH_NAMESPACE, XXH3_createState)
 
#define XXH3_freeState   XXH_NAME2(XXH_NAMESPACE, XXH3_freeState)
 
#define XXH3_copyState   XXH_NAME2(XXH_NAMESPACE, XXH3_copyState)
 
#define XXH3_64bits_reset   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset)
 
#define XXH3_64bits_reset_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSeed)
 
#define XXH3_64bits_reset_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecret)
 
#define XXH3_64bits_reset_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecretandSeed)
 
#define XXH3_64bits_update   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_update)
 
#define XXH3_64bits_digest   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_digest)
 
#define XXH3_generateSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret)
 
#define XXH3_generateSecret_fromSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret_fromSeed)
 
#define XXH128   XXH_NAME2(XXH_NAMESPACE, XXH128)
 
#define XXH3_128bits   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits)
 
#define XXH3_128bits_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSeed)
 
#define XXH3_128bits_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecret)
 
#define XXH3_128bits_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecretandSeed)
 
#define XXH3_128bits_reset   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset)
 
#define XXH3_128bits_reset_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSeed)
 
#define XXH3_128bits_reset_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecret)
 
#define XXH3_128bits_reset_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecretandSeed)
 
#define XXH3_128bits_update   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_update)
 
#define XXH3_128bits_digest   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_digest)
 
#define XXH128_isEqual   XXH_NAME2(XXH_NAMESPACE, XXH128_isEqual)
 
#define XXH128_cmp   XXH_NAME2(XXH_NAMESPACE, XXH128_cmp)
 
#define XXH128_canonicalFromHash   XXH_NAME2(XXH_NAMESPACE, XXH128_canonicalFromHash)
 
#define XXH128_hashFromCanonical   XXH_NAME2(XXH_NAMESPACE, XXH128_hashFromCanonical)
 
#define XXH_VERSION_MAJOR   0
 
#define XXH_VERSION_MINOR   8
 
#define XXH_VERSION_RELEASE   1
 
#define XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)
 

Enumerations

enum  XXH_errorcode { XXH_OK =0, XXH_ERROR }
 
typedef unsigned long long XXH64_hash_t
 

Detailed Description

Contains details on the public xxHash functions.

Macro Definition Documentation

◆ XXH128

#define XXH128   XXH_NAME2(XXH_NAMESPACE, XXH128)

◆ XXH128_canonicalFromHash

#define XXH128_canonicalFromHash   XXH_NAME2(XXH_NAMESPACE, XXH128_canonicalFromHash)

◆ XXH128_cmp

#define XXH128_cmp   XXH_NAME2(XXH_NAMESPACE, XXH128_cmp)

◆ XXH128_hashFromCanonical

#define XXH128_hashFromCanonical   XXH_NAME2(XXH_NAMESPACE, XXH128_hashFromCanonical)

◆ XXH128_isEqual

#define XXH128_isEqual   XXH_NAME2(XXH_NAMESPACE, XXH128_isEqual)

◆ XXH32

#define XXH32   XXH_NAME2(XXH_NAMESPACE, XXH32)

◆ XXH32_canonicalFromHash

#define XXH32_canonicalFromHash   XXH_NAME2(XXH_NAMESPACE, XXH32_canonicalFromHash)

◆ XXH32_copyState

#define XXH32_copyState   XXH_NAME2(XXH_NAMESPACE, XXH32_copyState)

◆ XXH32_digest

#define XXH32_digest   XXH_NAME2(XXH_NAMESPACE, XXH32_digest)

◆ XXH32_freeState

#define XXH32_freeState   XXH_NAME2(XXH_NAMESPACE, XXH32_freeState)

◆ XXH32_hashFromCanonical

#define XXH32_hashFromCanonical   XXH_NAME2(XXH_NAMESPACE, XXH32_hashFromCanonical)

◆ XXH32_reset

#define XXH32_reset   XXH_NAME2(XXH_NAMESPACE, XXH32_reset)

◆ XXH32_update

#define XXH32_update   XXH_NAME2(XXH_NAMESPACE, XXH32_update)

◆ XXH3_128bits

#define XXH3_128bits   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits)

◆ XXH3_128bits_digest

#define XXH3_128bits_digest   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_digest)

◆ XXH3_128bits_reset

#define XXH3_128bits_reset   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset)

◆ XXH3_128bits_reset_withSecret

#define XXH3_128bits_reset_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecret)

◆ XXH3_128bits_reset_withSecretandSeed

#define XXH3_128bits_reset_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSecretandSeed)

◆ XXH3_128bits_reset_withSeed

#define XXH3_128bits_reset_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_reset_withSeed)

◆ XXH3_128bits_update

#define XXH3_128bits_update   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_update)

◆ XXH3_128bits_withSecret

#define XXH3_128bits_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecret)

◆ XXH3_128bits_withSecretandSeed

#define XXH3_128bits_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSecretandSeed)

◆ XXH3_128bits_withSeed

#define XXH3_128bits_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_128bits_withSeed)

◆ XXH3_64bits

#define XXH3_64bits   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits)

◆ XXH3_64bits_digest

#define XXH3_64bits_digest   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_digest)

◆ XXH3_64bits_reset

#define XXH3_64bits_reset   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset)

◆ XXH3_64bits_reset_withSecret

#define XXH3_64bits_reset_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecret)

◆ XXH3_64bits_reset_withSecretandSeed

#define XXH3_64bits_reset_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSecretandSeed)

◆ XXH3_64bits_reset_withSeed

#define XXH3_64bits_reset_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_reset_withSeed)

◆ XXH3_64bits_update

#define XXH3_64bits_update   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_update)

◆ XXH3_64bits_withSecret

#define XXH3_64bits_withSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecret)

◆ XXH3_64bits_withSecretandSeed

#define XXH3_64bits_withSecretandSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSecretandSeed)

◆ XXH3_64bits_withSeed

#define XXH3_64bits_withSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_64bits_withSeed)

◆ XXH3_copyState

#define XXH3_copyState   XXH_NAME2(XXH_NAMESPACE, XXH3_copyState)

◆ XXH3_createState

#define XXH3_createState   XXH_NAME2(XXH_NAMESPACE, XXH3_createState)

◆ XXH3_freeState

#define XXH3_freeState   XXH_NAME2(XXH_NAMESPACE, XXH3_freeState)

◆ XXH3_generateSecret

#define XXH3_generateSecret   XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret)

◆ XXH3_generateSecret_fromSeed

#define XXH3_generateSecret_fromSeed   XXH_NAME2(XXH_NAMESPACE, XXH3_generateSecret_fromSeed)

◆ XXH64

#define XXH64   XXH_NAME2(XXH_NAMESPACE, XXH64)

◆ XXH64_canonicalFromHash

#define XXH64_canonicalFromHash   XXH_NAME2(XXH_NAMESPACE, XXH64_canonicalFromHash)

◆ XXH64_copyState

#define XXH64_copyState   XXH_NAME2(XXH_NAMESPACE, XXH64_copyState)

◆ XXH64_digest

#define XXH64_digest   XXH_NAME2(XXH_NAMESPACE, XXH64_digest)

◆ XXH64_freeState

#define XXH64_freeState   XXH_NAME2(XXH_NAMESPACE, XXH64_freeState)

◆ XXH64_hashFromCanonical

#define XXH64_hashFromCanonical   XXH_NAME2(XXH_NAMESPACE, XXH64_hashFromCanonical)

◆ XXH64_reset

#define XXH64_reset   XXH_NAME2(XXH_NAMESPACE, XXH64_reset)

◆ XXH64_update

#define XXH64_update   XXH_NAME2(XXH_NAMESPACE, XXH64_update)

◆ XXH_CAT

#define XXH_CAT (   A,
  B 
)    A##B

◆ XXH_NAME2

#define XXH_NAME2 (   A,
  B 
)    XXH_CAT(A,B)

◆ XXH_VERSION_MAJOR

#define XXH_VERSION_MAJOR   0

◆ XXH_VERSION_MINOR

#define XXH_VERSION_MINOR   8

◆ XXH_VERSION_NUMBER

#define XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)

◆ XXH_VERSION_RELEASE

#define XXH_VERSION_RELEASE   1

◆ XXH_versionNumber

XXH_PUBLIC_API unsigned XXH_versionNumber   XXH_NAME2(XXH_NAMESPACE, XXH_versionNumber)

Obtains the xxHash version.

This is mostly useful when xxHash is compiled as a shared library, since the returned value comes from the library, as opposed to header file.

Returns
XXH_VERSION_NUMBER of the invoked library.

Typedef Documentation

◆ XXH64_hash_t

typedef unsigned long long XXH64_hash_t

Enumeration Type Documentation

◆ XXH_errorcode

Enumerator
XXH_OK 
XXH_ERROR