summaryrefslogtreecommitdiff
path: root/docs/source/hashkit_functions.rst
blob: 4db416614ca4536eb7537126051da6251e792f66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
================
Available Hashes
================

.. index:: object: hashkit_st

Various hash functions to use for calculating values for keys


--------
SYNOPSIS
--------

#include <libhashkit/hashkit.h>
 
.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_fnv1_64(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_fnv1a_64(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_fnv1_32(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_fnv1a_32(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_crc32(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_murmur(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_jenkins(const char *key, size_t key_length)

.. c:function:: uint32_t hashkit_md5(const char *key, size_t key_length)

Compile and link with -lhashkit


-----------
DESCRIPTION
-----------


These functions generate hash values from a key using a variety of
algorithms. These functions can be used standalone, or as arguments
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).

The hashkit_hsieh is only available if the library is built with
the appropriate flag enabled.


------------
RETURN VALUE
------------


A 32-bit hash value.


----
HOME
----


To find out more information please check:
`http://libmemcached.org/ <http://libmemcached.org/>`_


--------
SEE ALSO
--------


:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`