mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
9 KiB
HTML
2 lines
No EOL
9 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-data.CCMultiMap.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers-data</a> » <a href="../index.html">CCMultiMap</a> » Make</nav><h1>Module <code>CCMultiMap.Make</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-K/index.html">K</a> : <a href="../index.html#module-type-OrderedType">OrderedType</a></code></li><li><code><a href="argument-2-V/index.html">V</a> : <a href="../index.html#module-type-OrderedType">OrderedType</a></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-key"><a href="#type-key" class="anchor"></a><code><span class="keyword">type</span> key</code><code> = <a href="argument-1-K/index.html#type-t">K.t</a></code></dt><dt class="spec type" id="type-value"><a href="#type-value" class="anchor"></a><code><span class="keyword">type</span> value</code><code> = <a href="argument-2-V/index.html#type-t">V.t</a></code></dt><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span class="keyword">val</span> empty : <a href="index.html#type-t">t</a></code></dt><dd><p>Empty multimap.</p></dd></dl><dl><dt class="spec value" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span class="keyword">val</span> is_empty : <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Empty multimap?</p></dd></dl><dl><dt class="spec value" id="val-add"><a href="#val-add" class="anchor"></a><code><span class="keyword">val</span> add : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> <a href="index.html#type-value">value</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Add a key/value binding.</p></dd></dl><dl><dt class="spec value" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span class="keyword">val</span> remove : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> <a href="index.html#type-value">value</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Remove the binding.</p></dd></dl><dl><dt class="spec value" id="val-remove_all"><a href="#val-remove_all" class="anchor"></a><code><span class="keyword">val</span> remove_all : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Remove the key from the map.</p></dd></dl><dl><dt class="spec value" id="val-mem"><a href="#val-mem" class="anchor"></a><code><span class="keyword">val</span> mem : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> bool</code></dt><dd><p>Is there a binding for this key?</p></dd></dl><dl><dt class="spec value" id="val-find"><a href="#val-find" class="anchor"></a><code><span class="keyword">val</span> find : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> <span><a href="index.html#type-value">value</a> list</span></code></dt><dd><p>List of values for this key.</p></dd></dl><dl><dt class="spec value" id="val-find_iter"><a href="#val-find_iter" class="anchor"></a><code><span class="keyword">val</span> find_iter : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> <span>(<a href="index.html#type-value">value</a> <span>-></span> unit)</span> <span>-></span> unit</code></dt><dd><p>Iterate on bindings for this key.</p></dd></dl><dl><dt class="spec value" id="val-count"><a href="#val-count" class="anchor"></a><code><span class="keyword">val</span> count : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> int</code></dt><dd><p>Number of bindings for this key.</p></dd></dl><dl><dt class="spec value" id="val-iter"><a href="#val-iter" class="anchor"></a><code><span class="keyword">val</span> iter : <a href="index.html#type-t">t</a> <span>-></span> <span>(<a href="index.html#type-key">key</a> <span>-></span> <a href="index.html#type-value">value</a> <span>-></span> unit)</span> <span>-></span> unit</code></dt><dd><p>Iterate on all key/value.</p></dd></dl><dl><dt class="spec value" id="val-fold"><a href="#val-fold" class="anchor"></a><code><span class="keyword">val</span> fold : <a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <a href="index.html#type-key">key</a> <span>-></span> <a href="index.html#type-value">value</a> <span>-></span> <span class="type-var">'a</span>)</span> <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Fold on all key/value.</p></dd></dl><dl><dt class="spec value" id="val-size"><a href="#val-size" class="anchor"></a><code><span class="keyword">val</span> size : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Number of keys.</p></dd></dl><dl><dt class="spec value" id="val-union"><a href="#val-union" class="anchor"></a><code><span class="keyword">val</span> union : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Union of multimaps.</p></dd></dl><dl><dt class="spec value" id="val-inter"><a href="#val-inter" class="anchor"></a><code><span class="keyword">val</span> inter : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Intersection of multimaps.</p></dd></dl><dl><dt class="spec value" id="val-diff"><a href="#val-diff" class="anchor"></a><code><span class="keyword">val</span> diff : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Difference of maps, i.e. bindings of the first that are not in the second.</p></dd></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Same multimap.</p></dd></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Total order on multimaps.</p></dd></dl><dl><dt class="spec value" id="val-submap"><a href="#val-submap" class="anchor"></a><code><span class="keyword">val</span> submap : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p><code>submap m1 m2</code> is <code>true</code> iff all bindings of <code>m1</code> are also in <code>m2</code>.</p></dd></dl><dl><dt class="spec value" id="val-to_iter"><a href="#val-to_iter" class="anchor"></a><code><span class="keyword">val</span> to_iter : <a href="index.html#type-t">t</a> <span>-></span> <span><span>(<a href="index.html#type-key">key</a> * <a href="index.html#type-value">value</a>)</span> <a href="../index.html#type-iter">iter</a></span></code></dt><dt class="spec value" id="val-of_iter"><a href="#val-of_iter" class="anchor"></a><code><span class="keyword">val</span> of_iter : <span>?⁠init:<a href="index.html#type-t">t</a></span> <span>-></span> <span><span>(<a href="index.html#type-key">key</a> * <a href="index.html#type-value">value</a>)</span> <a href="../index.html#type-iter">iter</a></span> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-keys"><a href="#val-keys" class="anchor"></a><code><span class="keyword">val</span> keys : <a href="index.html#type-t">t</a> <span>-></span> <span><a href="index.html#type-key">key</a> <a href="../index.html#type-iter">iter</a></span></code></dt><dt class="spec value" id="val-values"><a href="#val-values" class="anchor"></a><code><span class="keyword">val</span> values : <a href="index.html#type-t">t</a> <span>-></span> <span><a href="index.html#type-value">value</a> <a href="../index.html#type-iter">iter</a></span></code></dt><dd><p>Some values may occur several times.</p></dd></dl></div></body></html> |