mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
227 lines
No EOL
18 KiB
HTML
227 lines
No EOL
18 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="Up" href="CCPersistentHashtbl.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="#3_Conversions">
|
|
<link title="Misc" rel="Section" href="#3_Misc">
|
|
<title>Containers doc : CCPersistentHashtbl.Make</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="CCPersistentHashtbl.html" title="CCPersistentHashtbl">Up</a>
|
|
</div>
|
|
<h1>Functor <a href="type_CCPersistentHashtbl.Make.html">CCPersistentHashtbl.Make</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Make <code class="code">(</code><code class="code"><span class="constructor">H</span></code><code class="code"> : </code><code class="type"><a href="CCPersistentHashtbl.HashedType.html">HashedType</a></code><code class="code">) </code>: <code class="type"><a href="CCPersistentHashtbl.S.html">S</a></code><code class="type"> with type key = H.t</code></pre><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>H</code></td>
|
|
<td align="center" valign="top">:</td>
|
|
<td><code class="type"><a href="CCPersistentHashtbl.HashedType.html">HashedType</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">unit -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Empty table. The table will be allocated at the first binding<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">int -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Create a new hashtable, with the given initial capacity<br>
|
|
</div>
|
|
|
|
<pre><span id="VALis_empty"><span class="keyword">val</span> is_empty</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
|
|
Is the table empty?<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a</code></pre><div class="info ">
|
|
Find the value for this key, or fails<br>
|
|
<b>Raises</b> <code>Not_found</code> if the key is not present in the table<br>
|
|
</div>
|
|
|
|
<pre><span id="VALget_exn"><span class="keyword">val</span> get_exn</span> : <code class="type"><a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Synonym to <a href="CCPersistentHashtbl.S.html#VALfind"><code class="code"><span class="constructor">CCPersistentHashtbl</span>.<span class="constructor">S</span>.find</code></a> with flipped arguments<br>
|
|
</div>
|
|
|
|
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type"><a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
|
|
Safe version of !<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> bool</code></pre><div class="info ">
|
|
Is the key bound?<br>
|
|
</div>
|
|
|
|
<pre><span id="VALlength"><span class="keyword">val</span> length</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of bindings<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Add the binding to the table, returning a new table. The old binding
|
|
for this key, if it exists, is shadowed and will be restored upon
|
|
<code class="code">remove tbl k</code>.<br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALreplace"><span class="keyword">val</span> replace</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Add the binding to the table, returning a new table. This erases
|
|
the current binding for <code class="code">key</code>, if any.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -><br> ('a option -> 'a option) -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">update tbl key f</code> calls <code class="code">f <span class="constructor">None</span></code> if <code class="code">key</code> doesn't belong in <code class="code">tbl</code>,
|
|
<code class="code">f (<span class="constructor">Some</span> v)</code> if <code class="code">key <span class="keywordsign">-></span> v</code> otherwise; If <code class="code">f</code> returns <code class="code"><span class="constructor">None</span></code> then
|
|
<code class="code">key</code> is removed, else it returns <code class="code"><span class="constructor">Some</span> v'</code> and <code class="code">key <span class="keywordsign">-></span> v'</code> is added.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Remove the key<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcopy"><span class="keyword">val</span> copy</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Fresh copy of the table; the underlying structure is not shared
|
|
anymore, so using both tables alternatively will be efficient<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmerge"><span class="keyword">val</span> merge</span> : <code class="type">f:(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -><br> [ `Both of 'a * 'b | `Left of 'a | `Right of 'b ] -> 'c option) -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> 'b <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'c <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Merge two tables together into a new table. The function's argument
|
|
correspond to values associated with the key (if present); if the
|
|
function returns <code class="code"><span class="constructor">None</span></code> the key will not appear in the result.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> (<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> unit) -> unit</code></pre><div class="info ">
|
|
Iterate over bindings<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('b -> <a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> 'b) -><br> 'b -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'b</code></pre><div class="info ">
|
|
Fold over bindings<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> 'b) -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'b <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Map all values<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> bool) -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALfilter_map"><span class="keyword">val</span> filter_map</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> 'b option) -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> 'b <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALfor_all"><span class="keyword">val</span> for_all</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> bool) -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> bool</code></pre>
|
|
<pre><span id="VALexists"><span class="keyword">val</span> exists</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> -> 'a -> bool) -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> bool</code></pre><br>
|
|
<h3 id="3_Conversions">Conversions</h3><br>
|
|
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> * 'a) <a href="CCPersistentHashtbl.html#TYPEsequence">CCPersistentHashtbl.sequence</a> -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Add (replace) bindings from the sequence to the table<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">(<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> * 'a) list -> 'a <a href="CCPersistentHashtbl.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="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> (<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> * 'a) <a href="CCPersistentHashtbl.html#TYPEsequence">CCPersistentHashtbl.sequence</a> -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALadd_list"><span class="keyword">val</span> add_list</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> (<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> * 'a) list -> 'a <a href="CCPersistentHashtbl.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="CCPersistentHashtbl.S.html#TYPEt">t</a> -><br> (<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> * 'a) <a href="CCPersistentHashtbl.html#TYPEsequence">CCPersistentHashtbl.sequence</a></code></pre><div class="info ">
|
|
Sequence of the bindings of the table<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> (<a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> * 'a) list</code></pre><br>
|
|
<h3 id="3_Misc">Misc</h3><br>
|
|
|
|
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">'a <a href="CCPersistentHashtbl.html#TYPEequal">CCPersistentHashtbl.equal</a> -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> <a href="CCPersistentHashtbl.html#TYPEequal">CCPersistentHashtbl.equal</a></code></pre>
|
|
<pre><span id="VALpp"><span class="keyword">val</span> pp</span> : <code class="type"><a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> <a href="CCPersistentHashtbl.html#TYPEprinter">CCPersistentHashtbl.printer</a> -><br> 'a <a href="CCPersistentHashtbl.html#TYPEprinter">CCPersistentHashtbl.printer</a> -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> <a href="CCPersistentHashtbl.html#TYPEprinter">CCPersistentHashtbl.printer</a></code></pre>
|
|
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type"><a href="CCPersistentHashtbl.S.html#TYPEkey">key</a> <a href="CCPersistentHashtbl.html#TYPEformatter">CCPersistentHashtbl.formatter</a> -><br> 'a <a href="CCPersistentHashtbl.html#TYPEformatter">CCPersistentHashtbl.formatter</a> -><br> 'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> <a href="CCPersistentHashtbl.html#TYPEformatter">CCPersistentHashtbl.formatter</a></code></pre>
|
|
<pre><span id="VALstats"><span class="keyword">val</span> stats</span> : <code class="type">'a <a href="CCPersistentHashtbl.S.html#TYPEt">t</a> -> Hashtbl.statistics</code></pre><div class="info ">
|
|
Statistics on the internal table.<br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
</body></html> |