-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 7e2e319
Showing
106 changed files
with
2,348 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <title>index</title> | ||
| <link rel="stylesheet" href="./odoc.support/odoc.css"/> | ||
| <meta charset="utf-8"/> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1.0"/> | ||
| </head> | ||
| <body> | ||
| <main class="content"> | ||
| <div class="by-name"> | ||
| <h2>OCaml package documentation</h2> | ||
| <ol> | ||
| <li><a href="mugen/index.html">mugen</a></li> | ||
| </ol> | ||
| </div> | ||
| </main> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>Shift (mugen.Mugen.Builder.Endo.Make.P.Shift)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">mugen</a> » <a href="../../../../../index.html">Mugen</a> » <a href="../../../../index.html">Builder</a> » <a href="../../../index.html">Endo</a> » <a href="../../index.html">Make</a> » <a href="../index.html">P</a> » Shift</nav><header class="odoc-preamble"><h1>Module <code><span>P.Shift</span></code></h1><p>The displacement algebra.</p><p>To form a valid displacement algebra, <a href="#val-compose"><code>compose</code></a> and <a href="#val-id"><code>id</code></a> should form a monoid, and <a href="#val-lt"><code>lt</code></a> (the strict order) must be left-invariant respect to <a href="#val-compose"><code>compose</code></a>.</p></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 class="spec-doc"><p>The type.</p></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 class="spec-doc"><p><code>equal x y</code> checks whether <code>x</code> and <code>y</code> are equivalent.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dump"><a href="#val-dump" class="anchor"></a><code><span><span class="keyword">val</span> dump : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Ugly printer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lt"><a href="#val-lt" class="anchor"></a><code><span><span class="keyword">val</span> lt : <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 class="spec-doc"><p><code>lt x y</code> checks if <code>x</code> is strictly less than <code>y</code>. Note that trichotomy fails for general partial orders.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-leq"><a href="#val-leq" class="anchor"></a><code><span><span class="keyword">val</span> leq : <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 class="spec-doc"><p><code>leq x y</code> checks if <code>x</code> is less than or equal to <code>y</code>. Note that trichotomy fails for general partial orders.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-id"><a href="#val-id" class="anchor"></a><code><span><span class="keyword">val</span> id : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>id</code> is the unit.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_id"><a href="#val-is_id" class="anchor"></a><code><span><span class="keyword">val</span> is_id : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_id s</code> checks whether <code>s</code> is the unit. It is equivalent to <code>equal id s</code>, but potentially faster.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compose"><a href="#val-compose" class="anchor"></a><code><span><span class="keyword">val</span> compose : <span><a href="#type-t">t</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><code>compose s1 s2</code> composes the operators <code>s1</code> and <code>s2</code>. Note that <code>Foo^s1^s2</code> in McBride's notation is understood as <code>compose (compose ... s2) s1</code> with the reversed order.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>P (mugen.Mugen.Builder.Endo.Make.P)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">mugen</a> » <a href="../../../../index.html">Mugen</a> » <a href="../../../index.html">Builder</a> » <a href="../../index.html">Endo</a> » <a href="../index.html">Make</a> » P</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.P</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Shift"><a href="#module-Shift" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Shift/index.html">Shift</a></span><span> : <a href="../../../../Shift/module-type-S/index.html">Shift.S</a></span></code></div><div class="spec-doc"><p>The displacement algebra.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-level"><a href="#type-level" class="anchor"></a><code><span><span class="keyword">type</span> level</span></code></div><div class="spec-doc"><p>The type that embeds level expressions.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-level"><a href="#val-level" class="anchor"></a><code><span><span class="keyword">val</span> level : <span><span><span>(<a href="Shift/index.html#type-t">Shift.t</a>, <a href="#type-level">level</a>)</span> <a href="../../../../Syntax/index.html#type-endo">Syntax.endo</a></span> <span class="arrow">-></span></span> <a href="#type-level">level</a></span></code></div><div class="spec-doc"><p>The embedding of level expressions into <a href="#type-level"><code>level</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-unlevel"><a href="#val-unlevel" class="anchor"></a><code><span><span class="keyword">val</span> unlevel : <span><a href="#type-level">level</a> <span class="arrow">-></span></span> <span><span><span>(<a href="Shift/index.html#type-t">Shift.t</a>, <a href="#type-level">level</a>)</span> <a href="../../../../Syntax/index.html#type-endo">Syntax.endo</a></span> option</span></span></code></div><div class="spec-doc"><p>Extract the embedded level, if any.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 (mugen.Mugen.Builder.Endo.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">mugen</a> » <a href="../../../index.html">Mugen</a> » <a href="../../index.html">Builder</a> » <a href="../index.html">Endo</a> » Make</nav><header class="odoc-preamble"><h1>Module <code><span>Endo.Make</span></code></h1><p>The implementation of smart constructors.</p></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-P"><a href="#argument-1-P" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-P/index.html">P</a></span><span> : <a href="../module-type-Param/index.html">Param</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec value anchored" id="val-shifted"><a href="#val-shifted" class="anchor"></a><code><span><span class="keyword">val</span> shifted : <span><a href="argument-1-P/index.html#type-level">P.level</a> <span class="arrow">-></span></span> <span><a href="argument-1-P/Shift/index.html#type-t">P.Shift.t</a> <span class="arrow">-></span></span> <a href="argument-1-P/index.html#type-level">P.level</a></span></code></div><div class="spec-doc"><p><code>shifted s l</code> is the smarter version of <a href="../../../Syntax/Endo/index.html#val-shifted"><code>Syntax.Endo.shifted</code></a> that collapses multiple displacements, representing the level <code>l</code> shifted by the displacement <code>s</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_argument</code> <p>When it (directly or indirectly) attempts to shift the top level.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-top"><a href="#val-top" class="anchor"></a><code><span><span class="keyword">val</span> top : <a href="argument-1-P/index.html#type-level">P.level</a></span></code></div><div class="spec-doc"><p><code>top</code> is <a href="../../../Syntax/Endo/index.html#val-top"><code>Syntax.Endo.top</code></a>, the additional top level for convenience.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Endo (mugen.Mugen.Builder.Endo)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">mugen</a> » <a href="../../index.html">Mugen</a> » <a href="../index.html">Builder</a> » Endo</nav><header class="odoc-preamble"><h1>Module <code><span>Builder.Endo</span></code></h1><p>Semantic operations for <a href="../../Syntax/index.html#type-endo"><code>Syntax.endo</code></a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Param"><a href="#module-type-Param" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Param/index.html">Param</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Parameters of smart constructors.</p></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 class="spec-doc"><p>The signature of smart constructors.</p></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-P/index.html">P</a> : <a href="module-type-Param/index.html">Param</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-shift">shift</a> := <a href="Make/argument-1-P/Shift/index.html#type-t">P.Shift.t</a></span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-level">level</a> := <a href="Make/argument-1-P/index.html#type-level">P.level</a></span></span></code></div><div class="spec-doc"><p>The implementation of smart constructors.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>Shift (mugen.Mugen.Builder.Endo.Param.Shift)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">mugen</a> » <a href="../../../../index.html">Mugen</a> » <a href="../../../index.html">Builder</a> » <a href="../../index.html">Endo</a> » <a href="../index.html">Param</a> » Shift</nav><header class="odoc-preamble"><h1>Module <code><span>Param.Shift</span></code></h1><p>The displacement algebra.</p><p>To form a valid displacement algebra, <a href="#val-compose"><code>compose</code></a> and <a href="#val-id"><code>id</code></a> should form a monoid, and <a href="#val-lt"><code>lt</code></a> (the strict order) must be left-invariant respect to <a href="#val-compose"><code>compose</code></a>.</p></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 class="spec-doc"><p>The type.</p></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 class="spec-doc"><p><code>equal x y</code> checks whether <code>x</code> and <code>y</code> are equivalent.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dump"><a href="#val-dump" class="anchor"></a><code><span><span class="keyword">val</span> dump : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Ugly printer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lt"><a href="#val-lt" class="anchor"></a><code><span><span class="keyword">val</span> lt : <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 class="spec-doc"><p><code>lt x y</code> checks if <code>x</code> is strictly less than <code>y</code>. Note that trichotomy fails for general partial orders.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-leq"><a href="#val-leq" class="anchor"></a><code><span><span class="keyword">val</span> leq : <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 class="spec-doc"><p><code>leq x y</code> checks if <code>x</code> is less than or equal to <code>y</code>. Note that trichotomy fails for general partial orders.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-id"><a href="#val-id" class="anchor"></a><code><span><span class="keyword">val</span> id : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>id</code> is the unit.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_id"><a href="#val-is_id" class="anchor"></a><code><span><span class="keyword">val</span> is_id : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_id s</code> checks whether <code>s</code> is the unit. It is equivalent to <code>equal id s</code>, but potentially faster.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compose"><a href="#val-compose" class="anchor"></a><code><span><span class="keyword">val</span> compose : <span><a href="#type-t">t</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><code>compose s1 s2</code> composes the operators <code>s1</code> and <code>s2</code>. Note that <code>Foo^s1^s2</code> in McBride's notation is understood as <code>compose (compose ... s2) s1</code> with the reversed order.</p></div></div></div></body></html> |
Oops, something went wrong.