X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_functions.rst;fp=docs%2Fhashkit_functions.rst;h=0000000000000000000000000000000000000000;hb=f2a59b728c20f7fe78874dd41187ab3fb2db6c7e;hp=4db416614ca4536eb7537126051da6251e792f66;hpb=dbc62573e1a6dc8cbcc97d0898e8615b0916d6ab;p=awesomized%2Flibmemcached diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst deleted file mode 100644 index 4db41661..00000000 --- a/docs/hashkit_functions.rst +++ /dev/null @@ -1,75 +0,0 @@ -================ -Available Hashes -================ - -.. index:: object: hashkit_st - -Various hash functions to use for calculating values for keys - - --------- -SYNOPSIS --------- - -#include - -.. 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/ `_ - - --------- -SEE ALSO --------- - - -:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)` -