mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-07 03:35:30 -05:00
2 lines
No EOL
10 KiB
HTML
2 lines
No EOL
10 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MakeBidir (containers.CCMultiMap.MakeBidir)</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.MakeBidir</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-2-R"><a href="#argument-2-R" class="anchor"></a><div class="def argument"><code><a href="argument-2-R/index.html">R</a> : <a href="../index.html#module-type-OrderedType">OrderedType</a></code></div><div class="doc"></div></div><div class="spec argument" id="argument-1-L"><a href="#argument-1-L" class="anchor"></a><div class="def argument"><code><a href="argument-1-L/index.html">L</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-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 type" id="type-left"><a href="#type-left" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>left</code><code><span class="keyword"> = </span><a href="argument-1-L/index.html#type-t">L.t</a></code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-right"><a href="#type-right" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>right</code><code><span class="keyword"> = </span><a href="argument-2-R/index.html#type-t">R.t</a></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"></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"></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-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Add a binding (left,right).</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-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Remove a specific binding.</p></div></div><div class="spec val" id="val-cardinal_left"><a href="#val-cardinal_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>cardinal_left : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Number of distinct left keys.</p></div></div><div class="spec val" id="val-cardinal_right"><a href="#val-cardinal_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>cardinal_right : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Number of distinct right keys.</p></div></div><div class="spec val" id="val-remove_left"><a href="#val-remove_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_left : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Remove all bindings for the left key.</p></div></div><div class="spec val" id="val-remove_right"><a href="#val-remove_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_right : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Remove all bindings for the right key.</p></div></div><div class="spec val" id="val-mem_left"><a href="#val-mem_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>mem_left : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Is the left key present in at least one pair?</p></div></div><div class="spec val" id="val-mem_right"><a href="#val-mem_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>mem_right : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Is the right key present in at least one pair?</p></div></div><div class="spec val" id="val-find_left"><a href="#val-find_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find_left : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Find all bindings for this given left-key.</p></div></div><div class="spec val" id="val-find_right"><a href="#val-find_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find_right : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Find all bindings for this given right-key.</p></div></div><div class="spec val" id="val-find1_left"><a href="#val-find1_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find1_left : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> option</code></div><div class="doc"><p>Like <a href="index.html#val-find_left">find_left</a> but returns at most one value.</p></div></div><div class="spec val" id="val-find1_right"><a href="#val-find1_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find1_right : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> option</code></div><div class="doc"><p>Like <a href="index.html#val-find_right">find_right</a> but returns at most one 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 : (<span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</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-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold on pairs.</p></div></div><div class="spec val" id="val-pairs"><a href="#val-pairs" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pairs : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-left">left</a><span class="keyword"> * </span><a href="index.html#type-right">right</a>) <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on pairs.</p></div></div><div class="spec val" id="val-add_pairs"><a href="#val-add_pairs" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_pairs : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-left">left</a><span class="keyword"> * </span><a href="index.html#type-right">right</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"><p>Add pairs.</p></div></div><div class="spec val" id="val-seq_left"><a href="#val-seq_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>seq_left : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div><div class="spec val" id="val-seq_right"><a href="#val-seq_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>seq_right : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div></body></html> |