Merge in code for C++ compiling of libmemcached.
[awesomized/libmemcached] / docs / man / hashkit_hsieh.3
1 .TH "HASHKIT_HSIEH" "3" "April 14, 2011" "0.47" "libmemcached"
2 .SH NAME
3 hashkit_hsieh \- libhashkit Documentation
4 .
5 .nr rst2man-indent-level 0
6 .
7 .de1 rstReportMargin
8 \\$1 \\n[an-margin]
9 level \\n[rst2man-indent-level]
10 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
11 -
12 \\n[rst2man-indent0]
13 \\n[rst2man-indent1]
14 \\n[rst2man-indent2]
15 ..
16 .de1 INDENT
17 .\" .rstReportMargin pre:
18 . RS \\$1
19 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
20 . nr rst2man-indent-level +1
21 .\" .rstReportMargin post:
22 ..
23 .de UNINDENT
24 . RE
25 .\" indent \\n[an-margin]
26 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
27 .nr rst2man-indent-level -1
28 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
29 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
30 ..
31 .\" Man page generated from reStructeredText.
32 .
33 .sp
34 Various hash functions to use for calculating values for keys
35 .SH LIBRARY
36 .sp
37 C Library for hashing algorithms (libmemcached, \-lhashkit)
38 .SH SYNOPSIS
39 .sp
40 .nf
41 .ft C
42 #include <libmemcached/hashkit.h>
43
44 uint32_t hashkit_default(const char *key, size_t key_length);
45 uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
46 uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
47 uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
48 uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
49 uint32_t hashkit_crc32(const char *key, size_t key_length);
50 uint32_t hashkit_hsieh(const char *key, size_t key_length);
51 uint32_t hashkit_murmur(const char *key, size_t key_length);
52 uint32_t hashkit_jenkins(const char *key, size_t key_length);
53 uint32_t hashkit_md5(const char *key, size_t key_length);
54 .ft P
55 .fi
56 .SH DESCRIPTION
57 .sp
58 These functions generate hash values from a key using a variety of
59 algorithms. These functions can be used standalone, or as arguments
60 to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
61 .sp
62 The hashkit_hsieh() is only available if the library is built with
63 the appropriate flag enabled.
64 .SH RETURN VALUE
65 .sp
66 A 32\-bit hash value.
67 .SH HOME
68 .sp
69 To find out more information please check:
70 \fI\%http://libmemcached.org/\fP
71 .SH SEE ALSO
72 .sp
73 hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)
74 hashkit_set_continuum_hash_fn(3)
75 .SH AUTHOR
76 Brian Aker
77 .SH COPYRIGHT
78 2011, Brian Aker DataDifferential, http://datadifferential.com/
79 .\" Generated by docutils manpage writer.
80 .\"
81 .