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

   1 ================
   2 Available Hashes
   3 ================
   4
   5
   6 Various hash functions to use for calculating values for keys
   7
   8
   9 -------
  10 LIBRARY
  11 -------
  12
  13
  14 C Library for hashing algorithms (libmemcached, -lhashkit)
  15
  16
  17 --------
  18 SYNOPSIS
  19 --------
  20
  21
  22
  23 .. code-block:: perl
  24
  25    #include <libmemcached/hashkit.h>
  26
  27    uint32_t hashkit_default(const char *key, size_t key_length);
  28    uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
  29    uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
  30    uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
  31    uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
  32    uint32_t hashkit_crc32(const char *key, size_t key_length);
  33    uint32_t hashkit_hsieh(const char *key, size_t key_length);
  34    uint32_t hashkit_murmur(const char *key, size_t key_length);
  35    uint32_t hashkit_jenkins(const char *key, size_t key_length);
  36    uint32_t hashkit_md5(const char *key, size_t key_length);
  37
  38
  39
  40 -----------
  41 DESCRIPTION
  42 -----------
  43
  44
  45 These functions generate hash values from a key using a variety of
  46 algorithms. These functions can be used standalone, or as arguments
  47 to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
  48
  49 The hashkit_hsieh() is only available if the library is built with
  50 the appropriate flag enabled.
  51
  52
  53 ------------
  54 RETURN VALUE
  55 ------------
  56
  57
  58 A 32-bit hash value.
  59
  60
  61 ----
  62 HOME
  63 ----
  64
  65
  66 To find out more information please check:
  67 `http://libmemcached.org/ <http://libmemcached.org/>`_
  68
  69
  70 --------
  71 SEE ALSO
  72 --------
  73
  74
  75 hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)
  76 hashkit_set_continuum_hash_fn(3)
  77