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

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