mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
202 lines
No EOL
14 KiB
HTML
202 lines
No EOL
14 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="next" href="CCTrie.MakeArray.html">
|
|
<link rel="Up" href="CCTrie.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="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="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="Conversions" rel="Section" href="#6_Conversions">
|
|
<link title="Ranges" rel="Section" href="#6_Ranges">
|
|
<title>Containers doc : CCTrie.Make</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="CCTrie.html" title="CCTrie">Up</a>
|
|
<a class="post" href="CCTrie.MakeArray.html" title="CCTrie.MakeArray">Next</a>
|
|
</div>
|
|
<h1>Functor <a href="type_CCTrie.Make.html">CCTrie.Make</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Make <code class="code">(</code><code class="code"><span class="constructor">W</span></code><code class="code"> : </code><code class="type"><a href="CCTrie.WORD.html">WORD</a></code><code class="code">) </code>: <code class="type"><a href="CCTrie.S.html">S</a></code><code class="type"> with type key = W.t and type char_ = W.char_</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>W</code></td>
|
|
<td align="center" valign="top">:</td>
|
|
<td><code class="type"><a href="CCTrie.WORD.html">WORD</a></code>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="TYPEchar_"><span class="keyword">type</span> <code class="type"></code>char_</span> </pre>
|
|
|
|
|
|
<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="CCTrie.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="CCTrie.S.html#TYPEt">t</a> -> bool</code></pre>
|
|
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Add a binding to the trie (possibly erasing the previous one)<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Remove the key, if present<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
|
|
Find the value associated with the key, if any<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind_exn"><span class="keyword">val</span> find_exn</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Same as <a href="CCTrie.S.html#VALfind"><code class="code"><span class="constructor">CCTrie</span>.<span class="constructor">S</span>.find</code></a> but can fail.<br>
|
|
<b>Raises</b> <code>Not_found</code> if the key is not present<br>
|
|
</div>
|
|
|
|
<pre><span id="VALlongest_prefix"><span class="keyword">val</span> longest_prefix</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> <a href="CCTrie.S.html#TYPEkey">key</a></code></pre><div class="info ">
|
|
<code class="code">longest_prefix k m</code> finds the longest prefix of <code class="code">k</code> that leads to
|
|
at least one path in <code class="code">m</code> (it does not mean that the prefix is bound to
|
|
a value.
|
|
<p>
|
|
|
|
Example: if <code class="code">m</code> has keys "abc0" and "abcd", then <code class="code">longest_prefix <span class="string">"abc2"</span> m</code>
|
|
will return "abc"<br>
|
|
<b>Since</b> 0.17<br>
|
|
</div>
|
|
|
|
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> ('a option -> 'a option) -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Update the binding for the given key. The function is given
|
|
<code class="code"><span class="constructor">None</span></code> if the key is absent, or <code class="code"><span class="constructor">Some</span> v</code> if <code class="code">key</code> is bound to <code class="code">v</code>;
|
|
if it returns <code class="code"><span class="constructor">None</span></code> the key is removed, otherwise it
|
|
returns <code class="code"><span class="constructor">Some</span> y</code> and <code class="code">key</code> becomes bound to <code class="code">y</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('b -> <a href="CCTrie.S.html#TYPEkey">key</a> -> 'a -> 'b) -> 'b -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'b</code></pre><div class="info ">
|
|
Fold on key/value bindings. Will use <a href="CCTrie.WORD.html#VALof_list"><code class="code"><span class="constructor">CCTrie</span>.<span class="constructor">WORD</span>.of_list</code></a> to rebuild keys.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmapi"><span class="keyword">val</span> mapi</span> : <code class="type">(<a href="CCTrie.S.html#TYPEkey">key</a> -> 'a -> 'b) -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'b <a href="CCTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Map values, giving both key and value. Will use <a href="CCTrie.WORD.html#VALof_list"><code class="code"><span class="constructor">CCTrie</span>.<span class="constructor">WORD</span>.of_list</code></a> to rebuild keys.<br>
|
|
<b>Since</b> 0.17<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'b <a href="CCTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Map values, giving only the value.<br>
|
|
<b>Since</b> 0.17<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">(<a href="CCTrie.S.html#TYPEkey">key</a> -> 'a -> unit) -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
|
|
Same as <a href="CCTrie.S.html#VALfold"><code class="code"><span class="constructor">CCTrie</span>.<span class="constructor">S</span>.fold</code></a>, but for effectful functions<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfold_values"><span class="keyword">val</span> fold_values</span> : <code class="type">('b -> 'a -> 'b) -> 'b -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'b</code></pre><div class="info ">
|
|
More efficient version of <a href="CCTrie.S.html#VALfold"><code class="code"><span class="constructor">CCTrie</span>.<span class="constructor">S</span>.fold</code></a>, that doesn't keep keys<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter_values"><span class="keyword">val</span> iter_values</span> : <code class="type">('a -> unit) -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> unit</code></pre>
|
|
<pre><span id="VALmerge"><span class="keyword">val</span> merge</span> : <code class="type">('a -> 'a -> 'a option) -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Merge two tries together. The function is used in
|
|
case of conflicts, when a key belongs to both tries<br>
|
|
</div>
|
|
|
|
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">'a <a href="CCTrie.S.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of bindings<br>
|
|
</div>
|
|
<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="CCTrie.S.html#TYPEt">t</a> -> (<a href="CCTrie.S.html#TYPEkey">key</a> * 'a) list</code></pre>
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">(<a href="CCTrie.S.html#TYPEkey">key</a> * 'a) list -> 'a <a href="CCTrie.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="CCTrie.S.html#TYPEt">t</a> -> (<a href="CCTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCTrie.html#TYPEsequence">CCTrie.sequence</a></code></pre>
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type">(<a href="CCTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCTrie.html#TYPEsequence">CCTrie.sequence</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALto_seq_values"><span class="keyword">val</span> to_seq_values</span> : <code class="type">'a <a href="CCTrie.S.html#TYPEt">t</a> -> 'a <a href="CCTrie.html#TYPEsequence">CCTrie.sequence</a></code></pre>
|
|
<pre><span id="VALto_tree"><span class="keyword">val</span> to_tree</span> : <code class="type">'a <a href="CCTrie.S.html#TYPEt">t</a> -><br> [ `Char of <a href="CCTrie.S.html#TYPEchar_">char_</a> | `Switch | `Val of 'a ] <a href="CCTrie.html#TYPEktree">CCTrie.ktree</a></code></pre><br>
|
|
<h6 id="6_Ranges">Ranges</h6><br>
|
|
|
|
<pre><span id="VALabove"><span class="keyword">val</span> above</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> (<a href="CCTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCTrie.html#TYPEsequence">CCTrie.sequence</a></code></pre><div class="info ">
|
|
All bindings whose key is bigger or equal to the given key, in
|
|
ascending order<br>
|
|
</div>
|
|
|
|
<pre><span id="VALbelow"><span class="keyword">val</span> below</span> : <code class="type"><a href="CCTrie.S.html#TYPEkey">key</a> -> 'a <a href="CCTrie.S.html#TYPEt">t</a> -> (<a href="CCTrie.S.html#TYPEkey">key</a> * 'a) <a href="CCTrie.html#TYPEsequence">CCTrie.sequence</a></code></pre><div class="info ">
|
|
All bindings whose key is smaller or equal to the given key,
|
|
in decreasing order<br>
|
|
</div>
|
|
</body></html> |