xxHash  0.8.0
Extremely fast non-cryptographic hash function
Modules | Macros | Typedefs | Enumerations | Functions
Public API

Modules

 XXH32 family
 
 XXH64 family
 
 XXH3 family
 

Macros

#define XXH_PUBLIC_API   /* do nothing */
 
#define XXH_NAMESPACE   /* YOUR NAME HERE */
 Emulate a namespace by transparently prefixing all symbols. More...
 
#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)
 

Typedefs

typedef uint32_t XXH32_hash_t
 An unsigned 32-bit integer. More...
 

Enumerations

enum  XXH_errorcode { XXH_OK =0 , XXH_ERROR }
 

Functions

unsigned XXH_versionNumber (void)
 Obtains the xxHash version. More...
 
typedef uint64_t XXH64_hash_t
 An unsigned 64-bit integer. More...
 

Detailed Description

Contains details on the public xxHash functions.

Macro Definition Documentation

◆ XXH_NAMESPACE

#define XXH_NAMESPACE   /* YOUR NAME HERE */

Emulate a namespace by transparently prefixing all symbols.

If you want to include and expose xxHash functions from within your own library, but also want to avoid symbol collisions with other libraries which may also include xxHash, you can use XXH_NAMESPACE to automatically prefix any public symbol from xxhash library with the value of XXH_NAMESPACE (therefore, avoid empty or numeric values).

Note that no change is required within the calling program as long as it includes xxhash.h: Regular symbol names will be automatically translated by this header.

Typedef Documentation

◆ XXH32_hash_t

typedef uint32_t XXH32_hash_t

An unsigned 32-bit integer.

Not necessarily defined to uint32_t but functionally equivalent.

◆ XXH64_hash_t

typedef uint64_t XXH64_hash_t

An unsigned 64-bit integer.

Not necessarily defined to uint64_t but functionally equivalent.

Function Documentation

◆ XXH_versionNumber()

unsigned XXH_versionNumber ( void  )

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.