git.m6w6.name Git - awesomized/libmemcached/blob - docs/source/libhashkit/hashkit_functions.rst

   1 Available Hashes
   2 ================
   3
   4 .. index:: object: hashkit_st
   5
   6 Various hash functions to use for calculating hash values for keys
   7
   8 SYNOPSIS
   9 --------
  10
  11 #include <libhashkit-|libhashkit_version|/hashkit.h>
  12   Compile and link with -lhashkit
  13
  14 .. function:: uint32_t hashkit_default(const char *key, size_t key_length)
  15
  16 .. function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)
  17
  18 .. function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)
  19
  20 .. function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)
  21
  22 .. function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)
  23
  24 .. function:: uint32_t hashkit_crc32(const char *key, size_t key_length)
  25
  26 .. function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)
  27
  28 .. function:: uint32_t hashkit_murmur(const char *key, size_t key_length)
  29
  30 .. function:: uint32_t hashkit_murmur3(const char *key, size_t key_length)
  31
  32 .. function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)
  33
  34 .. function:: uint32_t hashkit_md5(const char *key, size_t key_length)
  35
  36 DESCRIPTION
  37 -----------
  38
  39 These functions generate hash values from a key using a variety of
  40 algorithms. These functions can be used standalone, or as arguments
  41 to :func:`hashkit_set_hash_fn` or :func:`hashkit_set_continuum_hash_fn`.
  42
  43 The :func:`hashkit_hsieh` is only available if the library is built with
  44 the appropriate flag enabled.
  45
  46 RETURN VALUE
  47 ------------
  48
  49 A 32-bit hash value.
  50
  51 SEE ALSO
  52 --------
  53
  54 .. only:: man
  55
  56     :manpage:`libhashkit(3)`
  57     :manpage:`hashkit_create(3)`
  58     :manpage:`hashkit_function(3)`
  59
  60 .. only:: html
  61
  62     * :doc:`../libhashkit`
  63     * :doc:`hashkit_create`
  64     * :doc:`hashkit_function`
  65