~brianaker/libmemcached/1164440

« back to all changes in this revision

Viewing changes to docs/man/hashkit_murmur.3

Merging bzr://gaz.tangent.org/libmemcached/build/ to Build branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "HASHKIT_MURMUR" "3" "March 14, 2012" "1.0.5" "libmemcached"
 
2
.SH NAME
 
3
hashkit_murmur \- 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 SYNOPSIS
 
36
.sp
 
37
#include <libhashkit/hashkit.h>
 
38
.INDENT 0.0
 
39
.TP
 
40
.B uint32_t hashkit_default(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
41
.UNINDENT
 
42
.INDENT 0.0
 
43
.TP
 
44
.B uint32_t hashkit_fnv1_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
45
.UNINDENT
 
46
.INDENT 0.0
 
47
.TP
 
48
.B uint32_t hashkit_fnv1a_64(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
49
.UNINDENT
 
50
.INDENT 0.0
 
51
.TP
 
52
.B uint32_t hashkit_fnv1_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
53
.UNINDENT
 
54
.INDENT 0.0
 
55
.TP
 
56
.B uint32_t hashkit_fnv1a_32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
57
.UNINDENT
 
58
.INDENT 0.0
 
59
.TP
 
60
.B uint32_t hashkit_crc32(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
61
.UNINDENT
 
62
.INDENT 0.0
 
63
.TP
 
64
.B uint32_t hashkit_hsieh(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
65
.UNINDENT
 
66
.INDENT 0.0
 
67
.TP
 
68
.B uint32_t hashkit_murmur(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
69
.UNINDENT
 
70
.INDENT 0.0
 
71
.TP
 
72
.B uint32_t hashkit_jenkins(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
73
.UNINDENT
 
74
.INDENT 0.0
 
75
.TP
 
76
.B uint32_t hashkit_md5(const char\fI\ *key\fP, size_t\fI\ key_length\fP)
 
77
.UNINDENT
 
78
.sp
 
79
Compile and link with \-lhashkit
 
80
.SH DESCRIPTION
 
81
.sp
 
82
These functions generate hash values from a key using a variety of
 
83
algorithms. These functions can be used standalone, or as arguments
 
84
to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
 
85
.sp
 
86
The hashkit_hsieh is only available if the library is built with
 
87
the appropriate flag enabled.
 
88
.SH RETURN VALUE
 
89
.sp
 
90
A 32\-bit hash value.
 
91
.SH HOME
 
92
.sp
 
93
To find out more information please check:
 
94
\fI\%http://libmemcached.org/\fP
 
95
.SH SEE ALSO
 
96
.sp
 
97
\fIhashkit_create(3)\fP \fIhashkit_value(3)\fP \fIhashkit_set_hash_fn(3)\fP \fIhashkit_set_continuum_hash_fn(3)\fP
 
98
.SH AUTHOR
 
99
Brian Aker
 
100
.SH COPYRIGHT
 
101
2011, Brian Aker DataDifferential, http://datadifferential.com/
 
102
.\" Generated by docutils manpage writer.
 
103
.\" 
 
104
.