Skip to content

Commit

Permalink
doc for 3.13
Browse files Browse the repository at this point in the history
  • Loading branch information
@c-cube
c-cube committed Dec 5, 2023
1 parent d75f07b commit 14b69dc
Show file tree
Hide file tree
Showing 311 changed files with 3,166 additions and 1 deletion.
3 changes: 3 additions & 0 deletions 3.13/containers-data/CCBV/index.html
View file

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions 3.13/containers-data/CCBijection/Make/argument-1-L/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>L (containers-data.CCBijection.Make.L)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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> &#x00BB; <a href="../../index.html">CCBijection</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; L</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.L</span></code></h1></header><div class="odoc-content"><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 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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions 3.13/containers-data/CCBijection/Make/argument-2-R/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>R (containers-data.CCBijection.Make.R)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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> &#x00BB; <a href="../../index.html">CCBijection</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; R</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.R</span></code></h1></header><div class="odoc-content"><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 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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions 3.13/containers-data/CCBijection/Make/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-data.CCBijection.Make)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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> &#x00BB; <a href="../index.html">CCBijection</a> &#x00BB; 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">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-right">right</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-right">right</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-right">right</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</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">&#45;&gt;</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">&#45;&gt;</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>
5 changes: 5 additions & 0 deletions 3.13/containers-data/CCBijection/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCBijection (containers-data.CCBijection)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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> &#x00BB; CCBijection</nav><header class="odoc-preamble"><h1>Module <code><span>CCBijection</span></code></h1><p>Functor to build a bijection Represents 1-to-1 mappings between two types. Each element from the &quot;left&quot; is mapped to one &quot;right&quot; value, and conversely.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 2.1</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-iter"><a href="#type-iter" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a iter</span></span><span> = <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit)</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-OrderedType"><a href="#module-type-OrderedType" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-OrderedType/index.html">OrderedType</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
(<a href="Make/argument-1-L/index.html">L</a> : <a href="module-type-OrderedType/index.html">OrderedType</a>)
(<a href="Make/argument-2-R/index.html">R</a> : <a href="module-type-OrderedType/index.html">OrderedType</a>) :
<a href="module-type-S/index.html">S</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-left">left</a> = <a href="Make/argument-1-L/index.html#type-t">L.t</a></span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-right">right</a> = <a href="Make/argument-2-R/index.html#type-t">R.t</a></span></span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions 3.13/containers-data/CCBijection/module-type-OrderedType/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>OrderedType (containers-data.CCBijection.OrderedType)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.2"/><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> &#x00BB; <a href="../index.html">CCBijection</a> &#x00BB; OrderedType</nav><header class="odoc-preamble"><h1>Module type <code><span>CCBijection.OrderedType</span></code></h1></header><div class="odoc-content"><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 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">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>
Loading

0 comments on commit 14b69dc

Please sign in to comment.