X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fhashkit_functions.rst;h=737171d4b54f10c3c5a40ea783cd8efcf48f86f5;hb=c6581942a9f3089c1d14e2cbc749d47a93247e78;hp=542fd95f6021a93a27cbc4e9d5127b95fcaabef9;hpb=281c398ba3a10af677494c4453cd09d85ca921e0;p=m6w6%2Flibmemcached diff --git a/docs/hashkit_functions.rst b/docs/hashkit_functions.rst index 542fd95f..737171d4 100644 --- a/docs/hashkit_functions.rst +++ b/docs/hashkit_functions.rst @@ -2,39 +2,38 @@ Available Hashes ================ +.. index:: object: hashkit_st Various hash functions to use for calculating values for keys -------- -LIBRARY -------- +-------- +SYNOPSIS +-------- +#include + +.. c:function:: uint32_t hashkit_default(const char *key, size_t key_length); -C Library for hashing algorithms (libmemcached, -lhashkit) +.. 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); --------- -SYNOPSIS --------- +.. 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); -.. code-block:: perl +.. c:function:: uint32_t hashkit_hsieh(const char *key, size_t key_length); - #include - - uint32_t hashkit_default(const char *key, size_t key_length); - uint32_t hashkit_fnv1_64(const char *key, size_t key_length); - uint32_t hashkit_fnv1a_64(const char *key, size_t key_length); - uint32_t hashkit_fnv1_32(const char *key, size_t key_length); - uint32_t hashkit_fnv1a_32(const char *key, size_t key_length); - uint32_t hashkit_crc32(const char *key, size_t key_length); - uint32_t hashkit_hsieh(const char *key, size_t key_length); - uint32_t hashkit_murmur(const char *key, size_t key_length); - uint32_t hashkit_jenkins(const char *key, size_t key_length); - uint32_t hashkit_md5(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 ----------- @@ -64,7 +63,7 @@ HOME To find out more information please check: -`https://launchpad.net/libmemcached `_ +`http://libmemcached.org/ `_ -------- @@ -72,6 +71,5 @@ SEE ALSO -------- -hashkit_create(3) hashkit_value(3) hashkit_set_hash_fn(3) -hashkit_set_continuum_hash_fn(3) +:manpage:`hashkit_create(3)` :manpage:`hashkit_value(3)` :manpage:`hashkit_set_hash_fn(3)` :manpage:`hashkit_set_continuum_hash_fn(3)`