mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-06 03:05:28 -05:00
2 lines
No EOL
12 KiB
HTML
2 lines
No EOL
12 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-data.CCBijection.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../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">CCBijection</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>CCBijection.Make</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-equal"><a href="#val-equal" class="anchor"></a><code><span><span class="keyword">val</span> equal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <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-compare"><a href="#val-compare" class="anchor"></a><code><span><span class="keyword">val</span> compare : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</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-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Add <code>left</code> and <code>right</code> correspondence to bijection such that <code>left</code> and <code>right</code> are unique in their respective sets and only correspond to each other.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-cardinal"><a href="#val-cardinal" class="anchor"></a><code><span><span class="keyword">val</span> cardinal : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Number of bindings. O(n) time.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mem"><a href="#val-mem" class="anchor"></a><code><span><span class="keyword">val</span> mem : <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><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Check both sides for key membership.</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-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Check for membership of correspondence using <code>left</code> key.</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-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Check for membership of correspondence using <code>right</code> key.</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-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-right">right</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Not_found</span> <p>if left is not found.</p></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-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-left">left</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Not_found</span> <p>if right is not found.</p></li></ul></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-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Remove the <code>left</code>, <code>right</code> binding if it exists. Return the same bijection otherwise.</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-left">left</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Remove the binding with <code>left</code> key if it exists. Return the same bijection otherwise.</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-right">right</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Remove the binding with <code>right</code> key if it exists. Return the same bijection otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-list_left"><a href="#val-list_left" class="anchor"></a><code><span><span class="keyword">val</span> list_left : <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> list</span></span></code></div><div class="spec-doc"><p>Return the bindings as a list of (<code>left</code>, <code>right</code>) values.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-list_right"><a href="#val-list_right" class="anchor"></a><code><span><span class="keyword">val</span> list_right : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span>(<a href="#type-right">right</a> * <a href="#type-left">left</a>)</span> list</span></span></code></div><div class="spec-doc"><p>Return the bindings as a list of <code>(right, left)</code> values.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_iter"><a href="#val-add_iter" class="anchor"></a><code><span><span class="keyword">val</span> add_iter : <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> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_iter"><a href="#val-of_iter" class="anchor"></a><code><span><span class="keyword">val</span> of_iter : <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><div class="odoc-spec"><div class="spec value anchored" id="val-to_iter"><a href="#val-to_iter" class="anchor"></a><code><span><span class="keyword">val</span> to_iter : <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><div class="odoc-spec"><div class="spec value anchored" id="val-add_list"><a href="#val-add_list" class="anchor"></a><code><span><span class="keyword">val</span> add_list : <span><span><span>(<a href="#type-left">left</a> * <a href="#type-right">right</a>)</span> list</span> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_list"><a href="#val-of_list" class="anchor"></a><code><span><span class="keyword">val</span> of_list : <span><span><span>(<a href="#type-left">left</a> * <a href="#type-right">right</a>)</span> list</span> <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_list"><a href="#val-to_list" class="anchor"></a><code><span><span class="keyword">val</span> to_list : <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> list</span></span></code></div></div></div></body></html> |