mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
208 lines
No EOL
15 KiB
HTML
208 lines
No EOL
15 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">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="Start" href="index.html">
|
|
<link rel="previous" href="CCRingBuffer.html">
|
|
<link rel="next" href="CCPersistentArray.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 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="CCEqual" rel="Chapter" href="CCEqual.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="CCSimple_queue" rel="Chapter" href="CCSimple_queue.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="Whole-collection operations" rel="Section" href="#2_Wholecollectionoperations">
|
|
<link title="IO" rel="Section" href="#2_IO">
|
|
<title>Containers doc : CCIntMap</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="CCRingBuffer.html" title="CCRingBuffer">Previous</a>
|
|
<a class="up" href="index.html" title="Index">Up</a>
|
|
<a class="post" href="CCPersistentArray.html" title="CCPersistentArray">Next</a>
|
|
</div>
|
|
<h1>Module <a href="type_CCIntMap.html">CCIntMap</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> CCIntMap: <code class="code"><span class="keyword">sig</span></code> <a href="CCIntMap.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
|
|
<h1 id="1_MapspecializedforIntkeys">Map specialized for Int keys</h1>
|
|
<p>
|
|
|
|
<b>status: stable</b><br>
|
|
<b>Since</b> 0.10<br>
|
|
</div>
|
|
<hr width="100%">
|
|
|
|
<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="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALsingleton"><span class="keyword">val</span> singleton</span> : <code class="type">int -> 'a -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALdoubleton"><span class="keyword">val</span> doubleton</span> : <code class="type">int -> 'a -> int -> 'a -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALmem"><span class="keyword">val</span> mem</span> : <code class="type">int -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> bool</code></pre>
|
|
<pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type">int -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a option</code></pre>
|
|
<pre><span id="VALfind_exn"><span class="keyword">val</span> find_exn</span> : <code class="type">int -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
|
|
Same as <a href="CCIntMap.html#VALfind"><code class="code"><span class="constructor">CCIntMap</span>.find</code></a> but unsafe<br>
|
|
<b>Raises</b> <code>Not_found</code> if key not present<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">int -> 'a -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type">int -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">eq:('a -> 'a -> bool) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
|
|
<code class="code">equal ~eq a b</code> checks whether <code class="code">a</code> and <code class="code">b</code> have the same set of pairs
|
|
(key, value), comparing values with <code class="code">eq</code><br>
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">cmp:('a -> 'a -> int) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Total order between maps; the precise order is unspecified .<br>
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type">int -> ('a option -> 'a option) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALcardinal"><span class="keyword">val</span> cardinal</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of bindings in the map. Linear time<br>
|
|
</div>
|
|
|
|
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">(int -> 'a -> unit) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> unit</code></pre>
|
|
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">(int -> 'a -> 'b -> 'b) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'b -> 'b</code></pre>
|
|
<pre><span id="VALmapi"><span class="keyword">val</span> mapi</span> : <code class="type">(int -> 'a -> 'b) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'b <a href="CCIntMap.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<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="CCIntMap.html#TYPEt">t</a> -> 'b <a href="CCIntMap.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.17<br>
|
|
</div>
|
|
|
|
<pre><span id="VALchoose"><span class="keyword">val</span> choose</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) option</code></pre>
|
|
<pre><span id="VALchoose_exn"><span class="keyword">val</span> choose_exn</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> int * 'a</code></pre><div class="info ">
|
|
<b>Raises</b> <code>Not_found</code> if not pair was found<br>
|
|
</div>
|
|
|
|
<pre><span id="VALunion"><span class="keyword">val</span> union</span> : <code class="type">(int -> 'a -> 'a -> 'a) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALinter"><span class="keyword">val</span> inter</span> : <code class="type">(int -> 'a -> 'a -> 'a) -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre><br>
|
|
<h2 id="2_Wholecollectionoperations">Whole-collection operations</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="TYPEgen"><span class="keyword">type</span> <code class="type">'a</code> gen</span> = <code class="type">unit -> 'a option</code> </pre>
|
|
|
|
|
|
<pre><span id="TYPEklist"><span class="keyword">type</span> <code class="type">'a</code> klist</span> = <code class="type">unit -> [ `Cons of 'a * 'a <a href="CCIntMap.html#TYPEklist">klist</a> | `Nil ]</code> </pre>
|
|
|
|
|
|
<pre><span id="VALadd_list"><span class="keyword">val</span> add_list</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) list -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">(int * 'a) list -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) list</code></pre>
|
|
<pre><span id="VALadd_seq"><span class="keyword">val</span> add_seq</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) <a href="CCIntMap.html#TYPEsequence">sequence</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre>
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type">(int * 'a) <a href="CCIntMap.html#TYPEsequence">sequence</a> -> 'a <a href="CCIntMap.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="CCIntMap.html#TYPEt">t</a> -> (int * 'a) <a href="CCIntMap.html#TYPEsequence">sequence</a></code></pre>
|
|
<pre><span id="VALkeys"><span class="keyword">val</span> keys</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> int <a href="CCIntMap.html#TYPEsequence">sequence</a></code></pre>
|
|
<pre><span id="VALvalues"><span class="keyword">val</span> values</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> 'a <a href="CCIntMap.html#TYPEsequence">sequence</a></code></pre>
|
|
<pre><span id="VALadd_gen"><span class="keyword">val</span> add_gen</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) <a href="CCIntMap.html#TYPEgen">gen</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_gen"><span class="keyword">val</span> of_gen</span> : <code class="type">(int * 'a) <a href="CCIntMap.html#TYPEgen">gen</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_gen"><span class="keyword">val</span> to_gen</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) <a href="CCIntMap.html#TYPEgen">gen</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_klist"><span class="keyword">val</span> add_klist</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) <a href="CCIntMap.html#TYPEklist">klist</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_klist"><span class="keyword">val</span> of_klist</span> : <code class="type">(int * 'a) <a href="CCIntMap.html#TYPEklist">klist</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_klist"><span class="keyword">val</span> to_klist</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> (int * 'a) <a href="CCIntMap.html#TYPEklist">klist</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
|
|
<pre><span id="TYPEtree"><span class="keyword">type</span> <code class="type">'a</code> tree</span> = <code class="type">unit -> [ `Nil | `Node of 'a * 'a <a href="CCIntMap.html#TYPEtree">tree</a> list ]</code> </pre>
|
|
|
|
|
|
<pre><span id="VALas_tree"><span class="keyword">val</span> as_tree</span> : <code class="type">'a <a href="CCIntMap.html#TYPEt">t</a> -> [ `Leaf of int * 'a | `Node of int * int ] <a href="CCIntMap.html#TYPEtree">tree</a></code></pre><br>
|
|
<h2 id="2_IO">IO</h2><br>
|
|
|
|
<pre><span id="TYPEprinter"><span class="keyword">type</span> <code class="type">'a</code> printer</span> = <code class="type">Format.formatter -> 'a -> unit</code> </pre>
|
|
|
|
|
|
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type">'a <a href="CCIntMap.html#TYPEprinter">printer</a> -> 'a <a href="CCIntMap.html#TYPEt">t</a> <a href="CCIntMap.html#TYPEprinter">printer</a></code></pre><div class="info ">
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
<br>
|
|
Helpers<br>
|
|
</body></html> |