mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 11:15:31 -05:00
7 lines
No EOL
12 KiB
HTML
7 lines
No EOL
12 KiB
HTML
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers.CCBijection.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">CCBijection.Make</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-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"></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"></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-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> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Add <code class="code">left</code> and <code class="code">right</code> correspondence to bijection such that
|
|
<code class="code">left</code> and <code class="code">right</code> are unique in their respective sets and only
|
|
correspond to each other.</p></div></div><div class="spec val" id="val-cardinal"><a href="#val-cardinal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>cardinal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Number of bindings. O(n) time.</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-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> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Check both sides for key membership.</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-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Check for membership of correspondence using <code class="code">left</code> key.</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-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Check for membership of correspondence using <code class="code">right</code> key.</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-left">left</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-right">right</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Not_found</span>: if left is not found.</li></ul></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-right">right</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-left">left</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Not_found</span>: if right is not found.</li></ul></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-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> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Remove the <code class="code">left</code>, <code class="code">right</code> binding if it exists. Return the
|
|
same bijection otherwise.</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-left">left</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>Remove the binding with <code class="code">left</code> key if it exists. Return the
|
|
same bijection otherwise.</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-right">right</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>Remove the binding with <code class="code">right</code> key if it exists. Return the
|
|
same bijection otherwise.</p></div></div><div class="spec val" id="val-list_left"><a href="#val-list_left" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list_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>) list</code></div><div class="doc"><p>Return the bindings as a list of (<code class="code">left</code>, <code class="code">right</code>) values.</p></div></div><div class="spec val" id="val-list_right"><a href="#val-list_right" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list_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>) list</code></div><div class="doc"><p>Return the bindings as a list of <code class="code">(right, left)</code> values.</p></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : (<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> <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-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<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"></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-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"></div></div><div class="spec val" id="val-add_list"><a href="#val-add_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_list : (<a href="index.html#type-left">left</a><span class="keyword"> * </span><a href="index.html#type-right">right</a>) list <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"></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<a href="index.html#type-left">left</a><span class="keyword"> * </span><a href="index.html#type-right">right</a>) list <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-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : <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>) list</code></div><div class="doc"></div></div></body></html> |