deploy: d1154adfba46ae75056f6111559bfc540b3c621d

This commit is contained in:
c-cube 2023-11-16 03:56:07 +00:00
parent caefc5670d
commit 4f0a65d003
63 changed files with 587 additions and 205 deletions

View file

@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
<title>index</title> <title>index</title>
<link rel="stylesheet" href="./_odoc_support/odoc.css"/> <link rel="stylesheet" href="./odoc.support/odoc.css"/>
<meta charset="utf-8"/> <meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/> <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head> </head>

View file

View file

@ -1,27 +1,27 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (iter.Iter.IO)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module <code><span>Iter.IO</span></code></h1><p>Basic IO</p><p>Very basic interface to manipulate files as iterator of chunks/lines. The iterators take care of opening and closing files properly; every time one iterates over an iterator, the file is opened/closed again.</p><p>Example: copy a file <code>&quot;a&quot;</code> into file <code>&quot;b&quot;</code>, removing blank lines:</p><pre class="language-ocaml"><code>Iterator.(IO.lines_of &quot;a&quot; |&gt; filter (fun l-&gt; l&lt;&gt; &quot;&quot;) |&gt; IO.write_lines &quot;b&quot;);;</code></pre><p>By chunks of <code>4096</code> bytes:</p><pre class="language-ocaml"><code>Iterator.IO.(chunks_of ~size:4096 &quot;a&quot; |&gt; write_to &quot;b&quot;);;</code></pre><p>Read the lines of a file into a list:</p><pre class="language-ocaml"><code>Iterator.IO.lines &quot;a&quot; |&gt; Iterator.to_list</code></pre><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.1</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><code><span><span class="keyword">val</span> lines_of : <span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> <span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>default: <code>[Open_rdonly]</code></p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><code><span><span class="keyword">val</span> chunks_of : <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (iter.Iter.IO)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module <code><span>Iter.IO</span></code></h1><p>Basic IO</p><p>Very basic interface to manipulate files as iterator of chunks/lines. The iterators take care of opening and closing files properly; every time one iterates over an iterator, the file is opened/closed again.</p><p>Example: copy a file <code>&quot;a&quot;</code> into file <code>&quot;b&quot;</code>, removing blank lines:</p><pre class="language-ocaml"><code>Iterator.(IO.lines_of &quot;a&quot; |&gt; filter (fun l-&gt; l&lt;&gt; &quot;&quot;) |&gt; IO.write_lines &quot;b&quot;);;</code></pre><p>By chunks of <code>4096</code> bytes:</p><pre class="language-ocaml"><code>Iterator.IO.(chunks_of ~size:4096 &quot;a&quot; |&gt; write_to &quot;b&quot;);;</code></pre><p>Read the lines of a file into a list:</p><pre class="language-ocaml"><code>Iterator.IO.lines &quot;a&quot; |&gt; Iterator.to_list</code></pre><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.1</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><code><span><span class="keyword">val</span> lines_of : <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> <span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>default: <code>[Open_rdonly]</code></p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><code><span><span class="keyword">val</span> chunks_of :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?size:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?size</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Read chunks of the given <code>size</code> from the file. The last chunk might be smaller. Behaves like <a href="#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></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_to"><a href="#val-write_to" class="anchor"></a><code><span><span class="keyword">val</span> write_to : <span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Read chunks of the given <code>size</code> from the file. The last chunk might be smaller. Behaves like <a href="#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></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_to"><a href="#val-write_to" class="anchor"></a><code><span><span class="keyword">val</span> write_to :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>used by <code>open_out_gen</code>. Default: <code>[Open_creat;Open_wronly]</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_to : unit</span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>used by <code>open_out_gen</code>. Default: <code>[Open_creat;Open_wronly]</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_to :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_lines : unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_lines :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Same as <a href="#val-write_to"><code>write_to</code></a>, but intercales <code>'\n'</code> between each string</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_lines : unit</span></code></div><div class="spec-doc"><p>Same as <a href="#val-write_to"><code>write_to</code></a>, but intercales <code>'\n'</code> between each string</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_lines :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div></div></body></html> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div></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

File diff suppressed because one or more lines are too long

View file

@ -1,4 +1,4 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (iter.Iter.Map)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Map</nav><header class="odoc-preamble"><h1>Module <code><span>Iter.Map</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (iter.Iter.Map)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Map</nav><header class="odoc-preamble"><h1>Module <code><span>Iter.Map</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span>
(<a href="Adapt/index.html#argument-1-M">M</a> : <span class="xref-unresolved">Stdlib</span>.Map.S) : (<a href="Adapt/index.html#argument-1-M">M</a> : <span class="xref-unresolved">Stdlib</span>.Map.S) :
<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-key">key</a> = <span class="xref-unresolved">M</span>.key</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <span>'a <a href="module-type-S/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">M</span>.t</span></span></span></code></div><div class="spec-doc"><p>Adapt a pre-existing Map module to make it iterator-aware</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/index.html#argument-1-V">V</a> : <span class="xref-unresolved">Stdlib</span>.Map.OrderedType) : <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-key">key</a> = <span class="xref-unresolved">V</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Map module, with iterator-aware functions</p></div></div></div></body></html> <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-key">key</a> = <span class="xref-unresolved">M</span>.key</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <span>'a <a href="module-type-S/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">M</span>.t</span></span></span></code></div><div class="spec-doc"><p>Adapt a pre-existing Map module to make it iterator-aware</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/index.html#argument-1-V">V</a> : <span class="xref-unresolved">Stdlib</span>.Map.OrderedType) : <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-key">key</a> = <span class="xref-unresolved">V</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Map module, with iterator-aware functions</p></div></div></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

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set (iter.Iter.Set)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Set</nav><header class="odoc-preamble"><h1>Module <code><span>Iter.Set</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span> (<a href="Adapt/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.S) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.elt</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Set module from the given one</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/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.OrderedType) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Functor to build an extended Set module from an ordered type</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set (iter.Iter.Set)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; <a href="../index.html">Iter</a> &#x00BB; Set</nav><header class="odoc-preamble"><h1>Module <code><span>Iter.Set</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span> (<a href="Adapt/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.S) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.elt</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Set module from the given one</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/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.OrderedType) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Functor to build an extended Set module from an ordered type</p></div></div></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

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IterBigarray (iter.IterBigarray)</title><link rel="stylesheet" href="../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; IterBigarray</nav><header class="odoc-preamble"><h1>Module <code><span>IterBigarray</span></code></h1><p>Interface and Helpers for bigarrays</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_bigarray"><a href="#val-of_bigarray" class="anchor"></a><code><span><span class="keyword">val</span> of_bigarray : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>, <span class="type-var">_</span>)</span> <span class="xref-unresolved">Stdlib</span>.Bigarray.Array1.t</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../Iter/index.html#type-t">Iter.t</a></span></span></code></div><div class="spec-doc"><p>Iterate on the elements of a 1-D array</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mmap"><a href="#val-mmap" class="anchor"></a><code><span><span class="keyword">val</span> mmap : <span>string <span class="arrow">&#45;&gt;</span></span> <span>char <a href="../Iter/index.html#type-t">Iter.t</a></span></span></code></div><div class="spec-doc"><p>Map the file into memory, and read the characters.</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IterBigarray (iter.IterBigarray)</title><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; IterBigarray</nav><header class="odoc-preamble"><h1>Module <code><span>IterBigarray</span></code></h1><p>Interface and Helpers for bigarrays</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_bigarray"><a href="#val-of_bigarray" class="anchor"></a><code><span><span class="keyword">val</span> of_bigarray : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">_</span>, <span class="type-var">_</span>)</span> <span class="xref-unresolved">Stdlib</span>.Bigarray.Array1.t</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <a href="../Iter/index.html#type-t">Iter.t</a></span></span></code></div><div class="spec-doc"><p>Iterate on the elements of a 1-D array</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mmap"><a href="#val-mmap" class="anchor"></a><code><span><span class="keyword">val</span> mmap : <span>string <span class="arrow">&#45;&gt;</span></span> <span>char <a href="../Iter/index.html#type-t">Iter.t</a></span></span></code></div><div class="spec-doc"><p>Map the file into memory, and read the characters.</p></div></div></div></body></html>

View file

@ -1,27 +1,27 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (iter.IterLabels.IO)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module <code><span>IterLabels.IO</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><code><span><span class="keyword">val</span> lines_of : <span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> <span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>default: <code>[Open_rdonly]</code></p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><code><span><span class="keyword">val</span> chunks_of : <html xmlns="http://www.w3.org/1999/xhtml"><head><title>IO (iter.IterLabels.IO)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; IO</nav><header class="odoc-preamble"><h1>Module <code><span>IterLabels.IO</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-lines_of"><a href="#val-lines_of" class="anchor"></a><code><span><span class="keyword">val</span> lines_of : <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span> <span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>default: <code>[Open_rdonly]</code></p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunks_of"><a href="#val-chunks_of" class="anchor"></a><code><span><span class="keyword">val</span> chunks_of :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>?size:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?size</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Read chunks of the given <code>size</code> from the file. The last chunk might be smaller. Behaves like <a href="#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></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_to"><a href="#val-write_to" class="anchor"></a><code><span><span class="keyword">val</span> write_to : <span>string <a href="../index.html#type-t">t</a></span></span></code></div><div class="spec-doc"><p>Read chunks of the given <code>size</code> from the file. The last chunk might be smaller. Behaves like <a href="#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></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_to"><a href="#val-write_to" class="anchor"></a><code><span><span class="keyword">val</span> write_to :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>used by <code>open_out_gen</code>. Default: <code>[Open_creat;Open_wronly]</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_to : unit</span></code></div><div class="spec-doc"><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><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">mode</span> <p>default <code>0o644</code></p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">flags</span> <p>used by <code>open_out_gen</code>. Default: <code>[Open_creat;Open_wronly]</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_to"><a href="#val-write_bytes_to" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_to :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_lines : unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_lines :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span>string <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><p>Same as <a href="#val-write_to"><code>write_to</code></a>, but intercales <code>'\n'</code> between each string</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_lines : unit</span></code></div><div class="spec-doc"><p>Same as <a href="#val-write_to"><code>write_to</code></a>, but intercales <code>'\n'</code> between each string</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_bytes_lines"><a href="#val-write_bytes_lines" class="anchor"></a><code><span><span class="keyword">val</span> write_bytes_lines :
<span>?mode:int <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?mode</span>:int <span class="arrow">&#45;&gt;</span></span>
<span>?flags:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span> <span><span class="optlabel">?flags</span>:<span><span class="xref-unresolved">Stdlib</span>.open_flag list</span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span> <span>string <span class="arrow">&#45;&gt;</span></span>
<span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Stdlib</span>.Bytes.t <a href="../index.html#type-t">t</a></span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div></div></body></html> unit</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 0.5.4</li></ul></div></div></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

File diff suppressed because one or more lines are too long

View file

@ -1,4 +1,4 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (iter.IterLabels.Map)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Map</nav><header class="odoc-preamble"><h1>Module <code><span>IterLabels.Map</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Map (iter.IterLabels.Map)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Map</nav><header class="odoc-preamble"><h1>Module <code><span>IterLabels.Map</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span>
(<a href="Adapt/index.html#argument-1-M">M</a> : <span class="xref-unresolved">Stdlib</span>.Map.S) : (<a href="Adapt/index.html#argument-1-M">M</a> : <span class="xref-unresolved">Stdlib</span>.Map.S) :
<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-key">key</a> = <span class="xref-unresolved">M</span>.key</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <span>'a <a href="module-type-S/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">M</span>.t</span></span></span></code></div><div class="spec-doc"><p>Adapt a pre-existing Map module to make it iterator-aware</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/index.html#argument-1-V">V</a> : <span class="xref-unresolved">Stdlib</span>.Map.OrderedType) : <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-key">key</a> = <span class="xref-unresolved">V</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Map module, with iterator-aware functions</p></div></div></div></body></html> <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-key">key</a> = <span class="xref-unresolved">M</span>.key</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <span>'a <a href="module-type-S/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">M</span>.t</span></span></span></code></div><div class="spec-doc"><p>Adapt a pre-existing Map module to make it iterator-aware</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/index.html#argument-1-V">V</a> : <span class="xref-unresolved">Stdlib</span>.Map.OrderedType) : <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-key">key</a> = <span class="xref-unresolved">V</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Map module, with iterator-aware functions</p></div></div></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

File diff suppressed because one or more lines are too long

View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set (iter.IterLabels.Set)</title><link rel="stylesheet" href="../../../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Set</nav><header class="odoc-preamble"><h1>Module <code><span>IterLabels.Set</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span> (<a href="Adapt/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.S) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.elt</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Set module from the given one</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/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.OrderedType) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Functor to build an extended Set module from an ordered type</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Set (iter.IterLabels.Set)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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">iter</a> &#x00BB; <a href="../index.html">IterLabels</a> &#x00BB; Set</nav><header class="odoc-preamble"><h1>Module <code><span>IterLabels.Set</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Adapt"><a href="#module-Adapt" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Adapt/index.html">Adapt</a></span><span> (<a href="Adapt/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.S) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.elt</span> <span class="keyword">and</span> <span><span class="keyword">type</span> <a href="module-type-S/index.html#type-t">t</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Create an enriched Set module from the given one</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/index.html#argument-1-X">X</a> : <span class="xref-unresolved">Stdlib</span>.Set.OrderedType) : <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-elt">elt</a> = <span class="xref-unresolved">X</span>.t</span></span></code></div><div class="spec-doc"><p>Functor to build an extended Set module from an ordered type</p></div></div></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

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (iter.index)</title><link rel="stylesheet" href="../_odoc_support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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> iter</nav><header class="odoc-preamble"><h1 id="iter-index"><a href="#iter-index" class="anchor"></a>iter index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-iter">Library iter</a></li><li><a href="#library-iter.bigarray">Library iter.bigarray</a></li></ul></nav><div class="odoc-content"><h2 id="library-iter"><a href="#library-iter" class="anchor"></a>Library iter</h2><p>This library exposes the following toplevel modules:</p><ul class="modules"><li><a href="Iter/index.html"><code>Iter</code></a> <span class="synopsis">Simple and Efficient Iterators.</span></li><li><a href="IterLabels/index.html"><code>IterLabels</code></a> </li></ul><h2 id="library-iter.bigarray"><a href="#library-iter.bigarray" class="anchor"></a>Library iter.bigarray</h2><p>The entry point of this library is the module: <a href="IterBigarray/index.html"><code>IterBigarray</code></a>.</p></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (iter.index)</title><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.3.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> iter</nav><header class="odoc-preamble"><h1 id="iter-index"><a href="#iter-index" class="anchor"></a>iter index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-iter">Library iter</a></li><li><a href="#library-iter.bigarray">Library iter.bigarray</a></li></ul></nav><div class="odoc-content"><h2 id="library-iter"><a href="#library-iter" class="anchor"></a>Library iter</h2><p>This library exposes the following toplevel modules:</p><ul class="modules"><li><a href="Iter/index.html"><code>Iter</code></a> <span class="synopsis">Simple and Efficient Iterators.</span></li><li><a href="IterLabels/index.html"><code>IterLabels</code></a> </li></ul><h2 id="library-iter.bigarray"><a href="#library-iter.bigarray" class="anchor"></a>Library iter.bigarray</h2><p>The entry point of this library is the module: <a href="IterBigarray/index.html"><code>IterBigarray</code></a>.</p></div></body></html>

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because one or more lines are too long

View file

@ -1,12 +1,97 @@
@charset "UTF-8"; @charset "UTF-8";
/* Copyright (c) 2016 The odoc contributors. All rights reserved. /* Copyright (c) 2016 The odoc contributors. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. Distributed under the ISC license, see terms at the end of the file.
odoc 2.2.0 */ odoc 2.3.0 */
/* Fonts */ /* Fonts */
@import url('https://fonts.googleapis.com/css?family=Fira+Mono:400,500'); /* noticia-text-regular - latin */
@import url('https://fonts.googleapis.com/css?family=Noticia+Text:400,400i,700'); @font-face {
@import url('https://fonts.googleapis.com/css?family=Fira+Sans:400,400i,500,500i,600,600i,700,700i'); font-family: 'Noticia Text';
font-style: normal;
font-weight: 400;
src: url('fonts/noticia-text-v15-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* noticia-text-italic - latin */
@font-face {
font-family: 'Noticia Text';
font-style: italic;
font-weight: 400;
src: url('fonts/noticia-text-v15-latin-italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* noticia-text-700 - latin */
@font-face {
font-family: 'Noticia Text';
font-style: normal;
font-weight: 700;
src: url('fonts/noticia-text-v15-latin-700.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-mono-regular - latin */
@font-face {
font-family: 'Fira Mono';
font-style: normal;
font-weight: 400;
src: url('fonts/fira-mono-v14-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-mono-500 - latin */
@font-face {
font-family: 'Fira Mono';
font-style: normal;
font-weight: 500;
src: url('fonts/fira-mono-v14-latin-500.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-sans-regular - latin */
@font-face {
font-family: 'Fira Sans';
font-style: normal;
font-weight: 400;
src: url('fonts/fira-sans-v17-latin-regular.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-sans-italic - latin */
@font-face {
font-family: 'Fira Sans';
font-style: italic;
font-weight: 400;
src: url('fonts/fira-sans-v17-latin-italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-sans-500 - latin */
@font-face {
font-family: 'Fira Sans';
font-style: normal;
font-weight: 500;
src: url('fonts/fira-sans-v17-latin-500.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-sans-500italic - latin */
@font-face {
font-family: 'Fira Sans';
font-style: italic;
font-weight: 500;
src: url('fonts/fira-sans-v17-latin-500italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-sans-700 - latin */
@font-face {
font-family: 'Fira Sans';
font-style: normal;
font-weight: 700;
src: url('fonts/fira-sans-v17-latin-700.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
/* fira-sans-700italic - latin */
@font-face {
font-family: 'Fira Sans';
font-style: italic;
font-weight: 700;
src: url('fonts/fira-sans-v17-latin-700italic.woff2') format('woff2'); /* Chrome 36+, Opera 23+, Firefox 39+, Safari 12+, iOS 10+ */
}
:root, :root,
.light:root { .light:root {
@ -14,6 +99,7 @@
--color: #333333; --color: #333333;
--link-color: #2C94BD; --link-color: #2C94BD;
--source-color: grey;
--anchor-hover: #555; --anchor-hover: #555;
--anchor-color: #d5d5d5; --anchor-color: #d5d5d5;
--xref-shadow: #cc6666; --xref-shadow: #cc6666;
@ -33,6 +119,7 @@
--toc-list-border: #ccc; --toc-list-border: #ccc;
--spec-summary-border-color: #5c9cf5; --spec-summary-border-color: #5c9cf5;
--spec-label-color: green;
--spec-summary-background: var(--code-background); --spec-summary-background: var(--code-background);
--spec-summary-hover-background: #ebeff2; --spec-summary-hover-background: #ebeff2;
--spec-details-after-background: rgba(0, 4, 15, 0.05); --spec-details-after-background: rgba(0, 4, 15, 0.05);
@ -72,6 +159,8 @@
--hljs-type: #ac885b; --hljs-type: #ac885b;
--hljs-meta: #82aaff; --hljs-meta: #82aaff;
--hljs-variable: #cf6a4c; --hljs-variable: #cf6a4c;
--spec-label-color: lightgreen;
} }
@media (prefers-color-scheme: dark) { @media (prefers-color-scheme: dark) {
@ -118,6 +207,8 @@
--hljs-type: #ac885b; --hljs-type: #ac885b;
--hljs-meta: #82aaff; --hljs-meta: #82aaff;
--hljs-variable: #cf6a4c; --hljs-variable: #cf6a4c;
--spec-label-color: lightgreen;
} }
} }
@ -142,6 +233,7 @@ table {
html { html {
font-size: 15px; font-size: 15px;
scroll-behavior: smooth;
} }
body { body {
@ -149,16 +241,23 @@ body {
background: #FFFFFF; background: #FFFFFF;
color: var(--color); color: var(--color);
background-color: var(--main-background); background-color: var(--main-background);
font-family: "Noticia Text", Georgia, serif;
line-height: 1.5;
} }
body { body {
max-width: 100ex;
margin-left: calc(10vw + 20ex); margin-left: calc(10vw + 20ex);
margin-right: 4ex; margin-right: 4ex;
margin-top: 20px; margin-top: 20px;
margin-bottom: 50px; margin-bottom: 50px;
font-family: "Noticia Text", Georgia, serif; }
line-height: 1.5;
body.odoc {
max-width: 100ex;
}
body.odoc-src {
margin-right: calc(10vw + 20ex);
} }
header { header {
@ -238,6 +337,10 @@ a {
color: var(--link-color); color: var(--link-color);
} }
.odoc-src pre a {
color: inherit;
}
a:hover { a:hover {
box-shadow: 0 1px 0 0 var(--link-color); box-shadow: 0 1px 0 0 var(--link-color);
} }
@ -289,6 +392,14 @@ a.anchor {
box-shadow: 0 1px 0 0 var(--xref-shadow); box-shadow: 0 1px 0 0 var(--xref-shadow);
} }
/* Source links float inside preformated text or headings. */
a.source_link {
float: right;
color: var(--source-color);
font-family: "Fira Sans", Helvetica, Arial, sans-serif;
font-size: initial;
}
/* Section and document divisions. /* Section and document divisions.
Until at least 4.03 many of the modules of the stdlib start at .h7, Until at least 4.03 many of the modules of the stdlib start at .h7,
we restart the sequence there like h2 */ we restart the sequence there like h2 */
@ -372,32 +483,32 @@ tt, code, pre {
font-weight: 400; font-weight: 400;
} }
pre { .odoc pre {
padding: 0.1em; padding: 0.1em;
border: 1px solid var(--pre-border-color); border: 1px solid var(--pre-border-color);
border-radius: 5px; border-radius: 5px;
overflow-x: auto; overflow-x: auto;
} }
p code, .odoc p code,
li code { .odoc li code {
background-color: var(--li-code-background); background-color: var(--li-code-background);
color: var(--li-code-color); color: var(--li-code-color);
border-radius: 3px; border-radius: 3px;
padding: 0 0.3ex; padding: 0 0.3ex;
} }
p a > code { p a > code, li a > code {
color: var(--link-color); color: var(--link-color);
} }
code { .odoc code {
white-space: pre-wrap; white-space: pre-wrap;
} }
/* Code blocks (e.g. Examples) */ /* Code blocks (e.g. Examples) */
pre code { .odoc pre code {
font-size: 0.893rem; font-size: 0.893rem;
} }
@ -419,6 +530,10 @@ pre code {
padding: 0.35em 0.5em; padding: 0.35em 0.5em;
} }
.spec .label, .spec .optlabel {
color: var(--spec-label-color);
}
li:not(:last-child) > .def-doc { li:not(:last-child) > .def-doc {
margin-bottom: 15px; margin-bottom: 15px;
} }
@ -536,6 +651,12 @@ td.def-doc *:first-child {
.at-tags li { padding-left: 3ex; text-indent: -3ex; } .at-tags li { padding-left: 3ex; text-indent: -3ex; }
.at-tags .at-tag { text-transform: capitalize } .at-tags .at-tag { text-transform: capitalize }
/* Alert emoji */
.alert::before, .deprecated::before {
content: '⚠️ ';
}
/* Lists of modules */ /* Lists of modules */
.modules { list-style-type: none; margin-left: -3ex; } .modules { list-style-type: none; margin-left: -3ex; }
@ -674,10 +795,26 @@ td.def-doc *:first-child {
padding-left: 12px; padding-left: 12px;
} }
/* Tables */
.odoc-table {
margin: 1em;
}
.odoc-table td, .odoc-table th {
padding-left: 0.5em;
padding-right: 0.5em;
border: 1px solid black;
}
.odoc-table th {
font-weight: bold;
}
/* Mobile adjustements. */ /* Mobile adjustements. */
@media only screen and (max-width: 95ex) { @media only screen and (max-width: 110ex) {
body.odoc { body {
margin: 2em; margin: 2em;
} }
.odoc-toc { .odoc-toc {
@ -704,6 +841,47 @@ td.def-doc *:first-child {
} }
} }
/* Source code. */
.source_container {
display: flex;
}
.source_line_column {
padding-right: 0.5em;
text-align: right;
background: #eee8d5;
}
.source_line {
padding: 0 1em;
}
.source_code {
flex-grow: 1;
background: #fdf6e3;
padding: 0 0.3em;
color: #657b83;
}
/* Source directories */
.odoc-directory::before {
content: "📁";
margin: 0.3em;
font-size: 1.3em;
}
.odoc-file::before {
content: "📄";
margin: 0.3em;
font-size: 1.3em;
}
.odoc-folder-list {
list-style: none;
}
/* Syntax highlighting (based on github-gist) */ /* Syntax highlighting (based on github-gist) */
.hljs { .hljs {
@ -777,6 +955,34 @@ td.def-doc *:first-child {
text-decoration: underline; text-decoration: underline;
} }
.VAL, .TYPE, .LET, .REC, .IN, .OPEN, .NONREC, .MODULE, .METHOD, .LETOP, .INHERIT, .INCLUDE, .FUNCTOR, .EXTERNAL, .CONSTRAINT, .ASSERT, .AND, .END, .CLASS, .STRUCT, .SIG {
color: #859900;;
}
.WITH, .WHILE, .WHEN, .VIRTUAL, .TRY, .TO, .THEN, .PRIVATE, .OF, .NEW, .MUTABLE, .MATCH, .LAZY, .IF, .FUNCTION, .FUN, .FOR, .EXCEPTION, .ELSE, .TO, .DOWNTO, .DO, .DONE, .BEGIN, .AS {
color: #cb4b16;
}
.TRUE, .FALSE {
color: #b58900;
}
.failwith, .INT, .SEMISEMI, .LIDENT {
color: #2aa198;
}
.STRING, .CHAR, .UIDENT {
color: #b58900;
}
.DOCSTRING {
color: #268bd2;
}
.COMMENT {
color: #93a1a1;
}
/*--------------------------------------------------------------------------- /*---------------------------------------------------------------------------
Copyright (c) 2016 The odoc contributors Copyright (c) 2016 The odoc contributors