← Back to branch summary

~trond-norbye/libmemcached/fragment-read-write

« back to all changes in this revision

Viewing changes to docs/man/hashkit_functions.3

  • Committer: Brian Aker
  • Date: 2011-05-24 20:43:14 UTC
  • mfrom: (929.1.110 libmemcached-build)
  • Revision ID: brian@tangent.org-20110524204314-9ag1kkk4c1a6b3z3
Merge in local trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/hashkit_functions.3
1
 
.TH "HASHKIT_FUNCTIONS" "3" "April 14, 2011" "0.47" "libmemcached"
 
1
.TH "HASHKIT_FUNCTIONS" "3" "May 23, 2011" "0.47" "libmemcached"
2
2
.SH NAME
3
3
hashkit_functions \- libhashkit Documentation
4
4
.
32
32
.
33
33
.sp
34
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
35
.SH SYNOPSIS
39
36
.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
 
37
#include <libhashkit/hashkit.h>
 
38
.INDENT 0.0
 
39
.TP
 
40
.B uint32_t hashkit_default(const char *key, size_t key_length);
 
41
.UNINDENT
 
42
.INDENT 0.0
 
43
.TP
 
44
.B uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
 
45
.UNINDENT
 
46
.INDENT 0.0
 
47
.TP
 
48
.B uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
 
49
.UNINDENT
 
50
.INDENT 0.0
 
51
.TP
 
52
.B uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
 
53
.UNINDENT
 
54
.INDENT 0.0
 
55
.TP
 
56
.B uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
 
57
.UNINDENT
 
58
.INDENT 0.0
 
59
.TP
 
60
.B uint32_t hashkit_crc32(const char *key, size_t key_length);
 
61
.UNINDENT
 
62
.INDENT 0.0
 
63
.TP
 
64
.B uint32_t hashkit_hsieh(const char *key, size_t key_length);
 
65
.UNINDENT
 
66
.INDENT 0.0
 
67
.TP
 
68
.B uint32_t hashkit_murmur(const char *key, size_t key_length);
 
69
.UNINDENT
 
70
.INDENT 0.0
 
71
.TP
 
72
.B uint32_t hashkit_jenkins(const char *key, size_t key_length);
 
73
.UNINDENT
 
74
.INDENT 0.0
 
75
.TP
 
76
.B uint32_t hashkit_md5(const char *key, size_t key_length);
 
77
.UNINDENT
 
78
.sp
 
79
Compile and link with \-lhashkit
56
80
.SH DESCRIPTION
57
81
.sp
58
82
These functions generate hash values from a key using a variety of