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