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 1.1.0 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
  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="../copyright.html">Copyright</a></li>
 105 </ul>
 106
 107
 108
 109         </div>
 110       </div>
 111     </nav>
 112
 113     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 114
 115
 116       <nav class="wy-nav-top" aria-label="top navigation">
 117
 118           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 119           <a href="../index.html">libmemcached</a>
 120
 121       </nav>
 122
 123
 124       <div class="wy-nav-content">
 125
 126         <div class="rst-content">
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144 <div role="navigation" aria-label="breadcrumbs navigation">
 145
 146   <ul class="wy-breadcrumbs">
 147
 148       <li><a href="../index.html">Docs</a> &raquo;</li>
 149
 150           <li><a href="index.html">libhashkit - C/C++ hashing library</a> &raquo;</li>
 151
 152       <li>Available Hashes</li>
 153
 154
 155       <li class="wy-breadcrumbs-aside">
 156
 157
 158
 159               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libhashkit/hashkit_functions.rst" class="fa fa-github"> Edit on GitHub</a>
 160
 161
 162
 163       </li>
 164
 165   </ul>
 166
 167
 168   <hr/>
 169 </div>
 170           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 171            <div itemprop="articleBody">
 172
 173   <div class="section" id="available-hashes">
 174 <h1>Available Hashes<a class="headerlink" href="#available-hashes" title="Permalink to this headline">¶</a></h1>
 175 <div class="section" id="synopsis">
 176 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 177 <dl class="docutils">
 178 <dt>#include &lt;libhashkit-<a href="#id1"><span class="problematic" id="id2">|libhashkit_version|</span></a>/hashkit.h&gt;</dt>
 179 <dd>Compile and link with -lhashkit</dd>
 180 </dl>
 181 <dl class="function">
 182 <dt id="_CPPv415hashkit_defaultPKc6size_t">
 183 <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>
 184 <dd></dd></dl>
 185
 186 <dl class="function">
 187 <dt id="_CPPv415hashkit_fnv1_64PKc6size_t">
 188 <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>
 189 <dd></dd></dl>
 190
 191 <dl class="function">
 192 <dt id="_CPPv416hashkit_fnv1a_64PKc6size_t">
 193 <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>
 194 <dd></dd></dl>
 195
 196 <dl class="function">
 197 <dt id="_CPPv415hashkit_fnv1_32PKc6size_t">
 198 <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>
 199 <dd></dd></dl>
 200
 201 <dl class="function">
 202 <dt id="_CPPv416hashkit_fnv1a_32PKc6size_t">
 203 <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>
 204 <dd></dd></dl>
 205
 206 <dl class="function">
 207 <dt id="_CPPv413hashkit_crc32PKc6size_t">
 208 <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>
 209 <dd></dd></dl>
 210
 211 <dl class="function">
 212 <dt id="_CPPv413hashkit_hsiehPKc6size_t">
 213 <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>
 214 <dd></dd></dl>
 215
 216 <dl class="function">
 217 <dt id="_CPPv414hashkit_murmurPKc6size_t">
 218 <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>
 219 <dd></dd></dl>
 220
 221 <dl class="function">
 222 <dt id="_CPPv415hashkit_murmur3PKc6size_t">
 223 <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>
 224 <dd></dd></dl>
 225
 226 <dl class="function">
 227 <dt id="_CPPv415hashkit_jenkinsPKc6size_t">
 228 <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>
 229 <dd></dd></dl>
 230
 231 <dl class="function">
 232 <dt id="_CPPv411hashkit_md5PKc6size_t">
 233 <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>
 234 <dd></dd></dl>
 235
 236 </div>
 237 <div class="section" id="description">
 238 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 239 <p>These functions generate hash values from a key using a variety of
 240 algorithms. These functions can be used standalone, or will be used
 241 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>
 242 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>
 243 <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
 244 only available if the library is built with the appropriate flag enabled.</p>
 245 </div>
 246 <div class="section" id="return-value">
 247 <h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
 248 <p>A 32-bit hash value.</p>
 249 </div>
 250 <div class="section" id="see-also">
 251 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 252 <ul class="simple">
 253 <li><a class="reference internal" href="index.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></li>
 254 <li><a class="reference internal" href="hashkit_create.html"><span class="doc">Creating a hashkit structure</span></a></li>
 255 <li><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></li>
 256 </ul>
 257 </div>
 258 </div>
 259
 260
 261            </div>
 262
 263           </div>
 264           <footer>
 265
 266     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 267
 268         <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>
 269
 270
 271         <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>
 272
 273     </div>
 274
 275
 276   <hr/>
 277
 278   <div role="contentinfo">
 279     <p>
 280         &copy; <a href="../copyright.html">Copyright</a>
 281
 282     </p>
 283   </div>
 284   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>.
 285
 286 </footer>
 287
 288         </div>
 289       </div>
 290
 291     </section>
 292
 293   </div>
 294
 295
 296
 297   <script type="text/javascript">
 298       jQuery(function () {
 299           SphinxRtdTheme.Navigation.enable(true);
 300       });
 301   </script>
 302
 303
 304
 305
 306
 307
 308 </body>
 309 </html>