mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
204 lines
No EOL
17 KiB
HTML
204 lines
No EOL
17 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">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="previous" href="CCHashTrie.Transient.html">
|
|
<link rel="Up" href="CCHashTrie.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="CCPrint" rel="Chapter" href="CCPrint.html">
|
|
<link title="CCError" rel="Chapter" href="CCError.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="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="CCHashconsedSet" rel="Chapter" href="CCHashconsedSet.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="CCBloom" rel="Chapter" href="CCBloom.html">
|
|
<link title="CCWBTree" rel="Chapter" href="CCWBTree.html">
|
|
<link title="CCRAL" rel="Chapter" href="CCRAL.html">
|
|
<link title="CCAllocCache" rel="Chapter" href="CCAllocCache.html">
|
|
<link title="CCImmutArray" rel="Chapter" href="CCImmutArray.html">
|
|
<link title="CCHet" rel="Chapter" href="CCHet.html">
|
|
<link title="Containers_string" rel="Chapter" href="Containers_string.html">
|
|
<link title="CCKMP" rel="Chapter" href="CCKMP.html">
|
|
<link title="CCLevenshtein" rel="Chapter" href="CCLevenshtein.html">
|
|
<link title="CCApp_parse" rel="Chapter" href="CCApp_parse.html">
|
|
<link title="CCParse" rel="Chapter" href="CCParse.html">
|
|
<link title="CCBigstring" rel="Chapter" href="CCBigstring.html">
|
|
<link title="CCArray1" rel="Chapter" href="CCArray1.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="Containers_advanced" rel="Chapter" href="Containers_advanced.html">
|
|
<link title="CCLinq" rel="Chapter" href="CCLinq.html">
|
|
<link title="CCBatch" rel="Chapter" href="CCBatch.html">
|
|
<link title="CCCat" rel="Chapter" href="CCCat.html">
|
|
<link title="CCMonadIO" rel="Chapter" href="CCMonadIO.html">
|
|
<link title="Containers_io_is_deprecated" rel="Chapter" href="Containers_io_is_deprecated.html">
|
|
<link title="CCUnix" rel="Chapter" href="CCUnix.html">
|
|
<link title="CCSexp" rel="Chapter" href="CCSexp.html">
|
|
<link title="CCSexpM" rel="Chapter" href="CCSexpM.html"><link title="Conversions" rel="Section" href="#6_Conversions">
|
|
<link title="IO" rel="Section" href="#6_IO">
|
|
<title>Containers doc : CCHashTrie.Make</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="CCHashTrie.Transient.html" title="CCHashTrie.Transient">Previous</a>
|
|
<a class="up" href="CCHashTrie.html" title="CCHashTrie">Up</a>
|
|
</div>
|
|
<h1>Functor <a href="type_CCHashTrie.Make.html">CCHashTrie.Make</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Make <code class="code">(</code><code class="code"><span class="constructor">K</span></code><code class="code"> : </code><code class="type"><a href="CCHashTrie.KEY.html">KEY</a></code><code class="code">) </code>: <code class="type"><a href="CCHashTrie.S.html">S</a></code><code class="type"> with type key = K.t</code></pre><div class="info module top">
|
|
<h2 id="2_Functors">Functors</h2><br>
|
|
</div>
|
|
<table border="0" cellpadding="3" width="100%">
|
|
<tr>
|
|
<td align="left" valign="top" width="1%%"><b>Parameters: </b></td>
|
|
<td>
|
|
<table class="paramstable">
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">
|
|
<code>K</code></td>
|
|
<td align="center" valign="top">:</td>
|
|
<td><code class="type"><a href="CCHashTrie.KEY.html">KEY</a></code>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="TYPEkey"><span class="keyword">type</span> <code class="type"></code>key</span> </pre>
|
|
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre>
|
|
|
|
|
|
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALis_empty"><span class="keyword">val</span> is_empty</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> bool</code></pre>
|
|
<pre><span id="VALsingleton"><span class="keyword">val</span> singleton</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> bool</code></pre>
|
|
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a option</code></pre>
|
|
<pre><span id="VALget_exn"><span class="keyword">val</span> get_exn</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
<b>Raises</b> <code>Not_found</code> if key not present<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Remove the key, if present.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> -><br> f:('a option -> 'a option) -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">update k ~f m</code> calls <code class="code">f (<span class="constructor">Some</span> v)</code> if <code class="code">get k m = <span class="constructor">Some</span> v</code>, <code class="code">f <span class="constructor">None</span></code>
|
|
otherwise. Then, if <code class="code">f</code> returns <code class="code"><span class="constructor">Some</span> v'</code> it binds <code class="code">k</code> to <code class="code">v'</code>,
|
|
if <code class="code">f</code> returns <code class="code"><span class="constructor">None</span></code> it removes <code class="code">k</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_mut"><span class="keyword">val</span> add_mut</span> : <code class="type">id:<a href="CCHashTrie.Transient.html#TYPEt">CCHashTrie.Transient.t</a> -><br> <a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">add_mut ~id k v m</code> behaves like <code class="code">add k v m</code>, except it will mutate
|
|
in place whenever possible. Changes done with an <code class="code">id</code> might affect all
|
|
versions of the structure obtained with the same <code class="code">id</code> (but not
|
|
other versions).<br>
|
|
<b>Raises</b> <code>Transient.Frozen</code> if <code class="code">id</code> is frozen<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove_mut"><span class="keyword">val</span> remove_mut</span> : <code class="type">id:<a href="CCHashTrie.Transient.html#TYPEt">CCHashTrie.Transient.t</a> -><br> <a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCHashTrie.S.html#VALremove"><code class="code"><span class="constructor">CCHashTrie</span>.<span class="constructor">S</span>.remove</code></a>, but modifies in place whenever possible<br>
|
|
<b>Raises</b> <code>Transient.Frozen</code> if <code class="code">id</code> is frozen<br>
|
|
</div>
|
|
|
|
<pre><span id="VALupdate_mut"><span class="keyword">val</span> update_mut</span> : <code class="type">id:<a href="CCHashTrie.Transient.html#TYPEt">CCHashTrie.Transient.t</a> -><br> <a href="CCHashTrie.S.html#TYPEkey">key</a> -><br> f:('a option -> 'a option) -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Same as <a href="CCHashTrie.S.html#VALupdate"><code class="code"><span class="constructor">CCHashTrie</span>.<span class="constructor">S</span>.update</code></a> but with mutability<br>
|
|
<b>Raises</b> <code>Transient.Frozen</code> if <code class="code">id</code> is frozen<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcardinal"><span class="keyword">val</span> cardinal</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> int</code></pre>
|
|
<pre><span id="VALchoose"><span class="keyword">val</span> choose</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) option</code></pre>
|
|
<pre><span id="VALchoose_exn"><span class="keyword">val</span> choose_exn</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> <a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a</code></pre><div class="info ">
|
|
<b>Raises</b> <code>Not_found</code> if not pair was found<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">f:(<a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a -> unit) -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> unit</code></pre>
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">f:('b -> <a href="CCHashTrie.S.html#TYPEkey">key</a> -> 'a -> 'b) -> x:'b -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> 'b</code></pre><br>
|
|
<h6 id="6_Conversions">Conversions</h6><br>
|
|
|
|
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) list</code></pre>
|
|
<pre><span id="VALadd_list"><span class="keyword">val</span> add_list</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) list -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALadd_list_mut"><span class="keyword">val</span> add_list_mut</span> : <code class="type">id:<a href="CCHashTrie.Transient.html#TYPEt">CCHashTrie.Transient.t</a> -><br> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) list -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Raises</b> <code>Frozen</code> if the ID is frozen<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">(<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) list -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALadd_seq"><span class="keyword">val</span> add_seq</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -><br> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEsequence">CCHashTrie.sequence</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALadd_seq_mut"><span class="keyword">val</span> add_seq_mut</span> : <code class="type">id:<a href="CCHashTrie.Transient.html#TYPEt">CCHashTrie.Transient.t</a> -><br> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -><br> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEsequence">CCHashTrie.sequence</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Raises</b> <code>Frozen</code> if the ID is frozen<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type">(<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEsequence">CCHashTrie.sequence</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALto_seq"><span class="keyword">val</span> to_seq</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEsequence">CCHashTrie.sequence</a></code></pre>
|
|
<pre><span id="VALadd_gen"><span class="keyword">val</span> add_gen</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -><br> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEgen">CCHashTrie.gen</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALadd_gen_mut"><span class="keyword">val</span> add_gen_mut</span> : <code class="type">id:<a href="CCHashTrie.Transient.html#TYPEt">CCHashTrie.Transient.t</a> -><br> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> -><br> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEgen">CCHashTrie.gen</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Raises</b> <code>Frozen</code> if the ID is frozen<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_gen"><span class="keyword">val</span> of_gen</span> : <code class="type">(<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEgen">CCHashTrie.gen</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALto_gen"><span class="keyword">val</span> to_gen</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -> (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCHashTrie.html#TYPEgen">CCHashTrie.gen</a></code></pre><br>
|
|
<h6 id="6_IO">IO</h6><br>
|
|
|
|
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type"><a href="CCHashTrie.S.html#TYPEkey">key</a> <a href="CCHashTrie.html#TYPEprinter">CCHashTrie.printer</a> -><br> 'a <a href="CCHashTrie.html#TYPEprinter">CCHashTrie.printer</a> -> 'a <a href="CCHashTrie.S.html#TYPEt">t</a> <a href="CCHashTrie.html#TYPEprinter">CCHashTrie.printer</a></code></pre>
|
|
<pre><span id="VALas_tree"><span class="keyword">val</span> as_tree</span> : <code class="type">'a <a href="CCHashTrie.S.html#TYPEt">t</a> -><br> [ `L of int * (<a href="CCHashTrie.S.html#TYPEkey">key</a> * 'a) list | `N ] <a href="CCHashTrie.html#TYPEktree">CCHashTrie.ktree</a></code></pre><div class="info ">
|
|
For debugging purpose: explore the structure of the tree,
|
|
with <code class="code"><span class="keywordsign">`</span><span class="constructor">L</span> (h,l)</code> being a leaf (with shared hash <code class="code">h</code>)
|
|
and <code class="code"><span class="keywordsign">`</span><span class="constructor">N</span></code> an inner node<br>
|
|
</div>
|
|
</body></html> |