Fixed autoconf macros for cross compile
[awesomized/libmemcached] / docs / hashkit_functions.pod
1 =head1 NAME
2
3 hashkit_default, hashkit_fnv1_64, hashkit_fnv1a_64, hashkit_fnv1_32,
4 hashkit_fnv1a_32, hashkit_crc32, hashkit_hsieh, hashkit_murmur,
5 hashkit_jenkins, hashkit_md5 - Various hash functions to use for
6 calculating values for keys
7
8 =head1 LIBRARY
9
10 C Library for hashing algorithms (libhashkit, -lhashkit)
11
12 =head1 SYNOPSIS
13
14 #include <libhashkit/hashkit.h>
15
16 uint32_t hashkit_default(const char *key, size_t key_length);
17 uint32_t hashkit_fnv1_64(const char *key, size_t key_length);
18 uint32_t hashkit_fnv1a_64(const char *key, size_t key_length);
19 uint32_t hashkit_fnv1_32(const char *key, size_t key_length);
20 uint32_t hashkit_fnv1a_32(const char *key, size_t key_length);
21 uint32_t hashkit_crc32(const char *key, size_t key_length);
22 uint32_t hashkit_hsieh(const char *key, size_t key_length);
23 uint32_t hashkit_murmur(const char *key, size_t key_length);
24 uint32_t hashkit_jenkins(const char *key, size_t key_length);
25 uint32_t hashkit_md5(const char *key, size_t key_length);
26
27 =head1 DESCRIPTION
28
29 These functions generate hash values from a key using a variety of
30 algorithms. These functions can be used standalone, or as arguments
31 to hashkit_set_hash_fn(3) or hashkit_set_continuum_hash_fn(3).
32
33 The hashkit_hsieh() is only available if the library is built with
34 the appropriate flag enabled.
35
36 =head1 RETURN VALUE
37
38 A 32-bit hash value.
39
40 =head1 HOME
41
42 To find out more information please check:
43 L<https://launchpad.net/libmemcached>
44
45 =head1 AUTHOR
46
47 Brian Aker, E<lt>brian@tangent.orgE<gt>
48
49 =head1 SEE ALSO
50
51 hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3)
52 hashkit_set_continuum_hash_fn(3)
53
54 =cut