ocaml-containers/dev/CCLinq.PMap.html
2016-08-22 10:17:49 +02:00

147 lines
No EOL
9.8 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="CCLinq.Infix.html">
<link rel="Up" href="CCLinq.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"><title>Containers doc : CCLinq.PMap</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="CCLinq.html" title="CCLinq">Up</a>
&nbsp;<a class="post" href="CCLinq.Infix.html" title="CCLinq.Infix">Next</a>
</div>
<h1>Module <a href="type_CCLinq.PMap.html">CCLinq.PMap</a></h1>
<pre><span class="keyword">module</span> PMap: <code class="code"><span class="keyword">sig</span></code> <a href="CCLinq.PMap.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
<h2 id="2_PolymorphicMaps">Polymorphic Maps</h2><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="VALget"><span class="keyword">val</span> get</span> : <code class="type">('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> 'a -> 'b option</code></pre>
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> int</code></pre>
<pre><span id="VALto_seq"><span class="keyword">val</span> to_seq</span> : <code class="type">('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('a * 'b) <a href="CCLinq.html#TYPEsequence">CCLinq.sequence</a></code></pre>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('b -> 'c) -> ('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('a, 'c) <a href="CCLinq.PMap.html#TYPEt">t</a></code></pre><div class="info ">
Transform values<br>
</div>
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('a * 'b) list</code></pre>
<pre><span id="VALreverse"><span class="keyword">val</span> reverse</span> : <code class="type">?cmp:'b <a href="CCLinq.html#TYPEord">CCLinq.ord</a> -><br> ?eq:'b <a href="CCLinq.html#TYPEequal">CCLinq.equal</a> -><br> ?hash:'b <a href="CCLinq.html#TYPEhash">CCLinq.hash</a> -><br> unit -> ('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('b, 'a list) <a href="CCLinq.PMap.html#TYPEt">t</a></code></pre><div class="info ">
Reverse relation of the map, as a multimap<br>
</div>
<pre><span id="VALreverse_multimap"><span class="keyword">val</span> reverse_multimap</span> : <code class="type">?cmp:'b <a href="CCLinq.html#TYPEord">CCLinq.ord</a> -><br> ?eq:'b <a href="CCLinq.html#TYPEequal">CCLinq.equal</a> -><br> ?hash:'b <a href="CCLinq.html#TYPEhash">CCLinq.hash</a> -><br> unit -> ('a, 'b list) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('b, 'a list) <a href="CCLinq.PMap.html#TYPEt">t</a></code></pre><div class="info ">
Reverse relation of the multimap<br>
</div>
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">('acc -> 'a -> 'b -> 'acc) -> 'acc -> ('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> 'acc</code></pre><div class="info ">
Fold on the items of the map<br>
</div>
<pre><span id="VALfold_multimap"><span class="keyword">val</span> fold_multimap</span> : <code class="type">('acc -> 'a -> 'b -> 'acc) -> 'acc -> ('a, 'b list) <a href="CCLinq.PMap.html#TYPEt">t</a> -> 'acc</code></pre><div class="info ">
Fold on the items of the multimap<br>
</div>
<pre><span id="VALget_seq"><span class="keyword">val</span> get_seq</span> : <code class="type">'a -> ('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> 'b <a href="CCLinq.html#TYPEsequence">CCLinq.sequence</a></code></pre><div class="info ">
Select a key from a map and wrap into sequence<br>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a, 'b) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('a * 'b) <a href="CCLinq.html#TYPEsequence">CCLinq.sequence</a></code></pre><div class="info ">
View a multimap as a proper collection<br>
</div>
<pre><span id="VALflatten"><span class="keyword">val</span> flatten</span> : <code class="type">('a, 'b <a href="CCLinq.html#TYPEsequence">CCLinq.sequence</a>) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('a * 'b) <a href="CCLinq.html#TYPEsequence">CCLinq.sequence</a></code></pre><div class="info ">
View a multimap as a collection of individual key/value pairs<br>
</div>
<pre><span id="VALflatten_l"><span class="keyword">val</span> flatten_l</span> : <code class="type">('a, 'b list) <a href="CCLinq.PMap.html#TYPEt">t</a> -> ('a * 'b) <a href="CCLinq.html#TYPEsequence">CCLinq.sequence</a></code></pre><div class="info ">
View a multimap as a list of individual key/value pairs<br>
</div>
</body></html>