<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="previous" href="GraphicsX11.html"> <link rel="next" href="Int32.html"> <link rel="Up" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Index of module types" rel=Appendix href="index_module_types.html"> <link title="Arg" rel="Chapter" href="Arg.html"> <link title="Arith_status" rel="Chapter" href="Arith_status.html"> <link title="Array" rel="Chapter" href="Array.html"> <link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html"> <link title="Big_int" rel="Chapter" href="Big_int.html"> <link title="Bigarray" rel="Chapter" href="Bigarray.html"> <link title="Buffer" rel="Chapter" href="Buffer.html"> <link title="Bytes" rel="Chapter" href="Bytes.html"> <link title="BytesLabels" rel="Chapter" href="BytesLabels.html"> <link title="Callback" rel="Chapter" href="Callback.html"> <link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html"> <link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html"> <link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html"> <link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html"> <link title="Char" rel="Chapter" href="Char.html"> <link title="Complex" rel="Chapter" href="Complex.html"> <link title="Condition" rel="Chapter" href="Condition.html"> <link title="Digest" rel="Chapter" href="Digest.html"> <link title="Dynlink" rel="Chapter" href="Dynlink.html"> <link title="Event" rel="Chapter" href="Event.html"> <link title="Filename" rel="Chapter" href="Filename.html"> <link title="Format" rel="Chapter" href="Format.html"> <link title="Gc" rel="Chapter" href="Gc.html"> <link title="Genlex" rel="Chapter" href="Genlex.html"> <link title="Graphics" rel="Chapter" href="Graphics.html"> <link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html"> <link title="Hashtbl" rel="Chapter" href="Hashtbl.html"> <link title="Int32" rel="Chapter" href="Int32.html"> <link title="Int64" rel="Chapter" href="Int64.html"> <link title="Lazy" rel="Chapter" href="Lazy.html"> <link title="Lexing" rel="Chapter" href="Lexing.html"> <link title="List" rel="Chapter" href="List.html"> <link title="ListLabels" rel="Chapter" href="ListLabels.html"> <link title="Map" rel="Chapter" href="Map.html"> <link title="Marshal" rel="Chapter" href="Marshal.html"> <link title="MoreLabels" rel="Chapter" href="MoreLabels.html"> <link title="Mutex" rel="Chapter" href="Mutex.html"> <link title="Nativeint" rel="Chapter" href="Nativeint.html"> <link title="Num" rel="Chapter" href="Num.html"> <link title="Obj" rel="Chapter" href="Obj.html"> <link title="Oo" rel="Chapter" href="Oo.html"> <link title="Parsing" rel="Chapter" href="Parsing.html"> <link title="Pervasives" rel="Chapter" href="Pervasives.html"> <link title="Printexc" rel="Chapter" href="Printexc.html"> <link title="Printf" rel="Chapter" href="Printf.html"> <link title="Queue" rel="Chapter" href="Queue.html"> <link title="Random" rel="Chapter" href="Random.html"> <link title="Ratio" rel="Chapter" href="Ratio.html"> <link title="Scanf" rel="Chapter" href="Scanf.html"> <link title="Set" rel="Chapter" href="Set.html"> <link title="Sort" rel="Chapter" href="Sort.html"> <link title="Stack" rel="Chapter" href="Stack.html"> <link title="StdLabels" rel="Chapter" href="StdLabels.html"> <link title="Str" rel="Chapter" href="Str.html"> <link title="Stream" rel="Chapter" href="Stream.html"> <link title="String" rel="Chapter" href="String.html"> <link title="StringLabels" rel="Chapter" href="StringLabels.html"> <link title="Sys" rel="Chapter" href="Sys.html"> <link title="Thread" rel="Chapter" href="Thread.html"> <link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html"> <link title="Unix" rel="Chapter" href="Unix.html"> <link title="UnixLabels" rel="Chapter" href="UnixLabels.html"> <link title="Weak" rel="Chapter" href="Weak.html"><link title="Generic interface" rel="Section" href="#6_Genericinterface"> <link title="Functorial interface" rel="Section" href="#6_Functorialinterface"> <link title="The polymorphic hash functions" rel="Section" href="#6_Thepolymorphichashfunctions"> <title>Hashtbl</title> </head> <body> <div class="navbar"><a class="pre" href="GraphicsX11.html" title="GraphicsX11">Previous</a> <a class="up" href="index.html" title="Index">Up</a> <a class="post" href="Int32.html" title="Int32">Next</a> </div> <h1>Module <a href="type_Hashtbl.html">Hashtbl</a></h1> <pre><span class="keyword">module</span> Hashtbl: <code class="code"><span class="keyword">sig</span></code> <a href="Hashtbl.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top"> Hash tables and hash functions. <p> Hash tables are hashed association tables, with in-place modification.<br> </div> <hr width="100%"> <br> <h6 id="6_Genericinterface">Generic interface</h6><br> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">('a, 'b)</code> t</span> </pre> <div class="info "> The type of hash tables from type <code class="code"><span class="keywordsign">'</span>a</code> to type <code class="code"><span class="keywordsign">'</span>b</code>.<br> </div> <pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">?random:bool -> int -> ('a, 'b) <a href="Hashtbl.html#TYPEt">t</a></code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.create n</code> creates a new, empty hash table, with initial size <code class="code">n</code>. For best results, <code class="code">n</code> should be on the order of the expected number of elements that will be in the table. The table grows as needed, so <code class="code">n</code> is just an initial guess. <p> The optional <code class="code">random</code> parameter (a boolean) controls whether the internal organization of the hash table is randomized at each execution of <code class="code"><span class="constructor">Hashtbl</span>.create</code> or deterministic over all executions. <p> A hash table that is created with <code class="code">~random:<span class="keyword">false</span></code> uses a fixed hash function (<a href="Hashtbl.html#VALhash"><code class="code"><span class="constructor">Hashtbl</span>.hash</code></a>) to distribute keys among buckets. As a consequence, collisions between keys happen deterministically. In Web-facing applications or other security-sensitive applications, the deterministic collision patterns can be exploited by a malicious user to create a denial-of-service attack: the attacker sends input crafted to create many collisions in the table, slowing the application down. <p> A hash table that is created with <code class="code">~random:<span class="keyword">true</span></code> uses the seeded hash function <a href="Hashtbl.html#VALseeded_hash"><code class="code"><span class="constructor">Hashtbl</span>.seeded_hash</code></a> with a seed that is randomly chosen at hash table creation time. In effect, the hash function used is randomly selected among <code class="code">2^{30}</code> different hash functions. All these hash functions have different collision patterns, rendering ineffective the denial-of-service attack described above. However, because of randomization, enumerating all elements of the hash table using <a href="Hashtbl.html#VALfold"><code class="code"><span class="constructor">Hashtbl</span>.fold</code></a> or <a href="Hashtbl.html#VALiter"><code class="code"><span class="constructor">Hashtbl</span>.iter</code></a> is no longer deterministic: elements are enumerated in different orders at different runs of the program. <p> If no <code class="code">~random</code> parameter is given, hash tables are created in non-random mode by default. This default can be changed either programmatically by calling <a href="Hashtbl.html#VALrandomize"><code class="code"><span class="constructor">Hashtbl</span>.randomize</code></a> or by setting the <code class="code"><span class="constructor">R</span></code> flag in the <code class="code"><span class="constructor">OCAMLRUNPARAM</span></code> environment variable.<br> <b>Before 4.00.0 </b> the <code class="code">random</code> parameter was not present and all hash tables were created in non-randomized mode.<br> </div> <pre><span id="VALclear"><span class="keyword">val</span> clear</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> unit</code></pre><div class="info "> Empty a hash table. Use <code class="code">reset</code> instead of <code class="code">clear</code> to shrink the size of the bucket table to its initial size.<br> </div> <pre><span id="VALreset"><span class="keyword">val</span> reset</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> unit</code></pre><div class="info "> Empty a hash table and shrink the size of the bucket table to its initial size.<br> <b>Since</b> 4.00.0<br> </div> <pre><span id="VALcopy"><span class="keyword">val</span> copy</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> ('a, 'b) <a href="Hashtbl.html#TYPEt">t</a></code></pre><div class="info "> Return a copy of the given hashtable.<br> </div> <pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'a -> 'b -> unit</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.add tbl x y</code> adds a binding of <code class="code">x</code> to <code class="code">y</code> in table <code class="code">tbl</code>. Previous bindings for <code class="code">x</code> are not removed, but simply hidden. That is, after performing <a href="Hashtbl.html#VALremove"><code class="code"><span class="constructor">Hashtbl</span>.remove</code></a><code class="code"> tbl x</code>, the previous binding for <code class="code">x</code>, if any, is restored. (Same behavior as with association lists.)<br> </div> <pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'a -> 'b</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.find tbl x</code> returns the current binding of <code class="code">x</code> in <code class="code">tbl</code>, or raises <code class="code"><span class="constructor">Not_found</span></code> if no such binding exists.<br> </div> <pre><span id="VALfind_all"><span class="keyword">val</span> find_all</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'a -> 'b list</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.find_all tbl x</code> returns the list of all data associated with <code class="code">x</code> in <code class="code">tbl</code>. The current binding is returned first, then the previous bindings, in reverse order of introduction in the table.<br> </div> <pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'a -> bool</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.mem tbl x</code> checks if <code class="code">x</code> is bound in <code class="code">tbl</code>.<br> </div> <pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'a -> unit</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.remove tbl x</code> removes the current binding of <code class="code">x</code> in <code class="code">tbl</code>, restoring the previous binding if it exists. It does nothing if <code class="code">x</code> is not bound in <code class="code">tbl</code>.<br> </div> <pre><span id="VALreplace"><span class="keyword">val</span> replace</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'a -> 'b -> unit</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.replace tbl x y</code> replaces the current binding of <code class="code">x</code> in <code class="code">tbl</code> by a binding of <code class="code">x</code> to <code class="code">y</code>. If <code class="code">x</code> is unbound in <code class="code">tbl</code>, a binding of <code class="code">x</code> to <code class="code">y</code> is added to <code class="code">tbl</code>. This is functionally equivalent to <a href="Hashtbl.html#VALremove"><code class="code"><span class="constructor">Hashtbl</span>.remove</code></a><code class="code"> tbl x</code> followed by <a href="Hashtbl.html#VALadd"><code class="code"><span class="constructor">Hashtbl</span>.add</code></a><code class="code"> tbl x y</code>.<br> </div> <pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a -> 'b -> unit) -> ('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> unit</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.iter f tbl</code> applies <code class="code">f</code> to all bindings in table <code class="code">tbl</code>. <code class="code">f</code> receives the key as first argument, and the associated value as second argument. Each binding is presented exactly once to <code class="code">f</code>. <p> The order in which the bindings are passed to <code class="code">f</code> is unspecified. However, if the table contains several bindings for the same key, they are passed to <code class="code">f</code> in reverse order of introduction, that is, the most recent binding is passed first. <p> If the hash table was created in non-randomized mode, the order in which the bindings are enumerated is reproducible between successive runs of the program, and even between minor versions of OCaml. For randomized hash tables, the order of enumeration is entirely random.<br> </div> <pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('a -> 'b -> 'c -> 'c) -> ('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> 'c -> 'c</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.fold f tbl init</code> computes <code class="code">(f kN dN ... (f k1 d1 init)...)</code>, where <code class="code">k1 ... kN</code> are the keys of all bindings in <code class="code">tbl</code>, and <code class="code">d1 ... dN</code> are the associated values. Each binding is presented exactly once to <code class="code">f</code>. <p> The order in which the bindings are passed to <code class="code">f</code> is unspecified. However, if the table contains several bindings for the same key, they are passed to <code class="code">f</code> in reverse order of introduction, that is, the most recent binding is passed first. <p> If the hash table was created in non-randomized mode, the order in which the bindings are enumerated is reproducible between successive runs of the program, and even between minor versions of OCaml. For randomized hash tables, the order of enumeration is entirely random.<br> </div> <pre><span id="VALlength"><span class="keyword">val</span> length</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> int</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.length tbl</code> returns the number of bindings in <code class="code">tbl</code>. It takes constant time. Multiple bindings are counted once each, so <code class="code"><span class="constructor">Hashtbl</span>.length</code> gives the number of times <code class="code"><span class="constructor">Hashtbl</span>.iter</code> calls its first argument.<br> </div> <pre><span id="VALrandomize"><span class="keyword">val</span> randomize</span> : <code class="type">unit -> unit</code></pre><div class="info "> After a call to <code class="code"><span class="constructor">Hashtbl</span>.randomize()</code>, hash tables are created in randomized mode by default: <a href="Hashtbl.html#VALcreate"><code class="code"><span class="constructor">Hashtbl</span>.create</code></a> returns randomized hash tables, unless the <code class="code">~random:<span class="keyword">false</span></code> optional parameter is given. The same effect can be achieved by setting the <code class="code"><span class="constructor">R</span></code> parameter in the <code class="code"><span class="constructor">OCAMLRUNPARAM</span></code> environment variable. <p> It is recommended that applications or Web frameworks that need to protect themselves against the denial-of-service attack described in <a href="Hashtbl.html#VALcreate"><code class="code"><span class="constructor">Hashtbl</span>.create</code></a> call <code class="code"><span class="constructor">Hashtbl</span>.randomize()</code> at initialization time. <p> Note that once <code class="code"><span class="constructor">Hashtbl</span>.randomize()</code> was called, there is no way to revert to the non-randomized default behavior of <a href="Hashtbl.html#VALcreate"><code class="code"><span class="constructor">Hashtbl</span>.create</code></a>. This is intentional. Non-randomized hash tables can still be created using <code class="code"><span class="constructor">Hashtbl</span>.create ~random:<span class="keyword">false</span></code>.<br> <b>Since</b> 4.00.0<br> </div> <pre><code><span id="TYPEstatistics"><span class="keyword">type</span> <code class="type"></code>statistics</span> = {</code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTstatistics.num_bindings">num_bindings</span> : <code class="type">int</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info "> Number of bindings present in the table. Same value as returned by <a href="Hashtbl.html#VALlength"><code class="code"><span class="constructor">Hashtbl</span>.length</code></a>.<br> </div> </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTstatistics.num_buckets">num_buckets</span> : <code class="type">int</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info "> Number of buckets in the table.<br> </div> </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTstatistics.max_bucket_length">max_bucket_length</span> : <code class="type">int</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info "> Maximal number of bindings per bucket.<br> </div> </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr> <tr> <td align="left" valign="top" > <code> </code></td> <td align="left" valign="top" > <code><span id="TYPEELTstatistics.bucket_histogram">bucket_histogram</span> : <code class="type">int array</code>;</code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><div class="info "> Histogram of bucket sizes. This array <code class="code">histo</code> has length <code class="code">max_bucket_length + 1</code>. The value of <code class="code">histo.(i)</code> is the number of buckets whose size is <code class="code">i</code>.<br> </div> </td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr></table> } <pre><span id="VALstats"><span class="keyword">val</span> stats</span> : <code class="type">('a, 'b) <a href="Hashtbl.html#TYPEt">t</a> -> <a href="Hashtbl.html#TYPEstatistics">statistics</a></code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.stats tbl</code> returns statistics about the table <code class="code">tbl</code>: number of buckets, size of the biggest bucket, distribution of buckets by size.<br> <b>Since</b> 4.00.0<br> </div> <br> <h6 id="6_Functorialinterface">Functorial interface</h6><br> <br> The functorial interface allows the use of specific comparison and hash functions, either for performance/security concerns, or because keys are not hashable/comparable with the polymorphic builtins. <p> For instance, one might want to specialize a table for integer keys: <pre class="codepre"><code class="code"> <span class="keyword">module</span> <span class="constructor">IntHash</span> =<br> <span class="keyword">struct</span><br> <span class="keyword">type</span> t = int<br> <span class="keyword">let</span> equal i j = i=j<br> <span class="keyword">let</span> hash i = i <span class="keyword">land</span> max_int<br> <span class="keyword">end</span><br> <br> <span class="keyword">module</span> <span class="constructor">IntHashtbl</span> = <span class="constructor">Hashtbl</span>.<span class="constructor">Make</span>(<span class="constructor">IntHash</span>)<br> <br> <span class="keyword">let</span> h = <span class="constructor">IntHashtbl</span>.create 17 <span class="keyword">in</span><br> <span class="constructor">IntHashtbl</span>.add h 12 <span class="string">"hello"</span>;;<br> </code></pre> <p> This creates a new module <code class="code"><span class="constructor">IntHashtbl</span></code>, with a new type <code class="code"><span class="keywordsign">'</span>a <span class="constructor">IntHashtbl</span>.t</code> of tables from <code class="code">int</code> to <code class="code"><span class="keywordsign">'</span>a</code>. In this example, <code class="code">h</code> contains <code class="code">string</code> values so its type is <code class="code">string <span class="constructor">IntHashtbl</span>.t</code>. <p> Note that the new type <code class="code"><span class="keywordsign">'</span>a <span class="constructor">IntHashtbl</span>.t</code> is not compatible with the type <code class="code">(<span class="keywordsign">'</span>a,<span class="keywordsign">'</span>b) <span class="constructor">Hashtbl</span>.t</code> of the generic interface. For example, <code class="code"><span class="constructor">Hashtbl</span>.length h</code> would not type-check, you must use <code class="code"><span class="constructor">IntHashtbl</span>.length</code>.<br> <pre><span class="keyword">module type</span> <a href="Hashtbl.HashedType.html">HashedType</a> = <code class="code"><span class="keyword">sig</span></code> <a href="Hashtbl.HashedType.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info"> The input signature of the functor <a href="Hashtbl.Make.html"><code class="code"><span class="constructor">Hashtbl</span>.<span class="constructor">Make</span></code></a>. </div> <pre><span class="keyword">module type</span> <a href="Hashtbl.S.html">S</a> = <code class="code"><span class="keyword">sig</span></code> <a href="Hashtbl.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info"> The output signature of the functor <a href="Hashtbl.Make.html"><code class="code"><span class="constructor">Hashtbl</span>.<span class="constructor">Make</span></code></a>. </div> <pre><span class="keyword">module</span> <a href="Hashtbl.Make.html">Make</a>: <div class="sig_block"><code class="code"><span class="keyword">functor</span> (</code><code class="code"><span class="constructor">H</span></code><code class="code"> : </code><code class="type"><a href="Hashtbl.HashedType.html">HashedType</a></code><code class="code">) <span class="keywordsign">-></span> </code><code class="type"><a href="Hashtbl.S.html">S</a></code><code class="type"> with type key = H.t</code></div></pre><div class="info"> Functor building an implementation of the hashtable structure. </div> <pre><span class="keyword">module type</span> <a href="Hashtbl.SeededHashedType.html">SeededHashedType</a> = <code class="code"><span class="keyword">sig</span></code> <a href="Hashtbl.SeededHashedType.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info"> The input signature of the functor <a href="Hashtbl.MakeSeeded.html"><code class="code"><span class="constructor">Hashtbl</span>.<span class="constructor">MakeSeeded</span></code></a>. </div> <pre><span class="keyword">module type</span> <a href="Hashtbl.SeededS.html">SeededS</a> = <code class="code"><span class="keyword">sig</span></code> <a href="Hashtbl.SeededS.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info"> The output signature of the functor <a href="Hashtbl.MakeSeeded.html"><code class="code"><span class="constructor">Hashtbl</span>.<span class="constructor">MakeSeeded</span></code></a>. </div> <pre><span class="keyword">module</span> <a href="Hashtbl.MakeSeeded.html">MakeSeeded</a>: <div class="sig_block"><code class="code"><span class="keyword">functor</span> (</code><code class="code"><span class="constructor">H</span></code><code class="code"> : </code><code class="type"><a href="Hashtbl.SeededHashedType.html">SeededHashedType</a></code><code class="code">) <span class="keywordsign">-></span> </code><code class="type"><a href="Hashtbl.SeededS.html">SeededS</a></code><code class="type"> with type key = H.t</code></div></pre><div class="info"> Functor building an implementation of the hashtable structure. </div> <br> <h6 id="6_Thepolymorphichashfunctions">The polymorphic hash functions</h6><br> <pre><span id="VALhash"><span class="keyword">val</span> hash</span> : <code class="type">'a -> int</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.hash x</code> associates a nonnegative integer to any value of any type. It is guaranteed that if <code class="code">x = y</code> or <code class="code"><span class="constructor">Pervasives</span>.compare x y = 0</code>, then <code class="code">hash x = hash y</code>. Moreover, <code class="code">hash</code> always terminates, even on cyclic structures.<br> </div> <pre><span id="VALseeded_hash"><span class="keyword">val</span> seeded_hash</span> : <code class="type">int -> 'a -> int</code></pre><div class="info "> A variant of <a href="Hashtbl.html#VALhash"><code class="code"><span class="constructor">Hashtbl</span>.hash</code></a> that is further parameterized by an integer seed.<br> <b>Since</b> 4.00.0<br> </div> <pre><span id="VALhash_param"><span class="keyword">val</span> hash_param</span> : <code class="type">int -> int -> 'a -> int</code></pre><div class="info "> <code class="code"><span class="constructor">Hashtbl</span>.hash_param meaningful total x</code> computes a hash value for <code class="code">x</code>, with the same properties as for <code class="code">hash</code>. The two extra integer parameters <code class="code">meaningful</code> and <code class="code">total</code> give more precise control over hashing. Hashing performs a breadth-first, left-to-right traversal of the structure <code class="code">x</code>, stopping after <code class="code">meaningful</code> meaningful nodes were encountered, or <code class="code">total</code> nodes (meaningful or not) were encountered. Meaningful nodes are: integers; floating-point numbers; strings; characters; booleans; and constant constructors. Larger values of <code class="code">meaningful</code> and <code class="code">total</code> means that more nodes are taken into account to compute the final hash value, and therefore collisions are less likely to happen. However, hashing takes longer. The parameters <code class="code">meaningful</code> and <code class="code">total</code> govern the tradeoff between accuracy and speed. As default choices, <a href="Hashtbl.html#VALhash"><code class="code"><span class="constructor">Hashtbl</span>.hash</code></a> and <a href="Hashtbl.html#VALseeded_hash"><code class="code"><span class="constructor">Hashtbl</span>.seeded_hash</code></a> take <code class="code">meaningful = 10</code> and <code class="code">total = 100</code>.<br> </div> <pre><span id="VALseeded_hash_param"><span class="keyword">val</span> seeded_hash_param</span> : <code class="type">int -> int -> int -> 'a -> int</code></pre><div class="info "> A variant of <a href="Hashtbl.html#VALhash_param"><code class="code"><span class="constructor">Hashtbl</span>.hash_param</code></a> that is further parameterized by an integer seed. Usage: <code class="code"><span class="constructor">Hashtbl</span>.seeded_hash_param meaningful total seed x</code>.<br> <b>Since</b> 4.00.0<br> </div> </body></html>