gh-page updates

This commit is contained in:
Drup 2019-03-08 19:41:25 +01:00
parent 0f0f0e961f
commit 00509d6009
27 changed files with 824 additions and 0 deletions

File diff suppressed because one or more lines are too long

20
doc/dev/index.html Normal file
View file

@ -0,0 +1,20 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./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="iter/index.html">iter</a> <span class="version">1.2</span></li>
<li><a href="sequence/index.html">sequence</a> <span class="version">1.1</span></li>
</ol>
</div>
</main>
</body>
</html>

View file

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (iter.Iter.IO)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; IO</nav><h1>Module <code>Iter.IO</code></h1></header><dl><dt class="spec value" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><code><span class="keyword">val</span> lines_of : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a></code></dt><dd><p><code>lines_of filename</code> reads all lines of the given file. It raises the same exception as would opening the file and read from it, except from <code>End_of_file</code> (which is caught). The file is <b>always</b> properly closed. Every time the iterator is iterated on, the file is opened again, so different iterations might return different results</p><dl><dt>parameter mode</dt><dd><p>default <code>0o644</code></p></dd></dl><dl><dt>parameter flags</dt><dd><p>default: <code>[Open_rdonly]</code></p></dd></dl></dd></dl><dl><dt class="spec value" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><code><span class="keyword">val</span> chunks_of : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> ?&#8288;size:int <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a></code></dt><dd><p>Read chunks of the given <code>size</code> from the file. The last chunk might be smaller. Behaves like <a href="index.html#val-lines_of"><code>lines_of</code></a> regarding errors and options. Every time the iterator is iterated on, the file is opened again, so different iterations might return different results</p></dd></dl><dl><dt class="spec value" id="val-write_to"><a href="#val-write_to" class="anchor"></a><code><span class="keyword">val</span> write_to : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p><code>write_to filename seq</code> writes all strings from <code>seq</code> into the given file. It takes care of opening and closing the file.</p><dl><dt>parameter mode</dt><dd><p>default <code>0o644</code></p></dd></dl><dl><dt>parameter flags</dt><dd><p>used by <code>open_out_gen</code>. Default: <code>[Open_creat;Open_wronly]</code>.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><code><span class="keyword">val</span> write_bytes_to : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> Bytes.t <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><dl><dt>since</dt><dd>0.5.4</dd></dl></dd></dl><dl><dt class="spec value" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><code><span class="keyword">val</span> write_lines : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p>Same as <a href="index.html#val-write_to"><code>write_to</code></a>, but intercales <code>'\n'</code> between each string</p></dd></dl><dl><dt class="spec value" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><code><span class="keyword">val</span> write_bytes_lines : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> Bytes.t <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><dl><dt>since</dt><dd>0.5.4</dd></dl></dd></dl></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (iter.Iter.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Infix</nav><h1>Module <code>Iter.Infix</code></h1></header><dl><dt class="spec value" id="val-(--)"><a href="#val-(--)" class="anchor"></a><code><span class="keyword">val</span> (--) : int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> int <a href="../index.html#type-t">t</a></code></dt><dd><p><code>a -- b</code> is the range of integers from <code>a</code> to <code>b</code>, both included, in increasing order. It will therefore be empty if <code>a &gt; b</code>.</p></dd></dl><dl><dt class="spec value" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><code><span class="keyword">val</span> (--^) : int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> int <a href="../index.html#type-t">t</a></code></dt><dd><p><code>a --^ b</code> is the range of integers from <code>b</code> to <code>a</code>, both included, in decreasing order (starts from <code>a</code>). It will therefore be empty if <code>a &lt; b</code>.</p></dd></dl><dl><dt class="spec value" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span class="keyword">val</span> (&gt;&gt;=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> (<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Monadic bind (infix version of <a href="../index.html#val-flat_map"><code>flat_map</code></a></p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span class="keyword">val</span> (&gt;|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> (<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>) <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Infix version of <a href="../index.html#val-map"><code>map</code></a></p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&lt;*&gt;)"><a href="#val-(&lt;*&gt;)" class="anchor"></a><code><span class="keyword">val</span> (&lt;*&gt;) : (<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Applicative operator (product+application)</p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&lt;+&gt;)"><a href="#val-(&lt;+&gt;)" class="anchor"></a><code><span class="keyword">val</span> (&lt;+&gt;) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Concatenation of iterators</p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (iter.Iter.Map)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Map</nav><h1>Module <code>Iter.Map</code></h1></header><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec module" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span class="keyword">module</span> Adapt : <span class="keyword">functor</span> (<a href="Adapt/index.html#argument-1-M">M</a> : Map.S) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Adapt">Adapt</a>.key = <a href="Adapt/index.html#argument-1-M">M</a>.key <span class="keyword">and</span> <span class="keyword">type</span> 'a <a href="index.html#module-Adapt">Adapt</a>.t = <span class="type-var">'a</span> <a href="Adapt/index.html#argument-1-M">M</a>.t</code></dt><dd><p>Adapt a pre-existing Map module to make it iterator-aware</p></dd></dl><dl><dt class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> Make : <span class="keyword">functor</span> (<a href="Make/index.html#argument-1-V">V</a> : Map.OrderedType) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Make">Make</a>.key = <a href="Make/index.html#argument-1-V">V</a>.t</code></dt><dd><p>Create an enriched Map module, with iterator-aware functions</p></dd></dl></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set (iter.Iter.Set)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Set</nav><h1>Module <code>Iter.Set</code></h1></header><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec module" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span class="keyword">module</span> Adapt : <span class="keyword">functor</span> (<a href="Adapt/index.html#argument-1-X">X</a> : Set.S) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Adapt">Adapt</a>.elt = <a href="Adapt/index.html#argument-1-X">X</a>.elt <span class="keyword">and</span> <span class="keyword">type</span> <a href="index.html#module-Adapt">Adapt</a>.t = <a href="Adapt/index.html#argument-1-X">X</a>.t</code></dt><dd><p>Create an enriched Set module from the given one</p></dd></dl><dl><dt class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> Make : <span class="keyword">functor</span> (<a href="Make/index.html#argument-1-X">X</a> : Set.OrderedType) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Make">Make</a>.elt = <a href="Make/index.html#argument-1-X">X</a>.t</code></dt><dd><p>Functor to build an extended Set module from an ordered type</p></dd></dl></div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IterBigarray (iter.IterBigarray)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../index.html">iter</a> &#x00BB; IterBigarray</nav><h1>Module <code>IterBigarray</code></h1><h2 id="interface-and-helpers-for-bigarrays"><a href="#interface-and-helpers-for-bigarrays" class="anchor"></a>Interface and Helpers for bigarrays</h2><dl><dt>since</dt><dd>0.5.4</dd></dl></header><dl><dt class="spec value" id="val-of_bigarray"><a href="#val-of_bigarray" class="anchor"></a><code><span class="keyword">val</span> of_bigarray : (<span class="type-var">'a</span>, <span class="type-var">_</span>, <span class="type-var">_</span>) Bigarray.Array1.t <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../Iter/index.html#type-t">Iter.t</a></code></dt><dd><p>Iterate on the elements of a 1-D array</p></dd></dl><dl><dt class="spec value" id="val-mmap"><a href="#val-mmap" class="anchor"></a><code><span class="keyword">val</span> mmap : string <span>&#45;&gt;</span> char <a href="../Iter/index.html#type-t">Iter.t</a></code></dt><dd><p>Map the file into memory, and read the characters.</p></dd></dl></div></body></html>

View file

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (iter.IterLabels.IO)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; IO</nav><h1>Module <code>IterLabels.IO</code></h1></header><dl><dt class="spec value" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><code><span class="keyword">val</span> lines_of : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a></code></dt><dd><p><code>lines_of filename</code> reads all lines of the given file. It raises the same exception as would opening the file and read from it, except from <code>End_of_file</code> (which is caught). The file is <b>always</b> properly closed. Every time the iterator is iterated on, the file is opened again, so different iterations might return different results</p><dl><dt>parameter mode</dt><dd><p>default <code>0o644</code></p></dd></dl><dl><dt>parameter flags</dt><dd><p>default: <code>[Open_rdonly]</code></p></dd></dl></dd></dl><dl><dt class="spec value" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><code><span class="keyword">val</span> chunks_of : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> ?&#8288;size:int <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a></code></dt><dd><p>Read chunks of the given <code>size</code> from the file. The last chunk might be smaller. Behaves like <a href="index.html#val-lines_of"><code>lines_of</code></a> regarding errors and options. Every time the iterator is iterated on, the file is opened again, so different iterations might return different results</p></dd></dl><dl><dt class="spec value" id="val-write_to"><a href="#val-write_to" class="anchor"></a><code><span class="keyword">val</span> write_to : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p><code>write_to filename seq</code> writes all strings from <code>seq</code> into the given file. It takes care of opening and closing the file.</p><dl><dt>parameter mode</dt><dd><p>default <code>0o644</code></p></dd></dl><dl><dt>parameter flags</dt><dd><p>used by <code>open_out_gen</code>. Default: <code>[Open_creat;Open_wronly]</code>.</p></dd></dl></dd></dl><dl><dt class="spec value" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><code><span class="keyword">val</span> write_bytes_to : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> Bytes.t <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><dl><dt>since</dt><dd>0.5.4</dd></dl></dd></dl><dl><dt class="spec value" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><code><span class="keyword">val</span> write_lines : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> string <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><p>Same as <a href="index.html#val-write_to"><code>write_to</code></a>, but intercales <code>'\n'</code> between each string</p></dd></dl><dl><dt class="spec value" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><code><span class="keyword">val</span> write_bytes_lines : ?&#8288;mode:int <span>&#45;&gt;</span> ?&#8288;flags:Pervasives.open_flag list <span>&#45;&gt;</span> string <span>&#45;&gt;</span> Bytes.t <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dd><dl><dt>since</dt><dd>0.5.4</dd></dl></dd></dl></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (iter.IterLabels.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Infix</nav><h1>Module <code>IterLabels.Infix</code></h1></header><dl><dt class="spec value" id="val-(--)"><a href="#val-(--)" class="anchor"></a><code><span class="keyword">val</span> (--) : int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> int <a href="../index.html#type-t">t</a></code></dt><dd><p><code>a -- b</code> is the range of integers from <code>a</code> to <code>b</code>, both included, in increasing order. It will therefore be empty if <code>a &gt; b</code>.</p></dd></dl><dl><dt class="spec value" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><code><span class="keyword">val</span> (--^) : int <span>&#45;&gt;</span> int <span>&#45;&gt;</span> int <a href="../index.html#type-t">t</a></code></dt><dd><p><code>a --^ b</code> is the range of integers from <code>b</code> to <code>a</code>, both included, in decreasing order (starts from <code>a</code>). It will therefore be empty if <code>a &lt; b</code>.</p></dd></dl><dl><dt class="spec value" id="val-(&gt;&gt;=)"><a href="#val-(&gt;&gt;=)" class="anchor"></a><code><span class="keyword">val</span> (&gt;&gt;=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> (<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Monadic bind (infix version of <a href="../index.html#val-flat_map"><code>flat_map</code></a></p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&gt;|=)"><a href="#val-(&gt;|=)" class="anchor"></a><code><span class="keyword">val</span> (&gt;|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> (<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>) <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Infix version of <a href="../index.html#val-map"><code>map</code></a></p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&lt;*&gt;)"><a href="#val-(&lt;*&gt;)" class="anchor"></a><code><span class="keyword">val</span> (&lt;*&gt;) : (<span class="type-var">'a</span> <span>&#45;&gt;</span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Applicative operator (product+application)</p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl><dl><dt class="spec value" id="val-(&lt;+&gt;)"><a href="#val-(&lt;+&gt;)" class="anchor"></a><code><span class="keyword">val</span> (&lt;+&gt;) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span>&#45;&gt;</span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Concatenation of iterators</p><dl><dt>since</dt><dd>0.5</dd></dl></dd></dl></div></body></html>

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (iter.IterLabels.Map)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Map</nav><h1>Module <code>IterLabels.Map</code></h1></header><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec module" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span class="keyword">module</span> Adapt : <span class="keyword">functor</span> (<a href="Adapt/index.html#argument-1-M">M</a> : Map.S) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Adapt">Adapt</a>.key = <a href="Adapt/index.html#argument-1-M">M</a>.key <span class="keyword">and</span> <span class="keyword">type</span> 'a <a href="index.html#module-Adapt">Adapt</a>.t = <span class="type-var">'a</span> <a href="Adapt/index.html#argument-1-M">M</a>.t</code></dt><dd><p>Adapt a pre-existing Map module to make it iterator-aware</p></dd></dl><dl><dt class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> Make : <span class="keyword">functor</span> (<a href="Make/index.html#argument-1-V">V</a> : Map.OrderedType) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Make">Make</a>.key = <a href="Make/index.html#argument-1-V">V</a>.t</code></dt><dd><p>Create an enriched Map module, with iterator-aware functions</p></dd></dl></div></body></html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set (iter.IterLabels.Set)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Set</nav><h1>Module <code>IterLabels.Set</code></h1></header><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec module" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span class="keyword">module</span> Adapt : <span class="keyword">functor</span> (<a href="Adapt/index.html#argument-1-X">X</a> : Set.S) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Adapt">Adapt</a>.elt = <a href="Adapt/index.html#argument-1-X">X</a>.elt <span class="keyword">and</span> <span class="keyword">type</span> <a href="index.html#module-Adapt">Adapt</a>.t = <a href="Adapt/index.html#argument-1-X">X</a>.t</code></dt><dd><p>Create an enriched Set module from the given one</p></dd></dl><dl><dt class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> Make : <span class="keyword">functor</span> (<a href="Make/index.html#argument-1-X">X</a> : Set.OrderedType) <span>&#45;&gt;</span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="index.html#module-Make">Make</a>.elt = <a href="Make/index.html#argument-1-X">X</a>.t</code></dt><dd><p>Functor to build an extended Set module from an ordered type</p></dd></dl></div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

2
doc/dev/iter/index.html Normal file
View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (iter.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> iter</nav></header><h3 id="library-iter"><a href="#library-iter" class="anchor"></a>Library iter</h3><p>This library exposes the following toplevel modules:</p><ul class="modules"><li><a href="Iter/index.html"><code>Iter</code></a></li><li><a href="IterLabels/index.html"><code>IterLabels</code></a></li></ul><h3 id="library-iter.bigarray"><a href="#library-iter.bigarray" class="anchor"></a>Library iter.bigarray</h3><p>The entry point of this library is the module: <a href="IterBigarray/index.html"><code>IterBigarray</code></a>.</p></div></body></html>

764
doc/dev/odoc.css Normal file
View file

@ -0,0 +1,764 @@
@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 v1.1.1-949-gd6999cc74 */
/* Fonts */
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500');
@import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700');
@import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i');
/* Reset a few things. */
html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
margin: 0;
padding: 0;
border: 0;
font-size: inherit;
font: inherit;
line-height: inherit;
vertical-align: baseline;
text-align: inherit;
color: inherit;
background: transparent;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
*, *:before, *:after {
box-sizing: border-box;
}
html {
font-size: 15px;
}
body {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
text-align: left;
color: #333;
background: #FFFFFF;
}
.content {
max-width: 90ex;
margin-left: calc(10vw + 20ex);
margin-right: 4ex;
margin-top: 20px;
margin-bottom: 50px;
font-family: "Noticia Text", Georgia, serif;
line-height: 1.5;
}
.content>header {
margin-bottom: 30px;
}
.content>header nav {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
}
/* Basic markup elements */
b, strong {
font-weight: 500;
}
i, em {
font-style: italic;
}
sup {
vertical-align: super;
}
sub {
vertical-align: sub;
}
sup, sub {
font-size: 12px;
line-height: 0;
margin-left: 0.2ex;
}
pre {
margin-top: 0.8em;
margin-bottom: 1.2em;
}
p, ul, ol {
margin-top: 0.5em;
margin-bottom: 1em;
}
ul, ol {
list-style-position: outside
}
ul>li {
margin-left: 22px;
}
ol>li {
margin-left: 27.2px;
}
li>*:first-child {
margin-top: 0
}
/* Text alignements, this should be forbidden. */
.left {
text-align: left;
}
.right {
text-align: right;
}
.center {
text-align: center;
}
/* Links and anchors */
a {
text-decoration: none;
color: #2C5CBD;
}
a:hover {
box-shadow: 0 1px 0 0 #2C5CBD;
}
/* Linked highlight */
*:target {
background-color: rgba(187,239,253,0.3) !important;
box-shadow: 0 0px 0 1px rgba(187,239,253,0.8) !important;
border-radius: 1px;
}
*:hover>a.anchor {
visibility: visible;
}
a.anchor:before {
content: "#"
}
a.anchor:hover {
box-shadow: none;
text-decoration: none;
color: #555;
}
a.anchor {
visibility: hidden;
position: absolute;
/* top: 0px; */
/* margin-left: -3ex; */
margin-left: -1.3em;
font-weight: normal;
font-style: normal;
padding-right: 0.4em;
padding-left: 0.4em;
/* To remain selectable */
color: #d5d5d5;
}
.spec > a.anchor {
margin-left: -2.3em;
padding-right: 0.9em;
}
.xref-unresolved {
color: #2C5CBD;
}
.xref-unresolved:hover {
box-shadow: 0 1px 0 0 #CC6666;
}
/* Section and document divisions.
Until at least 4.03 many of the modules of the stdlib start at .h7,
we restart the sequence there like h2 */
h1, h2, h3, h4, h5, h6, .h7, .h8, .h9, .h10 {
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
font-weight: 400;
margin: 0.5em 0 0.5em 0;
padding-top: 0.1em;
line-height: 1.2;
overflow-wrap: break-word;
}
h1 {
font-weight: 500;
font-size: 2.441em;
margin-top: 1.214em;
}
h1 {
font-weight: 500;
font-size: 1.953em;
box-shadow: 0 1px 0 0 #ddd;
}
h2 {
font-size: 1.563em;
}
h3 {
font-size: 1.25em;
}
small, .font_small {
font-size: 0.8em;
}
h1 code, h1 tt {
font-size: inherit;
font-weight: inherit;
}
h2 code, h2 tt {
font-size: inherit;
font-weight: inherit;
}
h3 code, h3 tt {
font-size: inherit;
font-weight: inherit;
}
h3 code, h3 tt {
font-size: inherit;
font-weight: inherit;
}
h4 {
font-size: 1.12em;
}
/* Preformatted and code */
tt, code, pre {
font-family: "Fira Mono", courier;
font-weight: 400;
}
pre {
padding: 0.1em;
border: 1px solid #eee;
border-radius: 5px;
overflow-x: auto;
}
p code, li code {
background-color: #f6f8fa;
color: #0d2b3e;
border-radius: 3px;
padding: 0 0.3ex;
}
p a > code {
color: #2C5CBD;
}
/* Code blocks (e.g. Examples) */
pre code {
font-size: 0.893rem;
}
/* Code lexemes */
.keyword {
font-weight: 500;
}
/* Module member specification */
.spec:not(.include), .spec.include details summary {
background-color: #f6f8fa;
border-radius: 3px;
border-left: 4px solid #5c9cf5;
border-right: 5px solid transparent;
padding: 0.35em 0.5em;
}
.spec.include details summary:hover {
background-color: #ebeff2;
}
dl, div.spec, .doc, aside {
margin-bottom: 20px;
}
dl > dd {
padding: 0.5em;
}
dd> :first-child {
margin-top: 0;
}
dl:last-child, dd> :last-child, aside:last-child, article:last-child {
margin-bottom: 0;
}
dt+dt {
margin-top: 15px;
}
section+section, section > header + dl {
margin-top: 25px;
}
.spec.type .variant {
margin-left: 2ch;
}
.spec.type .variant p {
margin: 0;
font-style: italic;
}
.spec.type .record {
margin-left: 2ch;
}
.spec.type .record p {
margin: 0;
font-style: italic;
}
div.def {
margin-top: 0;
text-indent: -2ex;
padding-left: 2ex;
}
div.def+div.doc {
margin-left: 1ex;
margin-top: 2.5px
}
div.doc>*:first-child {
margin-top: 0;
}
/* The elements other than heading should be wrapped in <aside> elements. */
/* heading, body>p, body>ul, body>ol, h3, h4, body>pre { */
/* margin-bottom: 30px; */
/* } */
/* Collapsible inlined include and module */
.spec.include details {
position: relative;
}
.spec.include details:after {
z-index: -100;
display: block;
content: " ";
position: absolute;
border-radius: 0 1ex 1ex 0;
right: -20px;
top: 1px;
bottom: 1px;
width: 15px;
background: rgba(0, 4, 15, 0.05);
box-shadow: 0 0px 0 1px rgba(204, 204, 204, 0.53);
}
.spec.include details summary {
position: relative;
margin-bottom: 20px;
cursor: pointer;
outline: none;
}
/* FIXME: Does not work in Firefox. */
details summary::-webkit-details-marker {
color: #888;
transform: scaleX(-1);
position: absolute;
top: calc(50% - 5px);
height: 11px;
right: -29px;
}
/* Records and variants FIXME */
div.def table {
text-indent: 0em;
padding: 0;
margin-left: -2ex;
}
td.def {
padding-right: 2ex
}
.record td.def {
padding-left: 2ex;
}
td.doc *:first-child {
margin-top: 0em
}
/* @ tags */
ul.at-tag {
list-style-type: none;
margin-left: 0;
padding: 0;
}
ul.at-tag li {
margin-left: 0;
padding: 0;
}
ul.at-tag li p:first-child {
margin-top: 0
}
/* FIXME remove */
span.at-tag {
font-weight: bold
}
.at-tag.deprecated {
font-weight: normal;
color: crimson
}
.at-tag.raise {
font-weight: bold;
}
/* FIXME random other things to review. */
.heading {
margin-top: 10px;
border-bottom: solid;
border-width: 1px;
border-color: #DDD;
text-align: right;
font-weight: normal;
font-style: italic;
}
.heading+.sig {
margin-top: -20px;
}
.heading+.parameters {
margin-top: -20px;
}
/* Odig package index */
.by-name ol, .by-tag ol, .errors ol {
list-style-type: none;
margin-left: 0;
}
.by-name ol ol, .by-tag ol ol {
margin-top: 0;
margin-bottom: 0
}
.by-name li, .by-tag li, .errors li {
margin-left: 0;
}
.by-name .version {
font-size: 10px;
color: #AAA
}
.by-name nav {
margin-bottom: 10px
}
.by-name nav a {
text-transform: uppercase;
font-size: 18px;
margin-right: 1ex;
color: #222;
display: inline-block;
}
.by-tag nav a {
margin-right: 1ex;
color: #222;
display: inline-block;
}
.by-tag>ol>li {
margin-top: 10px;
}
.by-tag>ol>li>span, .by-tag>ol>li>ol, .by-tag>ol>li>ol>li {
display: inline-block;
margin-right: 1ex;
}
/* Odig package page */
.package nav {
display: inline;
font-size: 14px;
font-weight: normal;
}
.package .version {
font-size: 14px;
}
h1+.modules, h1+.sel {
margin-top: 10px
}
.sel {
font-weight: normal;
font-style: italic;
font-size: 14px;
margin-top: 20px;
}
.sel+.modules {
margin-top: 10px;
margin-bottom: 20px;
margin-left: 1ex;
}
.modules {
margin: 0;
}
.modules .module {
min-width: 8ex;
padding-right: 2ex
}
.package.info {
margin: 0;
}
.package.info td:first-child {
font-style: italic;
padding-right: 2ex;
}
.package.info ul {
list-style-type: none;
display: inline;
margin: 0;
}
.package.info li {
display: inline-block;
margin: 0;
margin-right: 1ex;
}
#info-authors li, #info-maintainers li {
display: block;
}
/* Sidebar and TOC */
.toc:before {
display: block;
content: "Contents";
text-transform: uppercase;
font-size: 1em;
margin: 1.414em 0 0.5em;
font-weight: 500;
color: #777;
line-height: 1.2;
}
.toc {
position: fixed;
top: 0px;
bottom: 0px;
left: 0px;
max-width: 30ex;
min-width: 26ex;
width: 20%;
background: #f6f8fa;
overflow: auto;
color: #1F2D3D;
padding-left: 2ex;
padding-right: 2ex;
}
.toc ul li a {
font-family: "Fira Sans", sans-serif;
font-size: 0.95em;
color: #333;
font-weight: 400;
line-height: 1.6em;
display: block;
}
.toc ul li a:hover {
box-shadow: none;
text-decoration: underline;
}
/* First level titles */
.toc>ul>li>a {
font-weight: 500;
}
.toc li ul {
margin: 0px;
}
.toc ul {
list-style-type: none;
}
.toc ul li {
margin: 0;
}
.toc>ul>li {
margin-bottom: 0.3em;
}
.toc ul li li {
border-left: 1px solid #ccc;
margin-left: 5px;
padding-left: 12px;
}
/* Mobile adjustements. */
@media only screen and (max-width: 95ex) {
.content {
margin: auto;
padding: 2.0em;
}
.toc {
position: static;
width: auto;
min-width: unset;
max-width: unset;
border: none;
padding: 0.2em 1em;
border-radius: 5px;
}
}
/* Print adjustements. */
@media print {
body {
color: black;
background: white;
}
body nav:first-child {
visibility: hidden;
}
}
/* Syntax highlighting (based on github-gist) */
.hljs {
display: block;
background: white;
padding: 0.5em;
color: #333333;
overflow-x: auto;
}
.hljs-comment,
.hljs-meta {
color: #969896;
}
.hljs-string,
.hljs-variable,
.hljs-template-variable,
.hljs-strong,
.hljs-emphasis,
.hljs-quote {
color: #df5000;
}
.hljs-keyword,
.hljs-selector-tag {
color: #a71d5d;
}
.hljs-type,
.hljs-class .hljs-title {
color: #458;
font-weight: 500;
}
.hljs-literal,
.hljs-symbol,
.hljs-bullet,
.hljs-attribute {
color: #0086b3;
}
.hljs-section,
.hljs-name {
color: #63a35c;
}
.hljs-tag {
color: #333333;
}
.hljs-attr,
.hljs-selector-id,
.hljs-selector-class,
.hljs-selector-attr,
.hljs-selector-pseudo {
color: #795da3;
}
.hljs-addition {
color: #55a532;
background-color: #eaffea;
}
.hljs-deletion {
color: #bd2c00;
background-color: #ffecec;
}
.hljs-link {
text-decoration: underline;
}
/*---------------------------------------------------------------------------
Copyright (c) 2016 The odoc contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
---------------------------------------------------------------------------*/

View file

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (sequence.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> sequence</nav></header><h3 id="library-sequence"><a href="#library-sequence" class="anchor"></a>Library sequence</h3><p>This library exposes the following toplevel modules:</p><ul class="modules"><li><a href="Sequence/index.html"><code>Sequence</code></a></li><li><a href="SequenceLabels/index.html"><code>SequenceLabels</code></a></li></ul></div></body></html>