mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-05 19:00:31 -05:00
200 lines
No EOL
13 KiB
HTML
200 lines
No EOL
13 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="Containers.Hashtbl.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="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 : Containers.Hashtbl.S'</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"> <a class="up" href="Containers.Hashtbl.html" title="Containers.Hashtbl">Up</a>
|
|
</div>
|
|
<h1>Module type <a href="type_Containers.Hashtbl.S'.html">Containers.Hashtbl.S'</a></h1>
|
|
|
|
<pre><span class="keyword">module type</span> S' = <code class="type"><a href="CCHashtbl.S.html">CCHashtbl.S</a></code></pre><hr width="100%">
|
|
|
|
<pre><span class="keyword">include</span> Hashtbl.S</pre>
|
|
|
|
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type">'a t -> key -> 'a option</code></pre><div class="info ">
|
|
Safe version of <code class="code"><span class="constructor">Hashtbl</span>.find</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALget_or"><span class="keyword">val</span> get_or</span> : <code class="type">'a t -> key -> default:'a -> 'a</code></pre><div class="info ">
|
|
<code class="code">get_or tbl k ~default</code> returns the value associated to <code class="code">k</code> if present,
|
|
and returns <code class="code">default</code> otherwise (if <code class="code">k</code> doesn't belong in <code class="code">tbl</code>)<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_list"><span class="keyword">val</span> add_list</span> : <code class="type">'a list t -> key -> 'a -> unit</code></pre><div class="info ">
|
|
<code class="code">add_list tbl x y</code> adds <code class="code">y</code> to the list <code class="code">x</code> is bound to. If <code class="code">x</code> is
|
|
not bound, it becomes bound to <code class="code">[y]</code>.<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
|
|
<pre><span id="VALincr"><span class="keyword">val</span> incr</span> : <code class="type">?by:int -> int t -> key -> unit</code></pre><div class="info ">
|
|
<code class="code">incr ?by tbl x</code> increments or initializes the counter associated with <code class="code">x</code>.
|
|
If <code class="code">get tbl x = <span class="constructor">None</span></code>, then after update, <code class="code">get tbl x = <span class="constructor">Some</span> 1</code>;
|
|
otherwise, if <code class="code">get tbl x = <span class="constructor">Some</span> n</code>, now <code class="code">get tbl x = <span class="constructor">Some</span> (n+1)</code>.<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
<div class="param_info"><code class="code">by</code> : if specified, the int value is incremented by <code class="code">by</code> rather than 1</div>
|
|
|
|
<pre><span id="VALdecr"><span class="keyword">val</span> decr</span> : <code class="type">?by:int -> int t -> key -> unit</code></pre><div class="info ">
|
|
Same as <a href="CCHashtbl.S.html#VALincr"><code class="code"><span class="constructor">CCHashtbl</span>.<span class="constructor">S</span>.incr</code></a> but substract 1 (or the value of <code class="code">by</code>).
|
|
If the value reaches 0, the key is removed from the table.
|
|
This does nothing if the key is not already present in the table.<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
|
|
<pre><span id="VALkeys"><span class="keyword">val</span> keys</span> : <code class="type">'a t -> key <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a></code></pre><div class="info ">
|
|
Iterate on keys (similar order as <code class="code"><span class="constructor">Hashtbl</span>.iter</code>)<br>
|
|
</div>
|
|
|
|
<pre><span id="VALvalues"><span class="keyword">val</span> values</span> : <code class="type">'a t -> 'a <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a></code></pre><div class="info ">
|
|
Iterate on values in the table<br>
|
|
</div>
|
|
|
|
<pre><span id="VALkeys_list"><span class="keyword">val</span> keys_list</span> : <code class="type">'a t -> key list</code></pre><div class="info ">
|
|
<code class="code">keys t</code> is the list of keys in <code class="code">t</code>.<br>
|
|
<b>Since</b> 0.8<br>
|
|
</div>
|
|
|
|
<pre><span id="VALvalues_list"><span class="keyword">val</span> values_list</span> : <code class="type">'a t -> 'a list</code></pre><div class="info ">
|
|
<code class="code">values t</code> is the list of values in <code class="code">t</code>.<br>
|
|
<b>Since</b> 0.8<br>
|
|
</div>
|
|
|
|
<pre><span id="VALmap_list"><span class="keyword">val</span> map_list</span> : <code class="type">(key -> 'a -> 'b) -> 'a t -> 'b list</code></pre><div class="info ">
|
|
Map on a hashtable's items, collect into a list<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_seq"><span class="keyword">val</span> to_seq</span> : <code class="type">'a t -> (key * 'a) <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a></code></pre><div class="info ">
|
|
Iterate on values in the table<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type">(key * 'a) <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a> -> 'a t</code></pre><div class="info ">
|
|
From the given bindings, added in order<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_seq"><span class="keyword">val</span> add_seq</span> : <code class="type">'a t -> (key * 'a) <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a> -> unit</code></pre><div class="info ">
|
|
Add the corresponding pairs to the table, using <code class="code"><span class="constructor">Hashtbl</span>.add</code>.<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_seq_count"><span class="keyword">val</span> add_seq_count</span> : <code class="type">int t -> key <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a> -> unit</code></pre><div class="info ">
|
|
<code class="code">add_seq_count tbl seq</code> increments the count of each element of <code class="code">seq</code>
|
|
by calling <a href="CCHashtbl.S.html#VALincr"><code class="code"><span class="constructor">CCHashtbl</span>.<span class="constructor">S</span>.incr</code></a>. This is useful for counting how many times each
|
|
element of <code class="code">seq</code> occurs.<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_seq_count"><span class="keyword">val</span> of_seq_count</span> : <code class="type">key <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a> -> int t</code></pre><div class="info ">
|
|
Similar to <a href="CCHashtbl.S.html#VALadd_seq_count"><code class="code"><span class="constructor">CCHashtbl</span>.<span class="constructor">S</span>.add_seq_count</code></a>, but allocates a new table and returns it<br>
|
|
<b>Since</b> 0.16<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type">'a t -> (key * 'a) list</code></pre><div class="info ">
|
|
List of bindings (order unspecified)<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">(key * 'a) list -> 'a t</code></pre><div class="info ">
|
|
Build a table from the given list of bindings <code class="code">k_i <span class="keywordsign">-></span> v_i</code>,
|
|
added in order using <code class="code">add</code>. If a key occurs several times,
|
|
it will be added several times, and the visible binding
|
|
will be the last one.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALupdate"><span class="keyword">val</span> update</span> : <code class="type">'a t -> f:(key -> 'a option -> 'a option) -> k:key -> unit</code></pre><div class="info ">
|
|
<code class="code">update tbl ~f ~k</code> updates key <code class="code">k</code> by calling <code class="code">f k (<span class="constructor">Some</span> v)</code> if
|
|
<code class="code">k</code> was mapped to <code class="code">v</code>, or <code class="code">f k <span class="constructor">None</span></code> otherwise; if the call
|
|
returns <code class="code"><span class="constructor">None</span></code> then <code class="code">k</code> is removed/stays removed, if the call
|
|
returns <code class="code"><span class="constructor">Some</span> v'</code> then the binding <code class="code">k <span class="keywordsign">-></span> v'</code> is inserted
|
|
using <code class="code"><span class="constructor">Hashtbl</span>.replace</code><br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALget_or_add"><span class="keyword">val</span> get_or_add</span> : <code class="type">'a t -> f:(key -> 'a) -> k:key -> 'a</code></pre><div class="info ">
|
|
<code class="code">get_or_add tbl ~k ~f</code> finds and returns the binding of <code class="code">k</code>
|
|
in <code class="code">tbl</code>, if it exists. If it does not exist, then <code class="code">f k</code>
|
|
is called to obtain a new binding <code class="code">v</code>; <code class="code">k <span class="keywordsign">-></span> v</code> is added
|
|
to <code class="code">tbl</code> and <code class="code">v</code> is returned.<br>
|
|
<b>Since</b> 1.0<br>
|
|
</div>
|
|
|
|
<pre><span id="VALprint"><span class="keyword">val</span> print</span> : <code class="type">key <a href="CCHashtbl.html#TYPEprinter">CCHashtbl.printer</a> -> 'a <a href="CCHashtbl.html#TYPEprinter">CCHashtbl.printer</a> -> 'a t <a href="CCHashtbl.html#TYPEprinter">CCHashtbl.printer</a></code></pre><div class="info ">
|
|
Printer for tables<br>
|
|
<b>Since</b> 0.13<br>
|
|
</div>
|
|
</body></html> |