<!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=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="BatMarshal.html">
<link rel="next" href="BatMultiPMap.html">
<link rel="Up" href="index.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 classes" rel=Appendix href="index_classes.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="BatArray" rel="Chapter" href="BatArray.html">
<link title="BatAvlTree" rel="Chapter" href="BatAvlTree.html">
<link title="BatBase64" rel="Chapter" href="BatBase64.html">
<link title="BatBig_int" rel="Chapter" href="BatBig_int.html">
<link title="BatBigarray" rel="Chapter" href="BatBigarray.html">
<link title="BatBitSet" rel="Chapter" href="BatBitSet.html">
<link title="BatBool" rel="Chapter" href="BatBool.html">
<link title="BatBounded" rel="Chapter" href="BatBounded.html">
<link title="BatBuffer" rel="Chapter" href="BatBuffer.html">
<link title="BatCache" rel="Chapter" href="BatCache.html">
<link title="BatChar" rel="Chapter" href="BatChar.html">
<link title="BatCharParser" rel="Chapter" href="BatCharParser.html">
<link title="BatComplex" rel="Chapter" href="BatComplex.html">
<link title="BatConcurrent" rel="Chapter" href="BatConcurrent.html">
<link title="BatDeque" rel="Chapter" href="BatDeque.html">
<link title="BatDigest" rel="Chapter" href="BatDigest.html">
<link title="BatDllist" rel="Chapter" href="BatDllist.html">
<link title="BatDynArray" rel="Chapter" href="BatDynArray.html">
<link title="BatEnum" rel="Chapter" href="BatEnum.html">
<link title="BatFile" rel="Chapter" href="BatFile.html">
<link title="BatFingerTree" rel="Chapter" href="BatFingerTree.html">
<link title="BatFloat" rel="Chapter" href="BatFloat.html">
<link title="BatFormat" rel="Chapter" href="BatFormat.html">
<link title="BatGc" rel="Chapter" href="BatGc.html">
<link title="BatGenlex" rel="Chapter" href="BatGenlex.html">
<link title="BatGlobal" rel="Chapter" href="BatGlobal.html">
<link title="BatHashcons" rel="Chapter" href="BatHashcons.html">
<link title="BatHashtbl" rel="Chapter" href="BatHashtbl.html">
<link title="BatHeap" rel="Chapter" href="BatHeap.html">
<link title="BatIMap" rel="Chapter" href="BatIMap.html">
<link title="BatIO" rel="Chapter" href="BatIO.html">
<link title="BatISet" rel="Chapter" href="BatISet.html">
<link title="BatInnerIO" rel="Chapter" href="BatInnerIO.html">
<link title="BatInnerPervasives" rel="Chapter" href="BatInnerPervasives.html">
<link title="BatInnerWeaktbl" rel="Chapter" href="BatInnerWeaktbl.html">
<link title="BatInt" rel="Chapter" href="BatInt.html">
<link title="BatInt32" rel="Chapter" href="BatInt32.html">
<link title="BatInt64" rel="Chapter" href="BatInt64.html">
<link title="BatInterfaces" rel="Chapter" href="BatInterfaces.html">
<link title="BatLazyList" rel="Chapter" href="BatLazyList.html">
<link title="BatLexing" rel="Chapter" href="BatLexing.html">
<link title="BatList" rel="Chapter" href="BatList.html">
<link title="BatLog" rel="Chapter" href="BatLog.html">
<link title="BatLogger" rel="Chapter" href="BatLogger.html">
<link title="BatMap" rel="Chapter" href="BatMap.html">
<link title="BatMarshal" rel="Chapter" href="BatMarshal.html">
<link title="BatMultiMap" rel="Chapter" href="BatMultiMap.html">
<link title="BatMultiPMap" rel="Chapter" href="BatMultiPMap.html">
<link title="BatMutex" rel="Chapter" href="BatMutex.html">
<link title="BatNativeint" rel="Chapter" href="BatNativeint.html">
<link title="BatNum" rel="Chapter" href="BatNum.html">
<link title="BatNumber" rel="Chapter" href="BatNumber.html">
<link title="BatOo" rel="Chapter" href="BatOo.html">
<link title="BatOptParse" rel="Chapter" href="BatOptParse.html">
<link title="BatOption" rel="Chapter" href="BatOption.html">
<link title="BatOrd" rel="Chapter" href="BatOrd.html">
<link title="BatParserCo" rel="Chapter" href="BatParserCo.html">
<link title="BatPathGen" rel="Chapter" href="BatPathGen.html">
<link title="BatPervasives" rel="Chapter" href="BatPervasives.html">
<link title="BatPrintexc" rel="Chapter" href="BatPrintexc.html">
<link title="BatPrintf" rel="Chapter" href="BatPrintf.html">
<link title="BatQueue" rel="Chapter" href="BatQueue.html">
<link title="BatRMutex" rel="Chapter" href="BatRMutex.html">
<link title="BatRandom" rel="Chapter" href="BatRandom.html">
<link title="BatRef" rel="Chapter" href="BatRef.html">
<link title="BatRefList" rel="Chapter" href="BatRefList.html">
<link title="BatResult" rel="Chapter" href="BatResult.html">
<link title="BatReturn" rel="Chapter" href="BatReturn.html">
<link title="BatScanf" rel="Chapter" href="BatScanf.html">
<link title="BatSeq" rel="Chapter" href="BatSeq.html">
<link title="BatSet" rel="Chapter" href="BatSet.html">
<link title="BatSplay" rel="Chapter" href="BatSplay.html">
<link title="BatStack" rel="Chapter" href="BatStack.html">
<link title="BatStream" rel="Chapter" href="BatStream.html">
<link title="BatString" rel="Chapter" href="BatString.html">
<link title="BatSubstring" rel="Chapter" href="BatSubstring.html">
<link title="BatSys" rel="Chapter" href="BatSys.html">
<link title="BatText" rel="Chapter" href="BatText.html">
<link title="BatTuple" rel="Chapter" href="BatTuple.html">
<link title="BatUChar" rel="Chapter" href="BatUChar.html">
<link title="BatUTF8" rel="Chapter" href="BatUTF8.html">
<link title="BatUnit" rel="Chapter" href="BatUnit.html">
<link title="BatUnix" rel="Chapter" href="BatUnix.html">
<link title="BatUref" rel="Chapter" href="BatUref.html">
<link title="BatVect" rel="Chapter" href="BatVect.html">
<link title="Batteries" rel="Chapter" href="Batteries.html">
<link title="BatteriesConfig" rel="Chapter" href="BatteriesConfig.html">
<link title="BatteriesPrint" rel="Chapter" href="BatteriesPrint.html">
<link title="BatteriesThread" rel="Chapter" href="BatteriesThread.html">
<link title="Extlib" rel="Chapter" href="Extlib.html"><link title="Boilerplate code" rel="Section" href="#6_Boilerplatecode">
<link title="Printing" rel="Subsection" href="#7_Printing">
<title>Batteries user guide : BatMultiMap</title>
</head>
<body>
<div class="navbar"><a class="pre" href="BatMarshal.html" title="BatMarshal">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="BatMultiPMap.html" title="BatMultiPMap">Next</a>
</div>
<h1>Module <a href="type_BatMultiMap.html">BatMultiMap</a></h1>
<pre><span class="keyword">module</span> BatMultiMap: <code class="code"><span class="keyword">sig</span></code> <a href="BatMultiMap.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
Polymorphic Multi-Map.
<p>
This is a polymorphic multi-map, i.e. an association from 1 to many.
<p>
This implementation uses <code class="code"><span class="constructor">Pervasives</span>.compare</code> to compare both keys and
values.<br>
<b>Author(s):</b> Xavier Leroy, Nicolas Cannasse, Markus Mottle, David Teller<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">('a, 'b)</code> t</span> </pre>
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
The empty map, using <code class="code">compare</code> as key comparison function.<br>
</div>
<pre><span id="VALis_empty"><span class="keyword">val</span> is_empty</span> : <code class="type">('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
returns true if the map is empty.<br>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">'a -> 'b -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">add x y m</code> returns a map containing the same bindings as
<code class="code">m</code>, plus a binding of <code class="code">x</code> to <code class="code">y</code>.<br>
</div>
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">'a -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a></code></pre><div class="info ">
<code class="code">find x m</code> returns the current binding of <code class="code">x</code> in <code class="code">m</code><br>
</div>
<pre><span id="VALremove_all"><span class="keyword">val</span> remove_all</span> : <code class="type">'a -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">remove_all x m</code> returns a map containing the same bindings as
<code class="code">m</code>, except for <code class="code">x</code> which is unbound in the returned map.<br>
</div>
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type">'a -> 'b -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">remove k d m</code> returns a map containing the same bindings as
<code class="code">m</code>, except for <code class="code">k</code> which is not bound to <code class="code">d</code> anymore in the returned
map. If <code class="code">k</code> was not bound to <code class="code">d</code>, nothing is changed. If the operation
removes the last binding of <code class="code">k</code>, then <code class="code">k</code> is also removed from the set
of keys.<br>
</div>
<pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type">'a -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<code class="code">mem x m</code> returns <code class="code"><span class="keyword">true</span></code> if <code class="code">m</code> contains at least a binding for <code class="code">x</code>,
and <code class="code"><span class="keyword">false</span></code> otherwise.<br>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a> -> unit) -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<code class="code">iter f m</code> applies <code class="code">f</code> to all bindings in map <code class="code">m</code>.
<code class="code">f</code> receives the key as first argument, and the associated value
as second argument. The order in which the bindings are passed to
<code class="code">f</code> is unspecified. Only current bindings are presented to <code class="code">f</code>:
bindings hidden by more recent bindings are not passed to <code class="code">f</code>.<br>
</div>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('b <a href="BatSet.html#TYPEt">BatSet.t</a> -> 'c <a href="BatSet.html#TYPEt">BatSet.t</a>) -><br> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'c) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">map f m</code> returns a map with same domain as <code class="code">m</code>, where the
associated value <code class="code">a</code> of all bindings of <code class="code">m</code> has been
replaced by the result of the application of <code class="code">f</code> to <code class="code">a</code>.
The order in which the associated values are passed to <code class="code">f</code>
is unspecified.<br>
</div>
<pre><span id="VALmapi"><span class="keyword">val</span> mapi</span> : <code class="type">('a -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a> -> 'c <a href="BatSet.html#TYPEt">BatSet.t</a>) -><br> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'c) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
Same as <code class="code">map</code>, but the function receives as arguments both the
key and the associated value for each binding of the map.<br>
</div>
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('b <a href="BatSet.html#TYPEt">BatSet.t</a> -> 'c -> 'c) -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> 'c -> 'c</code></pre><div class="info ">
<code class="code">fold f m a</code> computes <code class="code">(f kN dN ... (f k1 d1 (f k0 d0 a))...)</code>,
where <code class="code">k0,k1..kN</code> are the keys of all bindings in <code class="code">m</code>,
and <code class="code">d0,d1..dN</code> are the associated data.
The order in which the bindings are presented to <code class="code">f</code> is
unspecified.<br>
</div>
<pre><span id="VALfoldi"><span class="keyword">val</span> foldi</span> : <code class="type">('a -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a> -> 'c -> 'c) -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> 'c -> 'c</code></pre><div class="info ">
Same as <code class="code">fold</code>, but the function receives as arguments both the
key and the associated value for each binding of the map.<br>
</div>
<pre><span id="VALmodify"><span class="keyword">val</span> modify</span> : <code class="type">'a -><br> ('b <a href="BatSet.html#TYPEt">BatSet.t</a> -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a>) -><br> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">modify x f m</code> replaces the binding for <code class="code">x</code> with <code class="code">f</code> applied to
these values.<br>
<b>Since</b> 2.1<br>
<b>Raises</b> <code>Not_found</code> is <code class="code">x</code> is unbound in <code class="code">m</code><br>
</div>
<pre><span id="VALmodify_def"><span class="keyword">val</span> modify_def</span> : <code class="type">'b <a href="BatSet.html#TYPEt">BatSet.t</a> -><br> 'a -><br> ('b <a href="BatSet.html#TYPEt">BatSet.t</a> -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a>) -><br> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">modify_def dfl x f m</code> performs as <code class="code">modify x f m</code> but it adds
<code class="code">f dfl</code> in <code class="code">m</code> instead of raising <code class="code"><span class="constructor">Not_found</span></code> if <code class="code">x</code> was unbound.<br>
<b>Since</b> 2.1<br>
</div>
<pre><span id="VALmodify_opt"><span class="keyword">val</span> modify_opt</span> : <code class="type">'a -><br> ('b <a href="BatSet.html#TYPEt">BatSet.t</a> option -> 'b <a href="BatSet.html#TYPEt">BatSet.t</a> option) -><br> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">modify_opt x f m</code> allows to modify the bindings for <code class="code">k</code> in <code class="code">m</code>
or absence thereof.<br>
<b>Since</b> 2.1<br>
</div>
<pre><span id="VALenum"><span class="keyword">val</span> enum</span> : <code class="type">('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a> -> ('a * 'b) <a href="BatEnum.html#TYPEt">BatEnum.t</a></code></pre><div class="info ">
creates an enumeration for this map.<br>
</div>
<pre><span id="VALof_enum"><span class="keyword">val</span> of_enum</span> : <code class="type">('a * 'b) <a href="BatEnum.html#TYPEt">BatEnum.t</a> -> ('a, 'b) <a href="BatMultiMap.html#TYPEt">t</a></code></pre><div class="info ">
creates a map from an enumeration, using the specified function
for key comparison or <code class="code">compare</code> by default.<br>
</div>
<pre><span class="keyword">module</span> <a href="BatMultiMap.Infix.html">Infix</a>: <code class="code"><span class="keyword">sig</span></code> <a href="BatMultiMap.Infix.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Infix operators over a <a href="BatMultiPMap.html"><code class="code"><span class="constructor">BatMultiPMap</span></code></a>
</div>
<br>
<h6 id="6_Boilerplatecode">Boilerplate code</h6><br>
<br>
<div class="h7" id="7_Printing">Printing</div><br>
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type">?first:string -><br> ?last:string -><br> ?sep:string -><br> ?kvsep:string -><br> ('a <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> 'b -> unit) -><br> ('a <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> 'c -> unit) -><br> 'a <a href="BatInnerIO.html#TYPEoutput">BatInnerIO.output</a> -> ('b, 'c) <a href="BatMultiMap.html#TYPEt">t</a> -> unit</code></pre></body></html>
