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

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