mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
190 lines
No EOL
11 KiB
HTML
190 lines
No EOL
11 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="CCMixmap.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="Iterators" rel="Section" href="#2_Iterators">
|
|
<title>Containers doc : CCMixmap.Make</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="CCMixmap.html" title="CCMixmap">Up</a>
|
|
</div>
|
|
<h1>Functor <a href="type_CCMixmap.Make.html">CCMixmap.Make</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> Make <code class="code">(</code><code class="code"><span class="constructor">X</span></code><code class="code"> : </code><code class="type"><a href="CCMixmap.ORD.html">ORD</a></code><code class="code">) </code>: <code class="type"><a href="CCMixmap.S.html">S</a></code><code class="type"> with type key = X.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>X</code></td>
|
|
<td align="center" valign="top">:</td>
|
|
<td><code class="type"><a href="CCMixmap.ORD.html">ORD</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"></code>t</span> </pre>
|
|
<div class="info ">
|
|
A map containing values of different types, indexed by <a href="CCMixmap.S.html#TYPEkey"><code class="code"><span class="constructor">CCMixmap</span>.<span class="constructor">S</span>.key</code></a>.<br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type"><a href="CCMixmap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Empty map<br>
|
|
</div>
|
|
|
|
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">inj:'a <a href="CCMixmap.html#TYPEinjection">CCMixmap.injection</a> -> <a href="CCMixmap.S.html#TYPEkey">key</a> -> <a href="CCMixmap.S.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
|
|
Get the value corresponding to this key, if it exists and
|
|
belongs to the same key<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">inj:'a <a href="CCMixmap.html#TYPEinjection">CCMixmap.injection</a> -><br> <a href="CCMixmap.S.html#TYPEkey">key</a> -> 'a -> <a href="CCMixmap.S.html#TYPEt">t</a> -> <a href="CCMixmap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Bind the key to the value, using <code class="code">inj</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">inj:'a <a href="CCMixmap.html#TYPEinjection">CCMixmap.injection</a> -> <a href="CCMixmap.S.html#TYPEkey">key</a> -> <a href="CCMixmap.S.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Find the value for the given key, which must be of the right type.<br>
|
|
<b>Raises</b> <code>Not_found</code> if either the key is not found, or if its value
|
|
doesn't belong to the right type<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcardinal"><span class="keyword">val</span> cardinal</span> : <code class="type"><a href="CCMixmap.S.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of bindings<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="CCMixmap.S.html#TYPEkey">key</a> -> <a href="CCMixmap.S.html#TYPEt">t</a> -> <a href="CCMixmap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Remove the binding for this key<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type">inj:'a <a href="CCMixmap.html#TYPEinjection">CCMixmap.injection</a> -> <a href="CCMixmap.S.html#TYPEkey">key</a> -> <a href="CCMixmap.S.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
|
|
Is the given key in the map, with the right type?<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter_keys"><span class="keyword">val</span> iter_keys</span> : <code class="type">f:(<a href="CCMixmap.S.html#TYPEkey">key</a> -> unit) -> <a href="CCMixmap.S.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
|
|
Iterate on the keys of this map<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfold_keys"><span class="keyword">val</span> fold_keys</span> : <code class="type">f:('a -> <a href="CCMixmap.S.html#TYPEkey">key</a> -> 'a) -> x:'a -> <a href="CCMixmap.S.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Fold over the keys<br>
|
|
</div>
|
|
<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="VALkeys_seq"><span class="keyword">val</span> keys_seq</span> : <code class="type"><a href="CCMixmap.S.html#TYPEt">t</a> -> <a href="CCMixmap.S.html#TYPEkey">key</a> <a href="CCMixmap.S.html#TYPEsequence">sequence</a></code></pre><div class="info ">
|
|
All the keys<br>
|
|
</div>
|
|
|
|
<pre><span id="VALbindings_of"><span class="keyword">val</span> bindings_of</span> : <code class="type">inj:'a <a href="CCMixmap.html#TYPEinjection">CCMixmap.injection</a> -><br> <a href="CCMixmap.S.html#TYPEt">t</a> -> (<a href="CCMixmap.S.html#TYPEkey">key</a> * 'a) <a href="CCMixmap.S.html#TYPEsequence">sequence</a></code></pre><div class="info ">
|
|
All the bindings that come from the corresponding injection<br>
|
|
</div>
|
|
|
|
<pre><code><span id="TYPEvalue"><span class="keyword">type</span> <code class="type"></code>value</span> = </code></pre><table class="typetable">
|
|
<tr>
|
|
<td align="left" valign="top" >
|
|
<code><span class="keyword">|</span></code></td>
|
|
<td align="left" valign="top" >
|
|
<code><span id="TYPEELTvalue.Value"><span class="constructor">Value</span></span> <span class="keyword">:</span> <code class="type">('a <a href="CCMixmap.html#TYPEinjection">CCMixmap.injection</a> -> 'a option)</code> <span class="keyword">-></span> <code class="type"><a href="CCMixmap.S.html#TYPEvalue">value</a></code></code></td>
|
|
|
|
</tr></table>
|
|
|
|
|
|
|
|
<pre><span id="VALbindings"><span class="keyword">val</span> bindings</span> : <code class="type"><a href="CCMixmap.S.html#TYPEt">t</a> -> (<a href="CCMixmap.S.html#TYPEkey">key</a> * <a href="CCMixmap.S.html#TYPEvalue">value</a>) <a href="CCMixmap.S.html#TYPEsequence">sequence</a></code></pre><div class="info ">
|
|
Iterate on all bindings<br>
|
|
</div>
|
|
</body></html> |