mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
175 lines
No EOL
13 KiB
HTML
175 lines
No EOL
13 KiB
HTML
<!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=utf-8" http-equiv="Content-Type">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="previous" href="CCFun.html">
|
|
<link rel="next" href="CCInt.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 class methods" rel=Appendix href="index_methods.html">
|
|
<link title="Index of class types" rel=Appendix href="index_class_types.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="CCVector" rel="Chapter" href="CCVector.html">
|
|
<link title="CCHeap" rel="Chapter" href="CCHeap.html">
|
|
<link title="CCList" rel="Chapter" href="CCList.html">
|
|
<link title="CCOpt" rel="Chapter" href="CCOpt.html">
|
|
<link title="CCPair" rel="Chapter" href="CCPair.html">
|
|
<link title="CCFun" rel="Chapter" href="CCFun.html">
|
|
<link title="CCHash" rel="Chapter" href="CCHash.html">
|
|
<link title="CCInt" rel="Chapter" href="CCInt.html">
|
|
<link title="CCBool" rel="Chapter" href="CCBool.html">
|
|
<link title="CCFloat" rel="Chapter" href="CCFloat.html">
|
|
<link title="CCArray" rel="Chapter" href="CCArray.html">
|
|
<link title="CCRef" rel="Chapter" href="CCRef.html">
|
|
<link title="CCSet" rel="Chapter" href="CCSet.html">
|
|
<link title="CCOrd" rel="Chapter" href="CCOrd.html">
|
|
<link title="CCRandom" rel="Chapter" href="CCRandom.html">
|
|
<link title="CCString" rel="Chapter" href="CCString.html">
|
|
<link title="CCHashtbl" rel="Chapter" href="CCHashtbl.html">
|
|
<link title="CCMap" rel="Chapter" href="CCMap.html">
|
|
<link title="CCFormat" rel="Chapter" href="CCFormat.html">
|
|
<link title="CCIO" rel="Chapter" href="CCIO.html">
|
|
<link title="CCInt64" rel="Chapter" href="CCInt64.html">
|
|
<link title="CCChar" rel="Chapter" href="CCChar.html">
|
|
<link title="CCResult" rel="Chapter" href="CCResult.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCArray_slice" rel="Chapter" href="CCArray_slice.html">
|
|
<link title="CCListLabels" rel="Chapter" href="CCListLabels.html">
|
|
<link title="CCArrayLabels" rel="Chapter" href="CCArrayLabels.html">
|
|
<link title="CCEqual" rel="Chapter" href="CCEqual.html">
|
|
<link title="Containers" rel="Chapter" href="Containers.html">
|
|
<link title="CCKTree" rel="Chapter" href="CCKTree.html">
|
|
<link title="CCKList" rel="Chapter" href="CCKList.html">
|
|
<link title="CCLazy_list" rel="Chapter" href="CCLazy_list.html">
|
|
<link title="CCMultiMap" rel="Chapter" href="CCMultiMap.html">
|
|
<link title="CCMultiSet" rel="Chapter" href="CCMultiSet.html">
|
|
<link title="CCTrie" rel="Chapter" href="CCTrie.html">
|
|
<link title="CCFlatHashtbl" rel="Chapter" href="CCFlatHashtbl.html">
|
|
<link title="CCCache" rel="Chapter" href="CCCache.html">
|
|
<link title="CCPersistentHashtbl" rel="Chapter" href="CCPersistentHashtbl.html">
|
|
<link title="CCDeque" rel="Chapter" href="CCDeque.html">
|
|
<link title="CCFQueue" rel="Chapter" href="CCFQueue.html">
|
|
<link title="CCBV" rel="Chapter" href="CCBV.html">
|
|
<link title="CCMixtbl" rel="Chapter" href="CCMixtbl.html">
|
|
<link title="CCMixmap" rel="Chapter" href="CCMixmap.html">
|
|
<link title="CCRingBuffer" rel="Chapter" href="CCRingBuffer.html">
|
|
<link title="CCIntMap" rel="Chapter" href="CCIntMap.html">
|
|
<link title="CCPersistentArray" rel="Chapter" href="CCPersistentArray.html">
|
|
<link title="CCMixset" rel="Chapter" href="CCMixset.html">
|
|
<link title="CCGraph" rel="Chapter" href="CCGraph.html">
|
|
<link title="CCHashSet" rel="Chapter" href="CCHashSet.html">
|
|
<link title="CCBitField" rel="Chapter" href="CCBitField.html">
|
|
<link title="CCHashTrie" rel="Chapter" href="CCHashTrie.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCSimple_queue" rel="Chapter" href="CCSimple_queue.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="CCZipper" rel="Chapter" href="CCZipper.html">
|
|
<link title="CCPool" rel="Chapter" href="CCPool.html">
|
|
<link title="CCLock" rel="Chapter" href="CCLock.html">
|
|
<link title="CCSemaphore" rel="Chapter" href="CCSemaphore.html">
|
|
<link title="CCThread" rel="Chapter" href="CCThread.html">
|
|
<link title="CCBlockingQueue" rel="Chapter" href="CCBlockingQueue.html">
|
|
<link title="CCTimer" rel="Chapter" href="CCTimer.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexp_lex" rel="Chapter" href="CCSexp_lex.html"><link title="Definitions" rel="Section" href="#2_Definitions">
|
|
<link title="Base hash combinators" rel="Section" href="#2_Basehashcombinators">
|
|
<link title="Iterators" rel="Section" href="#2_Iterators">
|
|
<title>Containers doc : CCHash</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="CCFun.html" title="CCFun">Previous</a>
|
|
<a class="up" href="index.html" title="Index">Up</a>
|
|
<a class="post" href="CCInt.html" title="CCInt">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_CCHash.html">CCHash</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> CCHash: <code class="code"><span class="keyword">sig</span></code> <a href="CCHash.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
|
|
<h1 id="1_Hashcombinators">Hash combinators</h1><br>
|
|
</div>
|
|
<hr width="100%">
|
|
<br>
|
|
<h2 id="2_Definitions">Definitions</h2><br>
|
|
|
|
<pre><span id="TYPEhash"><span class="keyword">type</span> <code class="type"></code>hash</span> = <code class="type">int</code> </pre>
|
|
<div class="info ">
|
|
A hash value is a positive integer<br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> = <code class="type">'a -> <a href="CCHash.html#TYPEhash">hash</a></code> </pre>
|
|
<div class="info ">
|
|
A hash function for values of type <code class="code"><span class="keywordsign">'</span>a</code><br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="VALconst"><span class="keyword">val</span> const</span> : <code class="type"><a href="CCHash.html#TYPEhash">hash</a> -> 'a <a href="CCHash.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">return h</code> hashes any value into <code class="code">h</code>. Use with caution!.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALint"><span class="keyword">val</span> int</span> : <code class="type">int <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALbool"><span class="keyword">val</span> bool</span> : <code class="type">bool <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALchar"><span class="keyword">val</span> char</span> : <code class="type">char <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALint32"><span class="keyword">val</span> int32</span> : <code class="type">int32 <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALint64"><span class="keyword">val</span> int64</span> : <code class="type">int64 <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALnativeint"><span class="keyword">val</span> nativeint</span> : <code class="type">nativeint <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALslice"><span class="keyword">val</span> slice</span> : <code class="type">string -> int -> int <a href="CCHash.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">slice s i len state</code> hashes the slice <code class="code">i, ... i+len-1</code> of <code class="code">s</code>
|
|
into <code class="code">state</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALstring"><span class="keyword">val</span> string</span> : <code class="type">string <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALlist"><span class="keyword">val</span> list</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a list <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALarray"><span class="keyword">val</span> array</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a array <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALopt"><span class="keyword">val</span> opt</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a option <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALpair"><span class="keyword">val</span> pair</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'b <a href="CCHash.html#TYPEt">t</a> -> ('a * 'b) <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALtriple"><span class="keyword">val</span> triple</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'b <a href="CCHash.html#TYPEt">t</a> -> 'c <a href="CCHash.html#TYPEt">t</a> -> ('a * 'b * 'c) <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALquad"><span class="keyword">val</span> quad</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -><br> 'b <a href="CCHash.html#TYPEt">t</a> -> 'c <a href="CCHash.html#TYPEt">t</a> -> 'd <a href="CCHash.html#TYPEt">t</a> -> ('a * 'b * 'c * 'd) <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALif_"><span class="keyword">val</span> if_</span> : <code class="type">bool -> 'a <a href="CCHash.html#TYPEt">t</a> -> 'a <a href="CCHash.html#TYPEt">t</a> -> 'a <a href="CCHash.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Decide which hash function to use depending on the boolean<br>
|
|
</div>
|
|
|
|
<pre><span id="VALpoly"><span class="keyword">val</span> poly</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a></code></pre><div class="info ">
|
|
the regular polymorphic hash function<br>
|
|
</div>
|
|
|
|
<pre><span id="VALlist_comm"><span class="keyword">val</span> list_comm</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a list <a href="CCHash.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Commutative version of <a href="CCHash.html#VALlist"><code class="code"><span class="constructor">CCHash</span>.list</code></a>. Lists that are equal up to permutation
|
|
will have the same hash.<br>
|
|
<b>Since</b> 1.0<br>
|
|
</div>
|
|
|
|
<pre><span id="VALarray_comm"><span class="keyword">val</span> array_comm</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a array <a href="CCHash.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Commutative version of <a href="CCHash.html#VALarray"><code class="code"><span class="constructor">CCHash</span>.array</code></a>. Arrays that are equal up to permutation
|
|
will have the same hash.<br>
|
|
<b>Since</b> 1.0<br>
|
|
</div>
|
|
<br>
|
|
<h2 id="2_Basehashcombinators">Base hash combinators</h2><br>
|
|
|
|
<pre><span id="VALcombine"><span class="keyword">val</span> combine</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> 'a -> <a href="CCHash.html#TYPEhash">hash</a></code></pre>
|
|
<pre><span id="VALcombine2"><span class="keyword">val</span> combine2</span> : <code class="type"><a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a></code></pre>
|
|
<pre><span id="VALcombine3"><span class="keyword">val</span> combine3</span> : <code class="type"><a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a></code></pre>
|
|
<pre><span id="VALcombine4"><span class="keyword">val</span> combine4</span> : <code class="type"><a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a> -> <a href="CCHash.html#TYPEhash">hash</a></code></pre><br>
|
|
<h2 id="2_Iterators">Iterators</h2><br>
|
|
|
|
<pre><span id="TYPEsequence"><span class="keyword">type</span> <code class="type">'a</code> sequence</span> = <code class="type">('a -> unit) -> unit</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEgen"><span class="keyword">type</span> <code class="type">'a</code> gen</span> = <code class="type">unit -> 'a option</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEklist"><span class="keyword">type</span> <code class="type">'a</code> klist</span> = <code class="type">unit -> [ `Cons of 'a * 'a <a href="CCHash.html#TYPEklist">klist</a> | `Nil ]</code> </pre>
|
|
|
|
|
|
<pre><span id="VALseq"><span class="keyword">val</span> seq</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a <a href="CCHash.html#TYPEsequence">sequence</a> <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALgen"><span class="keyword">val</span> gen</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a <a href="CCHash.html#TYPEgen">gen</a> <a href="CCHash.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALklist"><span class="keyword">val</span> klist</span> : <code class="type">'a <a href="CCHash.html#TYPEt">t</a> -> 'a <a href="CCHash.html#TYPEklist">klist</a> <a href="CCHash.html#TYPEt">t</a></code></pre></body></html> |