git.m6w6.name Git - awesomized/libmemcached/blob - libhashkit/hashkit_functions.html

   1
   2
   3 <!DOCTYPE html>
   4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
   5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
   6 <head>
   7   <meta charset="utf-8">
   8
   9   <meta name="viewport" content="width=device-width, initial-scale=1.0">
  10
  11   <title>Available Hashes &mdash; libmemcached-awesome 1.1.4 documentation</title>
  12
  13
  14
  15
  16
  17
  18
  19
  20   <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  21
  22
  23       <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
  24         <script type="text/javascript" src="../_static/jquery.js"></script>
  25         <script type="text/javascript" src="../_static/underscore.js"></script>
  26         <script type="text/javascript" src="../_static/doctools.js"></script>
  27         <script type="text/javascript" src="../_static/language_data.js"></script>
  28
  29     <script type="text/javascript" src="../_static/js/theme.js"></script>
  30
  31
  32
  33
  34   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  35   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  36     <link rel="index" title="Index" href="../genindex.html" />
  37     <link rel="search" title="Search" href="../search.html" />
  38     <link rel="copyright" title="Copyright" href="../copyright.html" />
  39     <link rel="next" title="Generate hash value" href="hashkit_value.html" />
  40     <link rel="prev" title="Set Hash Function" href="hashkit_function.html" />
  41 </head>
  42
  43 <body class="wy-body-for-nav">
  44
  45
  46   <div class="wy-grid-for-nav">
  47
  48     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  49       <div class="wy-side-scroll">
  50         <div class="wy-side-nav-search" >
  51
  52
  53
  54             <a href="../index.html" class="icon icon-home"> libmemcached-awesome
  55
  56
  57
  58           </a>
  59
  60
  61
  62
  63               <div class="version">
  64                 1.1
  65               </div>
  66
  67
  68
  69
  70 <div role="search">
  71   <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  72     <input type="text" name="q" placeholder="Search docs" />
  73     <input type="hidden" name="check_keywords" value="yes" />
  74     <input type="hidden" name="area" value="default" />
  75   </form>
  76 </div>
  77
  78
  79         </div>
  80
  81         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  82
  83
  84
  85
  86
  87
  88               <ul class="current">
  89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
  90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
  91 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
  92 <li class="toctree-l1 current"><a class="reference internal" href="index.html">libhashkit API</a><ul class="current">
  93 <li class="toctree-l2"><a class="reference internal" href="hashkit_create.html">Creating a hashkit structure</a></li>
  94 <li class="toctree-l2"><a class="reference internal" href="hashkit_function.html">Set Hash Function</a></li>
  95 <li class="toctree-l2 current"><a class="current reference internal" href="#">Available Hashes</a></li>
  96 <li class="toctree-l2"><a class="reference internal" href="hashkit_value.html">Generate hash value</a></li>
  97 </ul>
  98 </li>
  99 <li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
 100 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
 101 </ul>
 102 <ul>
 103 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
 104 <li class="toctree-l1"><a class="reference internal" href="../issues.html">Known issues</a></li>
 105 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
 106 </ul>
 107
 108
 109
 110         </div>
 111       </div>
 112     </nav>
 113
 114     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 115
 116
 117       <nav class="wy-nav-top" aria-label="top navigation">
 118
 119           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 120           <a href="../index.html">libmemcached-awesome</a>
 121
 122       </nav>
 123
 124
 125       <div class="wy-nav-content">
 126
 127         <div class="rst-content">
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145 <div role="navigation" aria-label="breadcrumbs navigation">
 146
 147   <ul class="wy-breadcrumbs">
 148
 149       <li><a href="../index.html">Docs</a> &raquo;</li>
 150
 151           <li><a href="index.html">libhashkit - C/C++ hashing library</a> &raquo;</li>
 152
 153       <li>Available Hashes</li>
 154
 155
 156       <li class="wy-breadcrumbs-aside">
 157
 158
 159
 160               <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/libhashkit/hashkit_functions.rst" class="fa fa-github"> Edit on GitHub</a>
 161
 162
 163
 164       </li>
 165
 166   </ul>
 167
 168
 169   <hr/>
 170 </div>
 171           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 172            <div itemprop="articleBody">
 173
 174   <div class="section" id="available-hashes">
 175 <h1>Available Hashes<a class="headerlink" href="#available-hashes" title="Permalink to this headline">¶</a></h1>
 176 <div class="section" id="synopsis">
 177 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 178 <dl class="docutils">
 179 <dt>#include &lt;libhashkit-1.0/hashkit.h&gt;</dt>
 180 <dd>Compile and link with -lhashkit</dd>
 181 </dl>
 182 <dl class="function">
 183 <dt id="_CPPv415hashkit_defaultPKc6size_t">
 184 <span id="_CPPv315hashkit_defaultPKc6size_t"></span><span id="_CPPv215hashkit_defaultPKc6size_t"></span><span id="hashkit_default__cCP.s"></span>uint32_t <code class="descname">hashkit_default</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415hashkit_defaultPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 185 <dd></dd></dl>
 186
 187 <dl class="function">
 188 <dt id="_CPPv415hashkit_fnv1_64PKc6size_t">
 189 <span id="_CPPv315hashkit_fnv1_64PKc6size_t"></span><span id="_CPPv215hashkit_fnv1_64PKc6size_t"></span><span id="hashkit_fnv1_64__cCP.s"></span>uint32_t <code class="descname">hashkit_fnv1_64</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415hashkit_fnv1_64PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 190 <dd></dd></dl>
 191
 192 <dl class="function">
 193 <dt id="_CPPv416hashkit_fnv1a_64PKc6size_t">
 194 <span id="_CPPv316hashkit_fnv1a_64PKc6size_t"></span><span id="_CPPv216hashkit_fnv1a_64PKc6size_t"></span><span id="hashkit_fnv1a_64__cCP.s"></span>uint32_t <code class="descname">hashkit_fnv1a_64</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416hashkit_fnv1a_64PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 195 <dd></dd></dl>
 196
 197 <dl class="function">
 198 <dt id="_CPPv415hashkit_fnv1_32PKc6size_t">
 199 <span id="_CPPv315hashkit_fnv1_32PKc6size_t"></span><span id="_CPPv215hashkit_fnv1_32PKc6size_t"></span><span id="hashkit_fnv1_32__cCP.s"></span>uint32_t <code class="descname">hashkit_fnv1_32</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415hashkit_fnv1_32PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 200 <dd></dd></dl>
 201
 202 <dl class="function">
 203 <dt id="_CPPv416hashkit_fnv1a_32PKc6size_t">
 204 <span id="_CPPv316hashkit_fnv1a_32PKc6size_t"></span><span id="_CPPv216hashkit_fnv1a_32PKc6size_t"></span><span id="hashkit_fnv1a_32__cCP.s"></span>uint32_t <code class="descname">hashkit_fnv1a_32</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv416hashkit_fnv1a_32PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 205 <dd></dd></dl>
 206
 207 <dl class="function">
 208 <dt id="_CPPv413hashkit_crc32PKc6size_t">
 209 <span id="_CPPv313hashkit_crc32PKc6size_t"></span><span id="_CPPv213hashkit_crc32PKc6size_t"></span><span id="hashkit_crc32__cCP.s"></span>uint32_t <code class="descname">hashkit_crc32</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_crc32PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 210 <dd></dd></dl>
 211
 212 <dl class="function">
 213 <dt id="_CPPv413hashkit_hsiehPKc6size_t">
 214 <span id="_CPPv313hashkit_hsiehPKc6size_t"></span><span id="_CPPv213hashkit_hsiehPKc6size_t"></span><span id="hashkit_hsieh__cCP.s"></span>uint32_t <code class="descname">hashkit_hsieh</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_hsiehPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 215 <dd></dd></dl>
 216
 217 <dl class="function">
 218 <dt id="_CPPv414hashkit_murmurPKc6size_t">
 219 <span id="_CPPv314hashkit_murmurPKc6size_t"></span><span id="_CPPv214hashkit_murmurPKc6size_t"></span><span id="hashkit_murmur__cCP.s"></span>uint32_t <code class="descname">hashkit_murmur</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414hashkit_murmurPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 220 <dd></dd></dl>
 221
 222 <dl class="function">
 223 <dt id="_CPPv415hashkit_murmur3PKc6size_t">
 224 <span id="_CPPv315hashkit_murmur3PKc6size_t"></span><span id="_CPPv215hashkit_murmur3PKc6size_t"></span><span id="hashkit_murmur3__cCP.s"></span>uint32_t <code class="descname">hashkit_murmur3</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415hashkit_murmur3PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 225 <dd></dd></dl>
 226
 227 <dl class="function">
 228 <dt id="_CPPv415hashkit_jenkinsPKc6size_t">
 229 <span id="_CPPv315hashkit_jenkinsPKc6size_t"></span><span id="_CPPv215hashkit_jenkinsPKc6size_t"></span><span id="hashkit_jenkins__cCP.s"></span>uint32_t <code class="descname">hashkit_jenkins</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415hashkit_jenkinsPKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 230 <dd></dd></dl>
 231
 232 <dl class="function">
 233 <dt id="_CPPv411hashkit_md5PKc6size_t">
 234 <span id="_CPPv311hashkit_md5PKc6size_t"></span><span id="_CPPv211hashkit_md5PKc6size_t"></span><span id="hashkit_md5__cCP.s"></span>uint32_t <code class="descname">hashkit_md5</code><span class="sig-paren">(</span><em class="property">const</em> char *<em>key</em>, size_t <em>key_length</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411hashkit_md5PKc6size_t" title="Permalink to this definition">¶</a><br /></dt>
 235 <dd></dd></dl>
 236
 237 </div>
 238 <div class="section" id="description">
 239 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 240 <p>These functions generate hash values from a key using a variety of
 241 algorithms. These functions can be used standalone, or will be used
 242 according to the algorithm set with <a class="reference internal" href="hashkit_function.html#_CPPv420hashkit_set_functionP10hashkit_st24hashkit_hash_algorithm_t" title="hashkit_set_function"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_set_function()</span></code></a>
 243 or <a class="reference internal" href="hashkit_function.html#_CPPv433hashkit_set_distribution_functionP10hashkit_st24hashkit_hash_algorithm_t" title="hashkit_set_distribution_function"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_set_distribution_function()</span></code></a>.</p>
 244 <p>The <a class="reference internal" href="#_CPPv413hashkit_hsiehPKc6size_t" title="hashkit_hsieh"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_hsieh()</span></code></a>, <a class="reference internal" href="#_CPPv414hashkit_murmurPKc6size_t" title="hashkit_murmur"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_murmur()</span></code></a> and <a class="reference internal" href="#_CPPv415hashkit_murmur3PKc6size_t" title="hashkit_murmur3"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_murmur3()</span></code></a> functions are
 245 only available if the library is built with the appropriate flag enabled.</p>
 246 </div>
 247 <div class="section" id="return-value">
 248 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 249 <p>A 32-bit hash value.</p>
 250 </div>
 251 <div class="section" id="see-also">
 252 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 253 <ul class="simple">
 254 <li><a class="reference internal" href="index.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></li>
 255 <li><a class="reference internal" href="hashkit_create.html"><span class="doc">Creating a hashkit structure</span></a></li>
 256 <li><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></li>
 257 </ul>
 258 </div>
 259 </div>
 260
 261
 262            </div>
 263
 264           </div>
 265           <footer>
 266
 267     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 268
 269         <a href="hashkit_value.html" class="btn btn-neutral float-right" title="Generate hash value" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 270
 271
 272         <a href="hashkit_function.html" class="btn btn-neutral float-left" title="Set Hash Function" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 273
 274     </div>
 275
 276
 277   <hr/>
 278
 279   <div role="contentinfo">
 280     <p>
 281         &copy; <a href="../copyright.html">Copyright</a>
 282
 283     </p>
 284   </div>
 285   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 286
 287 </footer>
 288
 289         </div>
 290       </div>
 291
 292     </section>
 293
 294   </div>
 295
 296
 297
 298   <script type="text/javascript">
 299       jQuery(function () {
 300           SphinxRtdTheme.Navigation.enable(true);
 301       });
 302   </script>
 303
 304
 305
 306
 307
 308
 309 </body>
 310 </html>