Skip to content

Commit

Permalink
Deployed 0c2966a to unstable with MkDocs 1.4.3 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Dec 9, 2023
1 parent f4d518f commit b6336c3
Show file tree
Hide file tree
Showing 1,420 changed files with 1,419 additions and 1,419 deletions.
2 changes: 1 addition & 1 deletion unstable/api/ml/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<link rel="stylesheet" href="./odoc.support/odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
<link rel="canonical" href="https://melange.re/v2.1.0/api/ml/index.html" /></head>
<link rel="canonical" href="https://melange.re/v2.2.0/api/ml/index.html" /></head>
<body>
<main class="content">
<div class="by-name">
Expand Down
2 changes: 1 addition & 1 deletion unstable/api/ml/melange/Belt/Array/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>Array (melange.Belt.Array)</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><link rel="canonical" href="https://melange.re/v2.1.0/api/ml/melange/Belt/Array/index.html" /></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">melange</a> &#x00BB; <a href="../index.html">Belt</a> &#x00BB; Array</nav><header class="odoc-preamble"><h1>Module <code><span>Belt.Array</span></code></h1><p><a href="#"><code>Belt.Array</code></a></p><p><b>mutable array</b>: Utilities functions</p><p><a href="#"><code>Belt.Array</code></a> Utililites for Array functions</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> <span>'a t</span></span><span> = <span><span class="type-var">'a</span> array</span></span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-length"><a href="#val-length" class="anchor"></a><code><span><span class="keyword">val</span> length : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>length xs</code> return the size of the array</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-size"><a href="#val-size" class="anchor"></a><code><span><span class="keyword">val</span> size : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><b>See</b> <a href="#val-length"><code>length</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> option</span></span></code></div><div class="spec-doc"><p><code>get arr i</code></p><p>If <code>i &lt;= 0 &lt;= length arr</code>;returns <code>Some value</code> where <code>value</code> is the item at index <code>i</code> If <code>i</code> is out of range;returns <code>None</code></p><pre class="language-ocaml"><code>Belt.Array.get [|&quot;a&quot;;&quot;b&quot;;&quot;c&quot;|] 0 = Some &quot;a&quot;;;
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Array (melange.Belt.Array)</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><link rel="canonical" href="https://melange.re/v2.2.0/api/ml/melange/Belt/Array/index.html" /></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">melange</a> &#x00BB; <a href="../index.html">Belt</a> &#x00BB; Array</nav><header class="odoc-preamble"><h1>Module <code><span>Belt.Array</span></code></h1><p><a href="#"><code>Belt.Array</code></a></p><p><b>mutable array</b>: Utilities functions</p><p><a href="#"><code>Belt.Array</code></a> Utililites for Array functions</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> <span>'a t</span></span><span> = <span><span class="type-var">'a</span> array</span></span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-length"><a href="#val-length" class="anchor"></a><code><span><span class="keyword">val</span> length : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>length xs</code> return the size of the array</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-size"><a href="#val-size" class="anchor"></a><code><span><span class="keyword">val</span> size : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><b>See</b> <a href="#val-length"><code>length</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> option</span></span></code></div><div class="spec-doc"><p><code>get arr i</code></p><p>If <code>i &lt;= 0 &lt;= length arr</code>;returns <code>Some value</code> where <code>value</code> is the item at index <code>i</code> If <code>i</code> is out of range;returns <code>None</code></p><pre class="language-ocaml"><code>Belt.Array.get [|&quot;a&quot;;&quot;b&quot;;&quot;c&quot;|] 0 = Some &quot;a&quot;;;
Belt.Array.get [|&quot;a&quot;;&quot;b&quot;;&quot;c&quot;|] 3 = None;;
Belt.Array.get [|&quot;a&quot;;&quot;b&quot;;&quot;c&quot;|] (-1) = None;;</code></pre></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-getExn"><a href="#val-getExn" class="anchor"></a><code><span><span class="keyword">val</span> getExn : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>getExn arr i</code></p><p><b>raise</b> an exception if <code>i</code> is out of range;otherwise return the value at index <code>i</code> in <code>arr</code></p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-getUnsafe"><a href="#val-getUnsafe" class="anchor"></a><code><span><span class="keyword">val</span> getUnsafe : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>getUnsafe arr i</code></p><p><b>Unsafe</b></p><p>no bounds checking;this would cause type error if <code>i</code> does not stay within range</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-getUndefined"><a href="#val-getUndefined" class="anchor"></a><code><span><span class="keyword">val</span> getUndefined : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../../Js/index.html#type-undefined">Js.undefined</a></span></span></code></div><div class="spec-doc"><p><code>getUndefined arr i</code></p><p>It does the samething in the runtime as <a href="#val-getUnsafe"><code>getUnsafe</code></a>; it is <i>type safe</i> since the return type still track whether it is in range or not</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>set arr n x</code> modifies <code>arr</code> in place; it replaces the nth element of <code>arr</code> with <code>x</code></p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>false means not updated due to out of range</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-setExn"><a href="#val-setExn" class="anchor"></a><code><span><span class="keyword">val</span> setExn : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>setExn arr i x</code> <b>raise</b> an exception if <code>i</code> is out of range</p></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-setUnsafe"><a href="#val-setUnsafe" class="anchor"></a><code><span><span class="keyword">val</span> setUnsafe : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span>int <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shuffleInPlace"><a href="#val-shuffleInPlace" class="anchor"></a><code><span><span class="keyword">val</span> shuffleInPlace : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>shuffleInPlace arr</code> randomly re-orders the items in <code>arr</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shuffle"><a href="#val-shuffle" class="anchor"></a><code><span><span class="keyword">val</span> shuffle : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="#type-t">t</a></span></span></code></div><div class="spec-doc"><p><code>shuffle xs</code></p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a fresh array with items in original array randomly shuffled</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reverseInPlace"><a href="#val-reverseInPlace" class="anchor"></a><code><span><span class="keyword">val</span> reverseInPlace : <span><span><span class="type-var">'a</span> <a href="#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>reverseInPlace arr</code> reverses items in <code>arr</code> in place</p><pre class="language-ocaml"><code>let arr = [|10;11;12;13;14|];;
let () = reverseInPlace arr;;
Expand Down
2 changes: 1 addition & 1 deletion unstable/api/ml/melange/Belt/Float/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>Float (melange.Belt.Float)</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><link rel="canonical" href="https://melange.re/v2.1.0/api/ml/melange/Belt/Float/index.html" /></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">melange</a> &#x00BB; <a href="../index.html">Belt</a> &#x00BB; Float</nav><header class="odoc-preamble"><h1>Module <code><span>Belt.Float</span></code></h1><p><a href="#"><code>Belt.Float</code></a> Utililites for Float</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value external anchored" id="val-toInt"><a href="#val-toInt" class="anchor"></a><code><span><span class="keyword">val</span> toInt : <span>float <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-fromInt"><a href="#val-fromInt" class="anchor"></a><code><span><span class="keyword">val</span> fromInt : <span>int <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fromString"><a href="#val-fromString" class="anchor"></a><code><span><span class="keyword">val</span> fromString : <span>string <span class="arrow">&#45;&gt;</span></span> <span>float option</span></span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-toString"><a href="#val-toString" class="anchor"></a><code><span><span class="keyword">val</span> toString : <span>float <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(+)"><a href="#val-(+)" class="anchor"></a><code><span><span class="keyword">val</span> (+) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(-)"><a href="#val-(-)" class="anchor"></a><code><span><span class="keyword">val</span> (-) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(*)"><a href="#val-(*)" class="anchor"></a><code><span><span class="keyword">val</span> (*) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(/)"><a href="#val-(/)" class="anchor"></a><code><span><span class="keyword">val</span> (/) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Float (melange.Belt.Float)</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><link rel="canonical" href="https://melange.re/v2.2.0/api/ml/melange/Belt/Float/index.html" /></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../index.html">melange</a> &#x00BB; <a href="../index.html">Belt</a> &#x00BB; Float</nav><header class="odoc-preamble"><h1>Module <code><span>Belt.Float</span></code></h1><p><a href="#"><code>Belt.Float</code></a> Utililites for Float</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value external anchored" id="val-toInt"><a href="#val-toInt" class="anchor"></a><code><span><span class="keyword">val</span> toInt : <span>float <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-fromInt"><a href="#val-fromInt" class="anchor"></a><code><span><span class="keyword">val</span> fromInt : <span>int <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fromString"><a href="#val-fromString" class="anchor"></a><code><span><span class="keyword">val</span> fromString : <span>string <span class="arrow">&#45;&gt;</span></span> <span>float option</span></span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-toString"><a href="#val-toString" class="anchor"></a><code><span><span class="keyword">val</span> toString : <span>float <span class="arrow">&#45;&gt;</span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(+)"><a href="#val-(+)" class="anchor"></a><code><span><span class="keyword">val</span> (+) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(-)"><a href="#val-(-)" class="anchor"></a><code><span><span class="keyword">val</span> (-) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(*)"><a href="#val-(*)" class="anchor"></a><code><span><span class="keyword">val</span> (*) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div><div class="odoc-spec"><div class="spec value external anchored" id="val-(/)"><a href="#val-(/)" class="anchor"></a><code><span><span class="keyword">val</span> (/) : <span>float <span class="arrow">&#45;&gt;</span></span> <span>float <span class="arrow">&#45;&gt;</span></span> float</span></code></div></div></div></body></html>
Loading

0 comments on commit b6336c3

Please sign in to comment.