mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
177 lines
No EOL
12 KiB
HTML
177 lines
No EOL
12 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="CCMultiMap.OrderedType.html">
|
|
<link rel="Up" href="CCMultiMap.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"><title>Containers doc : CCMultiMap.S</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="CCMultiMap.html" title="CCMultiMap">Up</a>
|
|
<a class="post" href="CCMultiMap.OrderedType.html" title="CCMultiMap.OrderedType">Next</a>
|
|
</div>
|
|
<h1>Module type <a href="type_CCMultiMap.S.html">CCMultiMap.S</a></h1>
|
|
|
|
<pre><span class="keyword">module type</span> S = <code class="code"><span class="keyword">sig</span></code> <a href="CCMultiMap.S.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><hr width="100%">
|
|
|
|
<pre><span id="TYPEkey"><span class="keyword">type</span> <code class="type"></code>key</span> </pre>
|
|
|
|
|
|
<pre><span id="TYPEvalue"><span class="keyword">type</span> <code class="type"></code>value</span> </pre>
|
|
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
|
|
|
|
|
|
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Empty multimap<br>
|
|
</div>
|
|
|
|
<pre><span id="VALis_empty"><span class="keyword">val</span> is_empty</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
|
|
Empty multimap?<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> <a href="CCMultiMap.S.html#TYPEvalue">value</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Add a key/value binding<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> <a href="CCMultiMap.S.html#TYPEvalue">value</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Remove the binding<br>
|
|
</div>
|
|
|
|
<pre><span id="VALremove_all"><span class="keyword">val</span> remove_all</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Remove the key from the map<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> bool</code></pre><div class="info ">
|
|
Is there a binding for this key?<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> <a href="CCMultiMap.S.html#TYPEvalue">value</a> list</code></pre><div class="info ">
|
|
List of values for this key<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfind_iter"><span class="keyword">val</span> find_iter</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> (<a href="CCMultiMap.S.html#TYPEvalue">value</a> -> unit) -> unit</code></pre><div class="info ">
|
|
Iterate on bindings for this key<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcount"><span class="keyword">val</span> count</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> int</code></pre><div class="info ">
|
|
Number of bindings for this key<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> (<a href="CCMultiMap.S.html#TYPEkey">key</a> -> <a href="CCMultiMap.S.html#TYPEvalue">value</a> -> unit) -> unit</code></pre><div class="info ">
|
|
Iterate on all key/value<br>
|
|
</div>
|
|
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -><br> 'a -> ('a -> <a href="CCMultiMap.S.html#TYPEkey">key</a> -> <a href="CCMultiMap.S.html#TYPEvalue">value</a> -> 'a) -> 'a</code></pre><div class="info ">
|
|
Fold on all key/value<br>
|
|
</div>
|
|
|
|
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of keys<br>
|
|
</div>
|
|
|
|
<pre><span id="VALunion"><span class="keyword">val</span> union</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Union of multimaps<br>
|
|
</div>
|
|
|
|
<pre><span id="VALinter"><span class="keyword">val</span> inter</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Intersection of multimaps<br>
|
|
</div>
|
|
|
|
<pre><span id="VALdiff"><span class="keyword">val</span> diff</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Difference of maps, ie bindings of the first that are not
|
|
in the second<br>
|
|
</div>
|
|
|
|
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
|
|
Same multimap<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Total order on multimaps<br>
|
|
</div>
|
|
|
|
<pre><span id="VALsubmap"><span class="keyword">val</span> submap</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
|
|
<code class="code">submap m1 m2</code> is true iff all bindings of <code class="code">m1</code> are also in <code class="code">m2</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_seq"><span class="keyword">val</span> to_seq</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> (<a href="CCMultiMap.S.html#TYPEkey">key</a> * <a href="CCMultiMap.S.html#TYPEvalue">value</a>) <a href="CCMultiMap.html#TYPEsequence">CCMultiMap.sequence</a></code></pre>
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type">?init:<a href="CCMultiMap.S.html#TYPEt">t</a> -><br> (<a href="CCMultiMap.S.html#TYPEkey">key</a> * <a href="CCMultiMap.S.html#TYPEvalue">value</a>) <a href="CCMultiMap.html#TYPEsequence">CCMultiMap.sequence</a> -> <a href="CCMultiMap.S.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALkeys"><span class="keyword">val</span> keys</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEkey">key</a> <a href="CCMultiMap.html#TYPEsequence">CCMultiMap.sequence</a></code></pre>
|
|
<pre><span id="VALvalues"><span class="keyword">val</span> values</span> : <code class="type"><a href="CCMultiMap.S.html#TYPEt">t</a> -> <a href="CCMultiMap.S.html#TYPEvalue">value</a> <a href="CCMultiMap.html#TYPEsequence">CCMultiMap.sequence</a></code></pre><div class="info ">
|
|
Some values may occur several times<br>
|
|
</div>
|
|
</body></html> |