Skip to content

Commit

Permalink
Fix compilation with OCaml 5.2.0 and update documentation (#677)
Browse files Browse the repository at this point in the history 
* Fix compilation error due to the introduction of Float16 type in new OCaml version
* Fix math notations in the existing inline documentation
* Add inline documentation to a part of existing functions that do not have doc yet
  • Loading branch information
@jzstark
jzstark committed Jul 31, 2024
1 parent c788252 commit 08375ec
Show file tree
Hide file tree
Showing 2,054 changed files with 7,018 additions and 5,190 deletions.
2 changes: 1 addition & 1 deletion docs/odoc.support/odoc.css
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file.
odoc 2.4.1 */
odoc 2.4.2 */

/* Fonts */
/* noticia-text-regular - latin */
Expand Down
2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_check/Make/Forward/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Forward (owl-base.Owl_algodiff_check.Make.Forward)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">owl-base</a> &#x00BB; <a href="../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Forward</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Forward</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-check"><a href="#val-check" class="anchor"></a><code><span><span class="keyword">val</span> check :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Forward (owl-base.Owl_algodiff_check.Make.Forward)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.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">owl-base</a> &#x00BB; <a href="../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Forward</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Forward</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-check"><a href="#val-check" class="anchor"></a><code><span><span class="keyword">val</span> check :
<span><span class="label">threshold</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">f</span>:<span>(<span><a href="../argument-1-AD/index.html#type-t">AD.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../argument-1-AD/index.html#type-t">AD.t</a>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">directions</span>:<span><a href="../argument-1-AD/index.html#type-t">AD.t</a> array</span> <span class="arrow">&#45;&gt;</span></span>
Expand Down
2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_check/Make/Reverse/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Reverse (owl-base.Owl_algodiff_check.Make.Reverse)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">owl-base</a> &#x00BB; <a href="../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Reverse</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Reverse</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-check"><a href="#val-check" class="anchor"></a><code><span><span class="keyword">val</span> check :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Reverse (owl-base.Owl_algodiff_check.Make.Reverse)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.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">owl-base</a> &#x00BB; <a href="../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; Reverse</nav><header class="odoc-preamble"><h1>Module <code><span>Make.Reverse</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-check"><a href="#val-check" class="anchor"></a><code><span><span class="keyword">val</span> check :
<span><span class="label">threshold</span>:float <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">order</span>:<span>[ `second <span>| `fourth</span> <span>| `eighth</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="optlabel">?verbose</span>:bool <span class="arrow">&#45;&gt;</span></span>
Expand Down
2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_check/Make/argument-1-AD/A/Linalg/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linalg (owl-base.Owl_algodiff_check.Make.AD.A.Linalg)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">owl-base</a> &#x00BB; <a href="../../../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../../../index.html">Make</a> &#x00BB; <a href="../../index.html">AD</a> &#x00BB; <a href="../index.html">A</a> &#x00BB; Linalg</nav><header class="odoc-preamble"><h1>Module <code><span>A.Linalg</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-inv"><a href="#val-inv" class="anchor"></a><code><span><span class="keyword">val</span> inv : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-logdet"><a href="#val-logdet" class="anchor"></a><code><span><span class="keyword">val</span> logdet : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-elt">elt</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chol"><a href="#val-chol" class="anchor"></a><code><span><span class="keyword">val</span> chol : <span><span class="optlabel">?upper</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-svd"><a href="#val-svd" class="anchor"></a><code><span><span class="keyword">val</span> svd : <span><span class="optlabel">?thin</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-qr"><a href="#val-qr" class="anchor"></a><code><span><span class="keyword">val</span> qr : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lq"><a href="#val-lq" class="anchor"></a><code><span><span class="keyword">val</span> lq : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sylvester"><a href="#val-sylvester" class="anchor"></a><code><span><span class="keyword">val</span> sylvester : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lyapunov"><a href="#val-lyapunov" class="anchor"></a><code><span><span class="keyword">val</span> lyapunov : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-discrete_lyapunov"><a href="#val-discrete_lyapunov" class="anchor"></a><code><span><span class="keyword">val</span> discrete_lyapunov :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Linalg (owl-base.Owl_algodiff_check.Make.AD.A.Linalg)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.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">owl-base</a> &#x00BB; <a href="../../../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../../../index.html">Make</a> &#x00BB; <a href="../../index.html">AD</a> &#x00BB; <a href="../index.html">A</a> &#x00BB; Linalg</nav><header class="odoc-preamble"><h1>Module <code><span>A.Linalg</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-inv"><a href="#val-inv" class="anchor"></a><code><span><span class="keyword">val</span> inv : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-logdet"><a href="#val-logdet" class="anchor"></a><code><span><span class="keyword">val</span> logdet : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-elt">elt</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chol"><a href="#val-chol" class="anchor"></a><code><span><span class="keyword">val</span> chol : <span><span class="optlabel">?upper</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-svd"><a href="#val-svd" class="anchor"></a><code><span><span class="keyword">val</span> svd : <span><span class="optlabel">?thin</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-qr"><a href="#val-qr" class="anchor"></a><code><span><span class="keyword">val</span> qr : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lq"><a href="#val-lq" class="anchor"></a><code><span><span class="keyword">val</span> lq : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a> * <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-sylvester"><a href="#val-sylvester" class="anchor"></a><code><span><span class="keyword">val</span> sylvester : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-lyapunov"><a href="#val-lyapunov" class="anchor"></a><code><span><span class="keyword">val</span> lyapunov : <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-discrete_lyapunov"><a href="#val-discrete_lyapunov" class="anchor"></a><code><span><span class="keyword">val</span> discrete_lyapunov :
<span><span class="optlabel">?solver</span>:<span>[ `default <span>| `bilinear</span> <span>| `direct</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span>
Expand Down
2 changes: 1 addition & 1 deletion docs/owl-base/Owl_algodiff_check/Make/argument-1-AD/A/Mat/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mat (owl-base.Owl_algodiff_check.Make.AD.A.Mat)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">owl-base</a> &#x00BB; <a href="../../../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../../../index.html">Make</a> &#x00BB; <a href="../../index.html">AD</a> &#x00BB; <a href="../index.html">A</a> &#x00BB; Mat</nav><header class="odoc-preamble"><h1>Module <code><span>A.Mat</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-diagm"><a href="#val-diagm" class="anchor"></a><code><span><span class="keyword">val</span> diagm : <span><span class="optlabel">?k</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-triu"><a href="#val-triu" class="anchor"></a><code><span><span class="keyword">val</span> triu : <span><span class="optlabel">?k</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tril"><a href="#val-tril" class="anchor"></a><code><span><span class="keyword">val</span> tril : <span><span class="optlabel">?k</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eye"><a href="#val-eye" class="anchor"></a><code><span><span class="keyword">val</span> eye : <span>int <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Mat (owl-base.Owl_algodiff_check.Make.AD.A.Mat)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.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">owl-base</a> &#x00BB; <a href="../../../../index.html">Owl_algodiff_check</a> &#x00BB; <a href="../../../index.html">Make</a> &#x00BB; <a href="../../index.html">AD</a> &#x00BB; <a href="../index.html">A</a> &#x00BB; Mat</nav><header class="odoc-preamble"><h1>Module <code><span>A.Mat</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-diagm"><a href="#val-diagm" class="anchor"></a><code><span><span class="keyword">val</span> diagm : <span><span class="optlabel">?k</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-triu"><a href="#val-triu" class="anchor"></a><code><span><span class="keyword">val</span> triu : <span><span class="optlabel">?k</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-tril"><a href="#val-tril" class="anchor"></a><code><span><span class="keyword">val</span> tril : <span><span class="optlabel">?k</span>:int <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-arr">arr</a> <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-eye"><a href="#val-eye" class="anchor"></a><code><span><span class="keyword">val</span> eye : <span>int <span class="arrow">&#45;&gt;</span></span> <a href="../index.html#type-arr">arr</a></span></code></div></div></div></body></html>
Loading

0 comments on commit 08375ec

Please sign in to comment.