mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
2 lines
No EOL
8.2 KiB
HTML
2 lines
No EOL
8.2 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"/><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</a> » <a href="../index.html">CCMultiMap</a> » MakeBidir</nav><h1>Module <code>CCMultiMap.MakeBidir</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-L/index.html">L</a> : <a href="../index.html#module-type-OrderedType">OrderedType</a></code></li><li><code><a href="argument-2-R/index.html">R</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-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dt class="spec type" id="type-left"><a href="#type-left" class="anchor"></a><code><span class="keyword">type</span> left</code><code> = <a href="argument-1-L/index.html#type-t">L.t</a></code></dt><dt class="spec type" id="type-right"><a href="#type-right" class="anchor"></a><code><span class="keyword">type</span> right</code><code> = <a href="argument-2-R/index.html#type-t">R.t</a></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><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><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-left">left</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Add a binding (left,right).</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-left">left</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Remove a specific binding.</p></dd></dl><dl><dt class="spec value" id="val-cardinal_left"><a href="#val-cardinal_left" class="anchor"></a><code><span class="keyword">val</span> cardinal_left : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Number of distinct left keys.</p></dd></dl><dl><dt class="spec value" id="val-cardinal_right"><a href="#val-cardinal_right" class="anchor"></a><code><span class="keyword">val</span> cardinal_right : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Number of distinct right keys.</p></dd></dl><dl><dt class="spec value" id="val-remove_left"><a href="#val-remove_left" class="anchor"></a><code><span class="keyword">val</span> remove_left : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-left">left</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Remove all bindings for the left key.</p></dd></dl><dl><dt class="spec value" id="val-remove_right"><a href="#val-remove_right" class="anchor"></a><code><span class="keyword">val</span> remove_right : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Remove all bindings for the right key.</p></dd></dl><dl><dt class="spec value" id="val-mem_left"><a href="#val-mem_left" class="anchor"></a><code><span class="keyword">val</span> mem_left : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-left">left</a> <span>-></span> bool</code></dt><dd><p>Is the left key present in at least one pair?</p></dd></dl><dl><dt class="spec value" id="val-mem_right"><a href="#val-mem_right" class="anchor"></a><code><span class="keyword">val</span> mem_right : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> bool</code></dt><dd><p>Is the right key present in at least one pair?</p></dd></dl><dl><dt class="spec value" id="val-find_left"><a href="#val-find_left" class="anchor"></a><code><span class="keyword">val</span> find_left : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-left">left</a> <span>-></span> <a href="index.html#type-right">right</a> <a href="../index.html#type-sequence">sequence</a></code></dt><dd><p>Find all bindings for this given left-key.</p></dd></dl><dl><dt class="spec value" id="val-find_right"><a href="#val-find_right" class="anchor"></a><code><span class="keyword">val</span> find_right : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> <a href="index.html#type-left">left</a> <a href="../index.html#type-sequence">sequence</a></code></dt><dd><p>Find all bindings for this given right-key.</p></dd></dl><dl><dt class="spec value" id="val-find1_left"><a href="#val-find1_left" class="anchor"></a><code><span class="keyword">val</span> find1_left : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-left">left</a> <span>-></span> <a href="index.html#type-right">right</a> option</code></dt><dd><p>Like <a href="index.html#val-find_left"><code>find_left</code></a> but returns at most one value.</p></dd></dl><dl><dt class="spec value" id="val-find1_right"><a href="#val-find1_right" class="anchor"></a><code><span class="keyword">val</span> find1_right : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> <a href="index.html#type-left">left</a> option</code></dt><dd><p>Like <a href="index.html#val-find_right"><code>find_right</code></a> but returns at most one 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 : (<span class="type-var">'a</span> <span>-></span> <a href="index.html#type-left">left</a> <span>-></span> <a href="index.html#type-right">right</a> <span>-></span> <span class="type-var">'a</span>) <span>-></span> <span class="type-var">'a</span> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span></code></dt><dd><p>Fold on pairs.</p></dd></dl><dl><dt class="spec value" id="val-pairs"><a href="#val-pairs" class="anchor"></a><code><span class="keyword">val</span> pairs : <a href="index.html#type-t">t</a> <span>-></span> (<a href="index.html#type-left">left</a> * <a href="index.html#type-right">right</a>) <a href="../index.html#type-sequence">sequence</a></code></dt><dd><p>Iterate on pairs.</p></dd></dl><dl><dt class="spec value" id="val-add_pairs"><a href="#val-add_pairs" class="anchor"></a><code><span class="keyword">val</span> add_pairs : <a href="index.html#type-t">t</a> <span>-></span> (<a href="index.html#type-left">left</a> * <a href="index.html#type-right">right</a>) <a href="../index.html#type-sequence">sequence</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Add pairs.</p></dd></dl><dl><dt class="spec value" id="val-seq_left"><a href="#val-seq_left" class="anchor"></a><code><span class="keyword">val</span> seq_left : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-left">left</a> <a href="../index.html#type-sequence">sequence</a></code></dt><dt class="spec value" id="val-seq_right"><a href="#val-seq_right" class="anchor"></a><code><span class="keyword">val</span> seq_right : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-right">right</a> <a href="../index.html#type-sequence">sequence</a></code></dt></dl></div></body></html> |