mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
187 lines
No EOL
11 KiB
HTML
187 lines
No EOL
11 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="previous" href="CCHashtbl.MakeDefault.html">
|
|
<link rel="Up" href="CCHashtbl.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 : CCHashtbl.MakeCounter</title>
|
|
</head>
|
|
<body>
|
|
<div class="navbar"><a class="pre" href="CCHashtbl.MakeDefault.html" title="CCHashtbl.MakeDefault">Previous</a>
|
|
<a class="up" href="CCHashtbl.html" title="CCHashtbl">Up</a>
|
|
</div>
|
|
<h1>Functor <a href="type_CCHashtbl.MakeCounter.html">CCHashtbl.MakeCounter</a></h1>
|
|
|
|
<pre><span class="keyword">module</span> MakeCounter <code class="code">(</code><code class="code"><span class="constructor">X</span></code><code class="code"> : </code><code class="type">Hashtbl.HashedType</code><code class="code">) </code>: <code class="type"><a href="CCHashtbl.COUNTER.html">COUNTER</a></code><code class="type">
|
|
with type elt = X.t
|
|
and type t = int Hashtbl.Make(X).t</code></pre><div class="info module top">
|
|
Create a new counter type
|
|
The type <code class="code">t</code> is exposed<br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
<table border="0" cellpadding="3" width="100%">
|
|
<tr>
|
|
<td align="left" valign="top" width="1%%"><b>Parameters: </b></td>
|
|
<td>
|
|
<table class="paramstable">
|
|
<tr>
|
|
<td align="center" valign="top" width="15%">
|
|
<code>X</code></td>
|
|
<td align="center" valign="top">:</td>
|
|
<td><code class="type">Hashtbl.HashedType</code>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr width="100%">
|
|
|
|
<pre><span id="TYPEelt"><span class="keyword">type</span> <code class="type"></code>elt</span> </pre>
|
|
<div class="info ">
|
|
Elements that are to be counted<br>
|
|
</div>
|
|
|
|
|
|
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
|
|
|
|
|
|
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type">int -> <a href="CCHashtbl.COUNTER.html#TYPEt">t</a></code></pre><div class="info ">
|
|
A counter maps elements to natural numbers (the number of times this
|
|
element occurred)<br>
|
|
</div>
|
|
|
|
<pre><span id="VALincr"><span class="keyword">val</span> incr</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> <a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> -> unit</code></pre><div class="info ">
|
|
Increment the counter for the given element<br>
|
|
</div>
|
|
|
|
<pre><span id="VALincr_by"><span class="keyword">val</span> incr_by</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> int -> <a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> -> unit</code></pre><div class="info ">
|
|
Add or remove several occurrences at once. <code class="code">incr_by c x n</code>
|
|
will add <code class="code">n</code> occurrences of <code class="code">x</code> if <code class="code">n>0</code>,
|
|
and remove <code class="code">abs n</code> occurrences if <code class="code">n<0</code>.<br>
|
|
</div>
|
|
|
|
<pre><span id="VALget"><span class="keyword">val</span> get</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> <a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> -> int</code></pre><div class="info ">
|
|
Number of occurrences for this element<br>
|
|
</div>
|
|
|
|
<pre><span id="VALdecr"><span class="keyword">val</span> decr</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> <a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> -> unit</code></pre><div class="info ">
|
|
Remove one occurrence of the element<br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALlength"><span class="keyword">val</span> length</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> int</code></pre><div class="info ">
|
|
Number of distinct elements<br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_seq"><span class="keyword">val</span> add_seq</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> <a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a> -> unit</code></pre><div class="info ">
|
|
Increment each element of the sequence<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_seq"><span class="keyword">val</span> of_seq</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a> -> <a href="CCHashtbl.COUNTER.html#TYPEt">t</a></code></pre><div class="info ">
|
|
<code class="code">of_seq s</code> is the same as <code class="code">add_seq (create ())</code><br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_seq"><span class="keyword">val</span> to_seq</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> (<a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> * int) <a href="CCHashtbl.html#TYPEsequence">CCHashtbl.sequence</a></code></pre><div class="info ">
|
|
<code class="code">to_seq tbl</code> returns elements of <code class="code">tbl</code> along with their multiplicity<br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALadd_list"><span class="keyword">val</span> add_list</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> (<a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> * int) list -> unit</code></pre><div class="info ">
|
|
Similar to <a href="CCHashtbl.COUNTER.html#VALadd_seq"><code class="code"><span class="constructor">CCHashtbl</span>.<span class="constructor">COUNTER</span>.add_seq</code></a><br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALof_list"><span class="keyword">val</span> of_list</span> : <code class="type">(<a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> * int) list -> <a href="CCHashtbl.COUNTER.html#TYPEt">t</a></code></pre><div class="info ">
|
|
Similar to <a href="CCHashtbl.COUNTER.html#VALof_seq"><code class="code"><span class="constructor">CCHashtbl</span>.<span class="constructor">COUNTER</span>.of_seq</code></a><br>
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
|
|
<pre><span id="VALto_list"><span class="keyword">val</span> to_list</span> : <code class="type"><a href="CCHashtbl.COUNTER.html#TYPEt">t</a> -> (<a href="CCHashtbl.COUNTER.html#TYPEelt">elt</a> * int) list</code></pre><div class="info ">
|
|
<b>Since</b> 0.14<br>
|
|
</div>
|
|
</body></html> |