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

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