mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
2 lines
12 KiB
HTML
2 lines
12 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MakeBidir (containers-data.CCMultiMap.MakeBidir)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">containers-data</a> » <a href="../index.html">CCMultiMap</a> » MakeBidir</nav><header class="odoc-preamble"><h1>Module <code><span>CCMultiMap.MakeBidir</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-L"><a href="#argument-1-L" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-L/index.html">L</a></span><span> : <a href="../module-type-OrderedType/index.html">OrderedType</a></span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-R"><a href="#argument-2-R" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-2-R/index.html">R</a></span><span> : <a href="../module-type-OrderedType/index.html">OrderedType</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-left"><a href="#type-left" class="anchor"></a><code><span><span class="keyword">type</span> left</span><span> = <a href="argument-1-L/index.html#type-t">L.t</a></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-right"><a href="#type-right" class="anchor"></a><code><span><span class="keyword">type</span> right</span><span> = <a href="argument-2-R/index.html#type-t">R.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_empty"><a href="#val-is_empty" class="anchor"></a><code><span><span class="keyword">val</span> is_empty : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add"><a href="#val-add" class="anchor"></a><code><span><span class="keyword">val</span> add : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Add a binding (left,right).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove"><a href="#val-remove" class="anchor"></a><code><span><span class="keyword">val</span> remove : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Remove a specific binding.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cardinal_left"><a href="#val-cardinal_left" class="anchor"></a><code><span><span class="keyword">val</span> cardinal_left : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Number of distinct left keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cardinal_right"><a href="#val-cardinal_right" class="anchor"></a><code><span><span class="keyword">val</span> cardinal_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Number of distinct right keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_left"><a href="#val-remove_left" class="anchor"></a><code><span><span class="keyword">val</span> remove_left : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Remove all bindings for the left key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_right"><a href="#val-remove_right" class="anchor"></a><code><span><span class="keyword">val</span> remove_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Remove all bindings for the right key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mem_left"><a href="#val-mem_left" class="anchor"></a><code><span><span class="keyword">val</span> mem_left : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Is the left key present in at least one pair?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mem_right"><a href="#val-mem_right" class="anchor"></a><code><span><span class="keyword">val</span> mem_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Is the right key present in at least one pair?</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_left"><a href="#val-find_left" class="anchor"></a><code><span><span class="keyword">val</span> find_left : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> list</span></span></code></div><div class="spec-doc"><p>List of values for this given left-key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_left_iter"><a href="#val-find_left_iter" class="anchor"></a><code><span><span class="keyword">val</span> find_left_iter : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <a href="../index.html#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Iterate on bindings for this given left-key.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.13</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_right"><a href="#val-find_right" class="anchor"></a><code><span><span class="keyword">val</span> find_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> list</span></span></code></div><div class="spec-doc"><p>List of values for this given right-key.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_right_iter"><a href="#val-find_right_iter" class="anchor"></a><code><span><span class="keyword">val</span> find_right_iter : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <a href="../index.html#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Iterate on bindings for this given left-key.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 3.13</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find1_left"><a href="#val-find1_left" class="anchor"></a><code><span><span class="keyword">val</span> find1_left : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> option</span></span></code></div><div class="spec-doc"><p>Like <a href="#val-find_left"><code>find_left</code></a> but returns at most one value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find1_right"><a href="#val-find1_right" class="anchor"></a><code><span><span class="keyword">val</span> find1_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> option</span></span></code></div><div class="spec-doc"><p>Like <a href="#val-find_right"><code>find_right</code></a> but returns at most one value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fold"><a href="#val-fold" class="anchor"></a><code><span><span class="keyword">val</span> fold : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Fold on pairs.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pairs"><a href="#val-pairs" class="anchor"></a><code><span><span class="keyword">val</span> pairs : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<a href="#type-left">left</a> * <a href="#type-right">right</a>)</span> <a href="../index.html#type-iter">iter</a></span></span></code></div><div class="spec-doc"><p>Iterate on pairs.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_pairs"><a href="#val-add_pairs" class="anchor"></a><code><span><span class="keyword">val</span> add_pairs : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<a href="#type-left">left</a> * <a href="#type-right">right</a>)</span> <a href="../index.html#type-iter">iter</a></span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Add pairs.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iter_left"><a href="#val-iter_left" class="anchor"></a><code><span><span class="keyword">val</span> iter_left : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-left">left</a> <a href="../index.html#type-iter">iter</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-iter_right"><a href="#val-iter_right" class="anchor"></a><code><span><span class="keyword">val</span> iter_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <a href="../index.html#type-iter">iter</a></span></span></code></div></div></div></body></html>
|