mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-01-23 01:26:41 -05:00
update doc
This commit is contained in:
Simon Cruanes
parent
01f91d42b1
commit
c358f4e1c0
61 changed files with 306 additions and 252 deletions
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
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCBool (containers.CCBool)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCBool</span></h1></header><h2>Basic Bool functions</h2><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>bool</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Total ordering on booleans, similar to <span class="xref-unresolved" title="unresolved reference to "Pervasives.compare"">Pervasives.compare</span></p></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-negate"><a href="#val-negate" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>negate : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Negation on booleans (functional version of <code class="code">not</code>)</p><ul class="at-tag"><li><span class="at-tag deprecated">Deprecated</span> since 1.3, simply use not instead</li></ul></div></div><div class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a printer</code><code><span class="keyword"> = </span>Format.formatter <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : <a href="index.html#type-t">t</a> <a href="index.html#type-printer">printer</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCBool (containers.CCBool)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCBool</span></h1></header><h2>Basic Bool functions</h2><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>bool</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Total ordering on booleans, similar to <span class="xref-unresolved" title="unresolved reference to "Pervasives.compare"">Pervasives.compare</span>.</p></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-negate"><a href="#val-negate" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>negate : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Negation on booleans (functional version of <code class="code">not</code>).</p><ul class="at-tag"><li><span class="at-tag deprecated">Deprecated</span> since 1.3, simply use not instead.</li></ul></div></div><div class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a printer</code><code><span class="keyword"> = </span>Format.formatter <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : <a href="index.html#type-t">t</a> <a href="index.html#type-printer">printer</a></code></div><div class="doc"></div></div></body></html>
|
||||
|
|
@ -6,4 +6,4 @@ allows the module <code class="code">Char</code> to be passed as argument to the
|
|||
using the US-ASCII character set.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.20</li></ul></div></div><div class="spec val" id="val-uppercase_ascii"><a href="#val-uppercase_ascii" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>uppercase_ascii : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Convert the given character to its equivalent uppercase character,
|
||||
using the US-ASCII character set.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.20</li></ul></div></div><div class="spec val" id="val-of_int_exn"><a href="#val-of_int_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_int_exn : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Char.chr"">Char.chr</span>.
|
||||
Return the character with the given ASCII code.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if the int is not within <code class="code">0,...,255</code>.</li><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-of_int"><a href="#val-of_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_int : int <span class="keyword">‑></span> <a href="index.html#type-t">t</a> option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-of_int_exn">of_int_exn</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-to_int"><a href="#val-to_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_int : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Alias to <span class="xref-unresolved" title="unresolved reference to "Char.code"">Char.code</span>.
|
||||
Return the ASCII code of the argument.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"></div></div><div class="spec val" id="val-print"><a href="#val-print" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>print : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"></div></div></body></html>
|
||||
Return the ASCII code of the argument.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-pp_buf"><a href="#val-pp_buf" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_buf : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Used to be <a href="index.html#val-pp">pp</a>, changed name</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Used to be print, changed name</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCEqual.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCEqual.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCEqual.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCEqual.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix equivalent of <a href="../index.html#val-map">map</a>.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCFloat.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCFloat.Infix</span></h1></header><div class="doc"><h3>Infix Operators</h3><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div><div class="spec val" id="val-(=)"><a href="#val-(=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<)"><a href="#val-(<)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>)"><a href="#val-(>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCFloat.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCFloat.Infix</span></h1></header><div class="spec val" id="val-(=)"><a href="#val-(=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<)"><a href="#val-(<)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>)"><a href="#val-(>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></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
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Monad (containers.CCFun.Monad)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCFun.Monad</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-X"><a href="#argument-1-X" class="anchor"></a><div class="def argument"><code><a href="argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code><span class="keyword"> = </span><a href="argument-1-X/index.html#type-t">X.t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Monad (containers.CCFun.Monad)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCFun.Monad</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-X"><a href="#argument-1-X" class="anchor"></a><div class="def argument"><code><a href="argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code><span class="keyword"> = </span><a href="argument-1-X/index.html#type-t">X.t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
|
|
@ -1,14 +1,17 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCFun (containers.CCFun)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCFun</span></h1></header><h2>Basic Functions</h2><div class="spec val" id="val-(|>)"><a href="#val-(|>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(|>) : <span class="type-var">'a</span> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p>Pipeline. <code class="code">x |> f</code> is the same as <code class="code">f x</code>.</p></div></div><div class="spec val" id="val-compose"><a href="#val-compose" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compose : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Composition</p></div></div><div class="spec val" id="val-compose_binop"><a href="#val-compose_binop" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compose_binop : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p><code class="code">compose_binop f g</code> is <code class="code">fun x y -> g (f x) (f y)</code>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCFun (containers.CCFun)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCFun</span></h1></header><h2>Basic Functions</h2><div class="spec val" id="val-(|>)"><a href="#val-(|>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(|>) : <span class="type-var">'a</span> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p>A 'pipe' operator. <code class="code">x |> f</code> is the same as <code class="code">f x</code>.</p></div></div><div class="spec val" id="val-compose"><a href="#val-compose" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compose : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Composition. <code class="code">compose f g x</code> is <code class="code">g (f x)</code>.</p></div></div><div class="spec val" id="val-compose_binop"><a href="#val-compose_binop" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compose_binop : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p><code class="code">compose_binop f g</code> is <code class="code">fun x y -> g (f x) (f y)</code>.
|
||||
Example (partial order):
|
||||
<code class="code">List.sort (compose_binop fst CCInt.compare) [1, true; 2, false; 1, false]</code></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.6</li></ul></div></div><div class="spec val" id="val-(%>)"><a href="#val-(%>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(%>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Alias to <code class="code">compose</code></p></div></div><div class="spec val" id="val-(@@)"><a href="#val-(@@)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(@@) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">f @@ x</code> is the same as <code class="code">f x</code>, but right-associative.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.5</li></ul></div></div><div class="spec val" id="val-id"><a href="#val-id" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>id : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Identity function</p></div></div><div class="spec val" id="val-const"><a href="#val-const" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>const : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">const x y = x</code> for any <code class="code">y</code></p></div></div><div class="spec val" id="val-flip"><a href="#val-flip" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>flip : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Flip arguments</p></div></div><div class="spec val" id="val-curry"><a href="#val-curry" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>curry : ((<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"></div></div><div class="spec val" id="val-uncurry"><a href="#val-uncurry" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>uncurry : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"></div></div><div class="spec val" id="val-tap"><a href="#val-tap" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>tap : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">_</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">tap f x</code> evaluates <code class="code">f x</code>, discards it, then returns <code class="code">x</code>. Useful
|
||||
<code class="code">List.sort (compose_binop fst CCInt.compare) [1, true; 2, false; 1, false]</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.6</li></ul></div></div><div class="spec val" id="val-(%>)"><a href="#val-(%>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(%>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Alias to <code class="code">compose</code>.</p></div></div><div class="spec val" id="val-(@@)"><a href="#val-(@@)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(@@) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">f @@ x</code> is the same as <code class="code">f x</code>, but right-associative.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.5</li></ul></div></div><div class="spec val" id="val-id"><a href="#val-id" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>id : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Identity function.</p></div></div><div class="spec val" id="val-const"><a href="#val-const" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>const : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Produce a function that just returns its first argument.
|
||||
<code class="code">const x y = x</code> for any <code class="code">y</code>.</p></div></div><div class="spec val" id="val-flip"><a href="#val-flip" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>flip : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Reverse the order of arguments for a binary function.</p></div></div><div class="spec val" id="val-curry"><a href="#val-curry" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>curry : ((<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Convert a function which accepts a pair of arguments into a function which accepts two arguments.
|
||||
<code class="code">curry f x y</code> is <code class="code">f (x,y)</code>.</p></div></div><div class="spec val" id="val-uncurry"><a href="#val-uncurry" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>uncurry : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Convert a function which accepts a two arguments into a function which accepts a pair of arguments.
|
||||
<code class="code">uncurry f (x,y)</code> is <code class="code">f x y</code>.</p></div></div><div class="spec val" id="val-tap"><a href="#val-tap" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>tap : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">_</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">tap f x</code> evaluates <code class="code">f x</code>, discards it, then returns <code class="code">x</code>. Useful
|
||||
in a pipeline, for instance:
|
||||
</p><pre><code class="code">CCArray.(1 -- 10)
|
||||
|> tap CCArray.shuffle
|
||||
|> tap @@ CCArray.sort Pervasives.compare</code></pre></div></div><div class="spec val" id="val-(%)"><a href="#val-(%)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(%) : (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Mathematical composition</p></div></div><div class="spec val" id="val-lexicographic"><a href="#val-lexicographic" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lexicographic : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int) <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Lexicographic combination of comparison functions</p></div></div><div class="spec val" id="val-finally"><a href="#val-finally" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>finally : h:(unit <span class="keyword">‑></span> <span class="type-var">_</span>) <span class="keyword">‑></span> f:(unit <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">finally h f</code> calls <code class="code">f ()</code> and returns its result. If it raises, the
|
||||
|> tap @@ CCArray.sort Pervasives.compare</code></pre></div></div><div class="spec val" id="val-(%)"><a href="#val-(%)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(%) : (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p>Mathematical composition. <code class="code">(%) f g x</code> is <code class="code">f (g x)</code>.</p></div></div><div class="spec val" id="val-lexicographic"><a href="#val-lexicographic" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lexicographic : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int) <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Lexicographic combination of comparison functions.</p></div></div><div class="spec val" id="val-finally"><a href="#val-finally" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>finally : h:(unit <span class="keyword">‑></span> <span class="type-var">_</span>) <span class="keyword">‑></span> f:(unit <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">finally h f</code> calls <code class="code">f ()</code> and returns its result. If it raises, the
|
||||
same exception is raised; in <b>any</b> case, <code class="code">h ()</code> is called after
|
||||
<code class="code">f ()</code> terminates.</p></div></div><div class="spec val" id="val-finally1"><a href="#val-finally1" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>finally1 : h:(unit <span class="keyword">‑></span> <span class="type-var">_</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">finally1 ~h f x</code> is the same as <code class="code">f x</code>, but after the computation,
|
||||
<code class="code">h ()</code> is called whether <code class="code">f x</code> rose an exception or not.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-finally2"><a href="#val-finally2" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>finally2 : h:(unit <span class="keyword">‑></span> <span class="type-var">_</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span></code></div><div class="doc"><p><code class="code">finally2 ~h f x y</code> is the same as <code class="code">f x y</code>, but after the computation,
|
||||
<code class="code">h ()</code> is called whether <code class="code">f x y</code> rose an exception or not.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-opaque_identity"><a href="#val-opaque_identity" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>opaque_identity : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">opaque_identity x</code> is like <code class="code">x</code>, but prevents Flambda from using <code class="code">x</code>'s
|
||||
definition for optimizing it (flambda is an optimization/inlining pass
|
||||
in OCaml >= 4.03).</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.18</li></ul></div></div><h3>Monad</h3><p>Functions with a fixed domain are monads in their codomain</p><div class="spec module" id="module-Monad"><a href="#module-Monad" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Monad/index.html">Monad</a> : <span class="keyword">functor</span> (<a href="Monad/argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) -> <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div></body></html>
|
||||
definition for optimizing it. (flambda is an optimization/inlining pass
|
||||
in OCaml >= 4.03).</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.18</li></ul></div></div><h3>Monad</h3><p>Functions with a fixed domain are monads in their codomain.</p><div class="spec module" id="module-Monad"><a href="#module-Monad" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Monad/index.html">Monad</a> : <span class="keyword">functor</span> (<a href="Monad/argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) -> <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div></body></html>
|
||||
|
|
@ -1,7 +1,8 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHash (containers.CCHash)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCHash</span></h1></header><h2>Hash combinators</h2><h3>Definitions</h3><div class="spec type" id="type-hash"><a href="#type-hash" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>hash</code><code><span class="keyword"> = </span>int</code><code></code></div><div class="doc"><p>A hash value is a positive integer</p></div></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a></code><code></code></div><div class="doc"><p>A hash function for values of type <code class="code">'a</code></p></div></div><div class="spec val" id="val-const"><a href="#val-const" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>const : <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <span class="type-var">_</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">return h</code> hashes any value into <code class="code">h</code>. Use with caution!.</p></div></div><div class="spec val" id="val-const0"><a href="#val-const0" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>const0 : <span class="type-var">_</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Always return 0. Useful for ignoring elements.
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHash (containers.CCHash)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCHash</span></h1></header><h2>Hash combinators</h2><h3>Definitions</h3><div class="spec type" id="type-hash"><a href="#type-hash" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>hash</code><code><span class="keyword"> = </span>int</code><code></code></div><div class="doc"><p>A hash value is a positive integer.</p></div></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a></code><code></code></div><div class="doc"><p>A hash function for values of type <code class="code">'a</code>.</p></div></div><div class="spec val" id="val-const"><a href="#val-const" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>const : <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <span class="type-var">_</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">const h</code> hashes any value into <code class="code">h</code>. Use with caution!.</p></div></div><div class="spec val" id="val-const0"><a href="#val-const0" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>const0 : <span class="type-var">_</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Always return 0. Useful for ignoring elements.
|
||||
Example: <code class="code">Hash.(pair string const0)</code> will map pairs <code class="code">("a", 1)</code>
|
||||
and <code class="code">("a", 2)</code> to the same hash, but not the same as <code class="code">("b", 1)</code></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-int"><a href="#val-int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int : int <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-bool"><a href="#val-bool" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>bool : bool <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-char"><a href="#val-char" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>char : char <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-int32"><a href="#val-int32" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int32 : int32 <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-int64"><a href="#val-int64" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int64 : int64 <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-nativeint"><a href="#val-nativeint" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>nativeint : nativeint <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-slice"><a href="#val-slice" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>slice : string <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">slice s i len state</code> hashes the slice <code class="code">i, ... i+len-1</code> of <code class="code">s</code>
|
||||
into <code class="code">state</code></p></div></div><div class="spec val" id="val-string"><a href="#val-string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>string : string <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-list"><a href="#val-list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-array"><a href="#val-array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>array : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-opt"><a href="#val-opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>opt : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-pair"><a href="#val-pair" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pair : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-triple"><a href="#val-triple" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>triple : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-quad"><a href="#val-quad" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>quad : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'d</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span><span class="keyword"> * </span><span class="type-var">'d</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-if_"><a href="#val-if_" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>if_ : bool <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Decide which hash function to use depending on the boolean</p></div></div><div class="spec val" id="val-poly"><a href="#val-poly" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>poly : <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>the regular polymorphic hash function</p></div></div><div class="spec val" id="val-list_comm"><a href="#val-list_comm" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list_comm : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Commutative version of <a href="index.html#val-list">list</a>. Lists that are equal up to permutation
|
||||
and <code class="code">("a", 2)</code> to the same hash, but not the same as <code class="code">("b", 1)</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-int"><a href="#val-int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int : int <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-bool"><a href="#val-bool" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>bool : bool <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-char"><a href="#val-char" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>char : char <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-int32"><a href="#val-int32" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int32 : int32 <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-int64"><a href="#val-int64" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int64 : int64 <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-nativeint"><a href="#val-nativeint" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>nativeint : nativeint <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-slice"><a href="#val-slice" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>slice : string <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">slice s i len state</code> hashes the slice <code class="code">i, ... i+len-1</code> of <code class="code">s</code>
|
||||
into <code class="code">state</code>.</p></div></div><div class="spec val" id="val-string"><a href="#val-string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>string : string <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-list"><a href="#val-list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-array"><a href="#val-array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>array : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-opt"><a href="#val-opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>opt : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-pair"><a href="#val-pair" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pair : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-triple"><a href="#val-triple" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>triple : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-quad"><a href="#val-quad" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>quad : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'d</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span><span class="keyword"> * </span><span class="type-var">'d</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-if_"><a href="#val-if_" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>if_ : bool <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Decide which hash function to use depending on the boolean.</p></div></div><div class="spec val" id="val-poly"><a href="#val-poly" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>poly : <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>The regular polymorphic hash function.
|
||||
<code class="code">poly x</code> is <code class="code">Hashtbl.hash x</code>.</p></div></div><div class="spec val" id="val-list_comm"><a href="#val-list_comm" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list_comm : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Commutative version of <a href="index.html#val-list">list</a>. Lists that are equal up to permutation
|
||||
will have the same hash.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-array_comm"><a href="#val-array_comm" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>array_comm : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Commutative version of <a href="index.html#val-array">array</a>. Arrays that are equal up to permutation
|
||||
will have the same hash.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><h3>Base hash combinators</h3><div class="spec val" id="val-combine"><a href="#val-combine" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>combine : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a></code></div><div class="doc"></div></div><div class="spec val" id="val-combine2"><a href="#val-combine2" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>combine2 : <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a></code></div><div class="doc"></div></div><div class="spec val" id="val-combine3"><a href="#val-combine3" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>combine3 : <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a></code></div><div class="doc"></div></div><div class="spec val" id="val-combine4"><a href="#val-combine4" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>combine4 : <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a> <span class="keyword">‑></span> <a href="index.html#type-hash">hash</a></code></div><div class="doc"></div></div><h3>Iterators</h3><div class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a sequence</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-gen"><a href="#type-gen" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a gen</code><code><span class="keyword"> = </span>unit <span class="keyword">‑></span> <span class="type-var">'a</span> option</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-klist"><a href="#type-klist" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a klist</code><code><span class="keyword"> = </span>unit <span class="keyword">‑></span> [ `Nil | `Cons of <span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'a</span> <a href="index.html#type-klist">klist</a> ]</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-seq"><a href="#val-seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>seq : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-gen"><a href="#val-gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>gen : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-gen">gen</a> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-klist"><a href="#val-klist" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>klist : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-klist">klist</a> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
|
|
@ -1,20 +1,20 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Poly (containers.CCHashtbl.Poly)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCHashtbl.Poly</span></h1></header><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> option</code></div><div class="doc"><p>Safe version of <span class="xref-unresolved" title="unresolved reference to "Hashtbl.find"">Hashtbl.find</span></p></div></div><div class="spec val" id="val-get_or"><a href="#val-get_or" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> default:<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or tbl k ~default</code> returns the value associated to <code class="code">k</code> if present,
|
||||
and returns <code class="code">default</code> otherwise (if <code class="code">k</code> doesn't belong in <code class="code">tbl</code>)</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-keys"><a href="#val-keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on keys (similar order as <span class="xref-unresolved" title="unresolved reference to "Hashtbl.iter"">Hashtbl.iter</span>)</p></div></div><div class="spec val" id="val-values"><a href="#val-values" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on values in the table</p></div></div><div class="spec val" id="val-keys_list"><a href="#val-keys_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> list</code></div><div class="doc"><p><code class="code">keys_list t</code> is the list of keys in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-values_list"><a href="#val-values_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> list</code></div><div class="doc"><p><code class="code">values_list t</code> is the list of values in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-map_list"><a href="#val-map_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_list : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'c</span> list</code></div><div class="doc"><p>Map on a hashtable's items, collect into a list</p></div></div><div class="spec val" id="val-incr"><a href="#val-incr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>incr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">incr ?by tbl x</code> increments or initializes the counter associated with <code class="code">x</code>.
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Poly (containers.CCHashtbl.Poly)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCHashtbl.Poly</span></h1></header><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> option</code></div><div class="doc"><p>Safe version of <span class="xref-unresolved" title="unresolved reference to "Hashtbl.find"">Hashtbl.find</span>.</p></div></div><div class="spec val" id="val-get_or"><a href="#val-get_or" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> default:<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or tbl k ~default</code> returns the value associated to <code class="code">k</code> if present,
|
||||
and returns <code class="code">default</code> otherwise (if <code class="code">k</code> doesn't belong in <code class="code">tbl</code>).</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-keys"><a href="#val-keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on keys (similar order as <span class="xref-unresolved" title="unresolved reference to "Hashtbl.iter"">Hashtbl.iter</span>).</p></div></div><div class="spec val" id="val-values"><a href="#val-values" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on values in the table.</p></div></div><div class="spec val" id="val-keys_list"><a href="#val-keys_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> list</code></div><div class="doc"><p><code class="code">keys_list t</code> is the list of keys in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-values_list"><a href="#val-values_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> list</code></div><div class="doc"><p><code class="code">values_list t</code> is the list of values in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-map_list"><a href="#val-map_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_list : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'c</span> list</code></div><div class="doc"><p>Map on a hashtable's items, collect into a list.</p></div></div><div class="spec val" id="val-incr"><a href="#val-incr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>incr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">incr ?by tbl x</code> increments or initializes the counter associated with <code class="code">x</code>.
|
||||
If <code class="code">get tbl x = None</code>, then after update, <code class="code">get tbl x = Some 1</code>;
|
||||
otherwise, if <code class="code">get tbl x = Some n</code>, now <code class="code">get tbl x = Some (n+1)</code>.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">by</span>: if specified, the int value is incremented by <code class="code">by</code> rather than 1</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-decr"><a href="#val-decr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>decr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Same as <a href="index.html#val-incr">incr</a> but substract 1 (or the value of <code class="code">by</code>).
|
||||
otherwise, if <code class="code">get tbl x = Some n</code>, now <code class="code">get tbl x = Some (n+1)</code>.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">by</span>: if specified, the int value is incremented by <code class="code">by</code> rather than 1.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-decr"><a href="#val-decr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>decr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Like <a href="index.html#val-incr">incr</a> but subtract 1 (or the value of <code class="code">by</code>).
|
||||
If the value reaches 0, the key is removed from the table.
|
||||
This does nothing if the key is not already present in the table.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on bindings in the table</p></div></div><div class="spec val" id="val-add_list"><a href="#val-add_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span> list) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_list tbl x y</code> adds <code class="code">y</code> to the list <code class="code">x</code> is bound to. If <code class="code">x</code> is
|
||||
not bound, it becomes bound to <code class="code">[y]</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Add the corresponding pairs to the table, using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.add"">Hashtbl.add</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>From the given bindings, added in order</p></div></div><div class="spec val" id="val-add_seq_count"><a href="#val-add_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq_count : (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_seq_count tbl seq</code> increments the count of each element of <code class="code">seq</code>
|
||||
This does nothing if the key is not already present in the table.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on bindings in the table.</p></div></div><div class="spec val" id="val-add_list"><a href="#val-add_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span> list) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_list tbl x y</code> adds <code class="code">y</code> to the list <code class="code">x</code> is bound to. If <code class="code">x</code> is
|
||||
not bound, it becomes bound to <code class="code">y</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Add the corresponding pairs to the table, using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.add"">Hashtbl.add</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>From the given bindings, added in order.</p></div></div><div class="spec val" id="val-add_seq_count"><a href="#val-add_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq_count : (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_seq_count tbl seq</code> increments the count of each element of <code class="code">seq</code>
|
||||
by calling <a href="index.html#val-incr">incr</a>. This is useful for counting how many times each
|
||||
element of <code class="code">seq</code> occurs.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq_count"><a href="#val-of_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq_count : <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t</code></div><div class="doc"><p>Similar to <a href="index.html#val-add_seq_count">add_seq_count</a>, but allocates a new table and returns it</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list</code></div><div class="doc"><p>List of bindings (order unspecified)</p></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>Build a table from the given list of bindings <code class="code">k_i -> v_i</code>,
|
||||
element of <code class="code">seq</code> occurs.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq_count"><a href="#val-of_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq_count : <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t</code></div><div class="doc"><p>Similar to <a href="index.html#val-add_seq_count">add_seq_count</a>, but allocates a new table and returns it.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list</code></div><div class="doc"><p>List of bindings (order unspecified).</p></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>Build a table from the given list of bindings <code class="code">k_i -> v_i</code>,
|
||||
added in order using add. If a key occurs several times,
|
||||
it will be added several times, and the visible binding
|
||||
will be the last one.</p></div></div><div class="spec val" id="val-update"><a href="#val-update" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>update : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> option <span class="keyword">‑></span> <span class="type-var">'b</span> option) <span class="keyword">‑></span> k:<span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">update tbl ~f ~k</code> updates key <code class="code">k</code> by calling <code class="code">f k (Some v)</code> if
|
||||
<code class="code">k</code> was mapped to <code class="code">v</code>, or <code class="code">f k None</code> otherwise; if the call
|
||||
returns <code class="code">None</code> then <code class="code">k</code> is removed/stays removed, if the call
|
||||
returns <code class="code">Some v'</code> then the binding <code class="code">k -> v'</code> is inserted
|
||||
using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.replace"">Hashtbl.replace</span></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-get_or_add"><a href="#val-get_or_add" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or_add : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> k:<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or_add tbl ~k ~f</code> finds and returns the binding of <code class="code">k</code>
|
||||
using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.replace"">Hashtbl.replace</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-get_or_add"><a href="#val-get_or_add" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or_add : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> k:<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or_add tbl ~k ~f</code> finds and returns the binding of <code class="code">k</code>
|
||||
in <code class="code">tbl</code>, if it exists. If it does not exist, then <code class="code">f k</code>
|
||||
is called to obtain a new binding <code class="code">v</code>; <code class="code">k -> v</code> is added
|
||||
to <code class="code">tbl</code> and <code class="code">v</code> is returned.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : <span class="type-var">'a</span> <a href="../index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-printer">printer</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <a href="../index.html#type-printer">printer</a></code></div><div class="doc"></div></div></body></html>
|
||||
|
|
@ -1,20 +1,20 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHashtbl (containers.CCHashtbl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCHashtbl</span></h1></header><h2>Extension to the standard Hashtbl</h2><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.4</li></ul><div class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a sequence</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-eq"><a href="#type-eq" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a eq</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> bool</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-hash"><a href="#type-hash" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a hash</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> int</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a printer</code><code><span class="keyword"> = </span>Format.formatter <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><h3>Polymorphic tables</h3><p>This sub-module contains the extension of the standard polymorphic hashtbl.</p><div class="spec module" id="module-Poly"><a href="#module-Poly" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Poly/index.html">Poly</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span><a href="index.html#module-Poly">Poly</a></code></span></summary><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> option</code></div><div class="doc"><p>Safe version of <span class="xref-unresolved" title="unresolved reference to "Hashtbl.find"">Hashtbl.find</span></p></div></div><div class="spec val" id="val-get_or"><a href="#val-get_or" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> default:<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or tbl k ~default</code> returns the value associated to <code class="code">k</code> if present,
|
||||
and returns <code class="code">default</code> otherwise (if <code class="code">k</code> doesn't belong in <code class="code">tbl</code>)</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-keys"><a href="#val-keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on keys (similar order as <span class="xref-unresolved" title="unresolved reference to "Hashtbl.iter"">Hashtbl.iter</span>)</p></div></div><div class="spec val" id="val-values"><a href="#val-values" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on values in the table</p></div></div><div class="spec val" id="val-keys_list"><a href="#val-keys_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> list</code></div><div class="doc"><p><code class="code">keys_list t</code> is the list of keys in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-values_list"><a href="#val-values_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> list</code></div><div class="doc"><p><code class="code">values_list t</code> is the list of values in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-map_list"><a href="#val-map_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_list : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'c</span> list</code></div><div class="doc"><p>Map on a hashtable's items, collect into a list</p></div></div><div class="spec val" id="val-incr"><a href="#val-incr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>incr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">incr ?by tbl x</code> increments or initializes the counter associated with <code class="code">x</code>.
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHashtbl (containers.CCHashtbl)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCHashtbl</span></h1></header><h2>Extension to the standard Hashtbl</h2><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.4</li></ul><div class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a sequence</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-eq"><a href="#type-eq" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a eq</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> bool</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-hash"><a href="#type-hash" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a hash</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> int</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a printer</code><code><span class="keyword"> = </span>Format.formatter <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code><code></code></div><div class="doc"></div></div><h3>Polymorphic tables</h3><p>This sub-module contains the extension of the standard polymorphic Hashtbl.</p><div class="spec module" id="module-Poly"><a href="#module-Poly" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Poly/index.html">Poly</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><span class="keyword">module type of </span><a href="index.html#module-Poly">Poly</a></code></span></summary><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> option</code></div><div class="doc"><p>Safe version of <span class="xref-unresolved" title="unresolved reference to "Hashtbl.find"">Hashtbl.find</span>.</p></div></div><div class="spec val" id="val-get_or"><a href="#val-get_or" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> default:<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or tbl k ~default</code> returns the value associated to <code class="code">k</code> if present,
|
||||
and returns <code class="code">default</code> otherwise (if <code class="code">k</code> doesn't belong in <code class="code">tbl</code>).</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-keys"><a href="#val-keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on keys (similar order as <span class="xref-unresolved" title="unresolved reference to "Hashtbl.iter"">Hashtbl.iter</span>).</p></div></div><div class="spec val" id="val-values"><a href="#val-values" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on values in the table.</p></div></div><div class="spec val" id="val-keys_list"><a href="#val-keys_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> list</code></div><div class="doc"><p><code class="code">keys_list t</code> is the list of keys in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-values_list"><a href="#val-values_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'b</span> list</code></div><div class="doc"><p><code class="code">values_list t</code> is the list of values in <code class="code">t</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-map_list"><a href="#val-map_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_list : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'c</span>) <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'c</span> list</code></div><div class="doc"><p>Map on a hashtable's items, collect into a list.</p></div></div><div class="spec val" id="val-incr"><a href="#val-incr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>incr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">incr ?by tbl x</code> increments or initializes the counter associated with <code class="code">x</code>.
|
||||
If <code class="code">get tbl x = None</code>, then after update, <code class="code">get tbl x = Some 1</code>;
|
||||
otherwise, if <code class="code">get tbl x = Some n</code>, now <code class="code">get tbl x = Some (n+1)</code>.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">by</span>: if specified, the int value is incremented by <code class="code">by</code> rather than 1</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-decr"><a href="#val-decr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>decr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Same as <a href="index.html#val-incr">incr</a> but substract 1 (or the value of <code class="code">by</code>).
|
||||
otherwise, if <code class="code">get tbl x = Some n</code>, now <code class="code">get tbl x = Some (n+1)</code>.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">by</span>: if specified, the int value is incremented by <code class="code">by</code> rather than 1.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-decr"><a href="#val-decr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>decr : ?⁠by:int <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Like <a href="index.html#val-incr">incr</a> but subtract 1 (or the value of <code class="code">by</code>).
|
||||
If the value reaches 0, the key is removed from the table.
|
||||
This does nothing if the key is not already present in the table.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on bindings in the table</p></div></div><div class="spec val" id="val-add_list"><a href="#val-add_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span> list) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_list tbl x y</code> adds <code class="code">y</code> to the list <code class="code">x</code> is bound to. If <code class="code">x</code> is
|
||||
not bound, it becomes bound to <code class="code">[y]</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Add the corresponding pairs to the table, using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.add"">Hashtbl.add</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>From the given bindings, added in order</p></div></div><div class="spec val" id="val-add_seq_count"><a href="#val-add_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq_count : (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_seq_count tbl seq</code> increments the count of each element of <code class="code">seq</code>
|
||||
This does nothing if the key is not already present in the table.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on bindings in the table.</p></div></div><div class="spec val" id="val-add_list"><a href="#val-add_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span> list) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_list tbl x y</code> adds <code class="code">y</code> to the list <code class="code">x</code> is bound to. If <code class="code">x</code> is
|
||||
not bound, it becomes bound to <code class="code">y</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Add the corresponding pairs to the table, using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.add"">Hashtbl.add</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>From the given bindings, added in order.</p></div></div><div class="spec val" id="val-add_seq_count"><a href="#val-add_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq_count : (<span class="type-var">'a</span>, int) Hashtbl.t <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">add_seq_count tbl seq</code> increments the count of each element of <code class="code">seq</code>
|
||||
by calling <a href="index.html#val-incr">incr</a>. This is useful for counting how many times each
|
||||
element of <code class="code">seq</code> occurs.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq_count"><a href="#val-of_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq_count : <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t</code></div><div class="doc"><p>Similar to <a href="index.html#val-add_seq_count">add_seq_count</a>, but allocates a new table and returns it</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list</code></div><div class="doc"><p>List of bindings (order unspecified)</p></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>Build a table from the given list of bindings <code class="code">k_i -> v_i</code>,
|
||||
element of <code class="code">seq</code> occurs.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-of_seq_count"><a href="#val-of_seq_count" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq_count : <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, int) Hashtbl.t</code></div><div class="doc"><p>Similar to <a href="index.html#val-add_seq_count">add_seq_count</a>, but allocates a new table and returns it.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list</code></div><div class="doc"><p>List of bindings (order unspecified).</p></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) list <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t</code></div><div class="doc"><p>Build a table from the given list of bindings <code class="code">k_i -> v_i</code>,
|
||||
added in order using add. If a key occurs several times,
|
||||
it will be added several times, and the visible binding
|
||||
will be the last one.</p></div></div><div class="spec val" id="val-update"><a href="#val-update" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>update : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> option <span class="keyword">‑></span> <span class="type-var">'b</span> option) <span class="keyword">‑></span> k:<span class="type-var">'a</span> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">update tbl ~f ~k</code> updates key <code class="code">k</code> by calling <code class="code">f k (Some v)</code> if
|
||||
<code class="code">k</code> was mapped to <code class="code">v</code>, or <code class="code">f k None</code> otherwise; if the call
|
||||
returns <code class="code">None</code> then <code class="code">k</code> is removed/stays removed, if the call
|
||||
returns <code class="code">Some v'</code> then the binding <code class="code">k -> v'</code> is inserted
|
||||
using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.replace"">Hashtbl.replace</span></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-get_or_add"><a href="#val-get_or_add" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or_add : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> k:<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or_add tbl ~k ~f</code> finds and returns the binding of <code class="code">k</code>
|
||||
using <span class="xref-unresolved" title="unresolved reference to "Hashtbl.replace"">Hashtbl.replace</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-get_or_add"><a href="#val-get_or_add" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_or_add : (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <span class="keyword">‑></span> f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> k:<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span></code></div><div class="doc"><p><code class="code">get_or_add tbl ~k ~f</code> finds and returns the binding of <code class="code">k</code>
|
||||
in <code class="code">tbl</code>, if it exists. If it does not exist, then <code class="code">f k</code>
|
||||
is called to obtain a new binding <code class="code">v</code>; <code class="code">k -> v</code> is added
|
||||
to <code class="code">tbl</code> and <code class="code">v</code> is returned.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-printer">printer</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'b</span>) Hashtbl.t <a href="index.html#type-printer">printer</a></code></div><div class="doc"></div></div></details></div><h3>Functor</h3><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><div class="def module-type"><code><span class="keyword">module type </span><a href="module-type-S/index.html">S</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div><div class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><div class="def module"><code><span class="keyword">module </span>Make : <span class="keyword">functor</span> (<a href="Make/index.html#argument-1-X">X</a> : Hashtbl.HashedType) -> <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<span class="keyword"> = </span><a href="Make/index.html#argument-1-X">X</a>.t<span class="keyword"> and </span><span class="keyword">type </span>'a <a href="index.html#module-Make">Make</a>.t<span class="keyword"> = </span><span class="type-var">'a</span> Hashtbl.Make(<a href="Make/index.html#argument-1-X">X</a>).t</code></div><div class="doc"></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-E (containers.CCHeap.Make.1-E)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCHeap.Make.1-E</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-leq"><a href="#val-leq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>leq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">leq x y</code> shall return <code class="code">true</code> iff <code class="code">x</code> is lower or equal to <code class="code">y</code></p></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-E (containers.CCHeap.Make.1-E)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCHeap.Make.1-E</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-leq"><a href="#val-leq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>leq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">leq x y</code> shall return <code class="code">true</code> iff <code class="code">x</code> is lower or equal to <code class="code">y</code>.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>PARTIAL_ORD (containers.CCHeap.PARTIAL_ORD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCHeap.PARTIAL_ORD</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-leq"><a href="#val-leq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>leq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">leq x y</code> shall return <code class="code">true</code> iff <code class="code">x</code> is lower or equal to <code class="code">y</code></p></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>PARTIAL_ORD (containers.CCHeap.PARTIAL_ORD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCHeap.PARTIAL_ORD</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-leq"><a href="#val-leq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>leq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p><code class="code">leq x y</code> shall return <code class="code">true</code> iff <code class="code">x</code> is lower or equal to <code class="code">y</code>.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,14 +1,14 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>File (containers.CCIO.File)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCIO.File</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>string</code><code></code></div><div class="doc"><p>A file should be represented by its absolute path, but currently
|
||||
this is not enforced.</p></div></div><div class="spec val" id="val-to_string"><a href="#val-to_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_string : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-make"><a href="#val-make" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>make : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Build a file representation from a path (absolute or relative)</p></div></div><div class="spec val" id="val-exists"><a href="#val-exists" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>exists : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-is_directory"><a href="#val-is_directory" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_directory : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-remove_exn"><a href="#val-remove_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">remove_exn path</code> tries to remove the file at <code class="code">path</code> from the
|
||||
this is not enforced.</p></div></div><div class="spec val" id="val-to_string"><a href="#val-to_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_string : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-make"><a href="#val-make" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>make : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Build a file representation from a path (absolute or relative).</p></div></div><div class="spec val" id="val-exists"><a href="#val-exists" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>exists : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-is_directory"><a href="#val-is_directory" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>is_directory : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"></div></div><div class="spec val" id="val-remove_exn"><a href="#val-remove_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p><code class="code">remove_exn path</code> tries to remove the file at <code class="code">path</code> from the
|
||||
file system.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: if there is no file at <code class="code">path</code> or access rights are wrong.</li><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-remove"><a href="#val-remove" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Like <code class="code">remove_exn</code> but with an error monad.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-remove_noerr"><a href="#val-remove_noerr" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>remove_noerr : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Like <code class="code">remove_exn</code> but do not raise any exception on failure.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.8</li></ul></div></div><div class="spec val" id="val-read_dir"><a href="#val-read_dir" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_dir : ?⁠recurse:bool <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p><code class="code">read_dir d</code> returns a sequence of files and directory contained
|
||||
in the directory <code class="code">d</code> (or an empty stream if <code class="code">d</code> is not a directory)</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (e.g. permission denied)</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">recurse</span>: if true (default <code class="code">false</code>), sub-directories are also
|
||||
explored</li></ul></div></div><div class="spec val" id="val-read_exn"><a href="#val-read_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><p>Read the content of the given file, or raises some exception</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-read"><a href="#val-read" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Read the content of the given file</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-append_exn"><a href="#val-append_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Append the given string into the given file, possibly raising</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-append"><a href="#val-append" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Append the given string into the given file</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-write_exn"><a href="#val-write_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given string into the given file, possibly raising</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-write"><a href="#val-write" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Write the given string into the given file</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec type" id="type-walk_item"><a href="#type-walk_item" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>walk_item</code><code><span class="keyword"> = </span>[ `File | `Dir ]<span class="keyword"> * </span><a href="index.html#type-t">t</a></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-walk"><a href="#val-walk" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>walk : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-walk_item">walk_item</a> <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p>Similar to <a href="index.html#val-read_dir">read_dir</a> (with <code class="code">recurse=true</code>), this function walks
|
||||
in the directory <code class="code">d</code> (or an empty stream if <code class="code">d</code> is not a directory).</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (e.g. permission denied).</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">recurse</span>: if true (default <code class="code">false</code>), sub-directories are also
|
||||
explored.</li></ul></div></div><div class="spec val" id="val-read_exn"><a href="#val-read_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><p>Read the content of the given file, or raises some exception.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-read"><a href="#val-read" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Read the content of the given file.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-append_exn"><a href="#val-append_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Append the given string into the given file, possibly raising.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-append"><a href="#val-append" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Append the given string into the given file.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-write_exn"><a href="#val-write_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_exn : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given string into the given file, possibly raising.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec val" id="val-write"><a href="#val-write" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> unit <a href="../index.html#type-or_error">or_error</a></code></div><div class="doc"><p>Write the given string into the given file.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.16</li></ul></div></div><div class="spec type" id="type-walk_item"><a href="#type-walk_item" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>walk_item</code><code><span class="keyword"> = </span>[ `File | `Dir ]<span class="keyword"> * </span><a href="index.html#type-t">t</a></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-walk"><a href="#val-walk" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>walk : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-walk_item">walk_item</a> <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p>Similar to <a href="index.html#val-read_dir">read_dir</a> (with <code class="code">recurse=true</code>), this function walks
|
||||
a directory recursively and yields either files or directories.
|
||||
Is a file anything that doesn't satisfy <a href="index.html#val-is_directory">is_directory</a> (including
|
||||
symlinks, etc.)</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (e.g. permission denied) during iteration</li></ul></div></div><div class="spec val" id="val-walk_l"><a href="#val-walk_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>walk_l : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-walk_item">walk_item</a> list</code></div><div class="doc"><p>Same as <a href="index.html#val-walk">walk</a> but returns a list (therefore it's eager and might
|
||||
take some time on large directories)</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.1</li></ul></div></div><div class="spec val" id="val-show_walk_item"><a href="#val-show_walk_item" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>show_walk_item : <a href="index.html#type-walk_item">walk_item</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-with_temp"><a href="#val-with_temp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_temp : ?⁠temp_dir:string <span class="keyword">‑></span> prefix:string <span class="keyword">‑></span> suffix:string <span class="keyword">‑></span> (string <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">with_temp ~prefix ~suffix f</code> will call <code class="code">f</code> with the name of a new
|
||||
symlinks, etc.)</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (e.g. permission denied) during iteration.</li></ul></div></div><div class="spec val" id="val-walk_l"><a href="#val-walk_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>walk_l : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-walk_item">walk_item</a> list</code></div><div class="doc"><p>Like <a href="index.html#val-walk">walk</a> but returns a list (therefore it's eager and might
|
||||
take some time on large directories).</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.1</li></ul></div></div><div class="spec val" id="val-show_walk_item"><a href="#val-show_walk_item" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>show_walk_item : <a href="index.html#type-walk_item">walk_item</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-with_temp"><a href="#val-with_temp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_temp : ?⁠temp_dir:string <span class="keyword">‑></span> prefix:string <span class="keyword">‑></span> suffix:string <span class="keyword">‑></span> (string <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p><code class="code">with_temp ~prefix ~suffix f</code> will call <code class="code">f</code> with the name of a new
|
||||
temporary file (located in <code class="code">temp_dir</code>).
|
||||
After <code class="code">f</code> returns, the file is deleted. Best to be used in
|
||||
combination with <a href="../index.html#val-with_out">with_out</a>.
|
||||
See <span class="xref-unresolved" title="unresolved reference to "Filename.temp_file"">Filename.temp_file</span></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div></body></html>
|
||||
See <span class="xref-unresolved" title="unresolved reference to "Filename.temp_file"">Filename.temp_file</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div></body></html>
|
||||
|
|
@ -10,13 +10,13 @@ like Lwt or Async, that are far more comprehensive.</p><p>Examples:</p><ul><li>o
|
|||
write_gen oc chunks
|
||||
)
|
||||
)
|
||||
) ;;</code></pre><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.6</li><li><span class="at-tag before">Before</span> 0.12.was in 'containers.io', now moved into 'containers'</li></ul><div class="spec type" id="type-or_error"><a href="#type-or_error" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a or_error</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span>, string) Result.result</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-gen"><a href="#type-gen" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a gen</code><code><span class="keyword"> = </span>unit <span class="keyword">‑></span> <span class="type-var">'a</span> option</code><code></code></div><div class="doc"><p>See Gen in the gen library</p></div></div><h3>Input</h3><div class="spec val" id="val-with_in"><a href="#val-with_in" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_in : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.in_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Open an input file with the given optional flag list, calls the function
|
||||
) ;;</code></pre><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.6</li><li><span class="at-tag before">Before</span> 0.12.was in 'containers.io', now moved into 'containers'</li></ul><div class="spec type" id="type-or_error"><a href="#type-or_error" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a or_error</code><code><span class="keyword"> = </span>(<span class="type-var">'a</span>, string) Result.result</code><code></code></div><div class="doc"></div></div><div class="spec type" id="type-gen"><a href="#type-gen" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a gen</code><code><span class="keyword"> = </span>unit <span class="keyword">‑></span> <span class="type-var">'a</span> option</code><code></code></div><div class="doc"><p>See Gen in the gen library.</p></div></div><h3>Input</h3><div class="spec val" id="val-with_in"><a href="#val-with_in" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_in : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.in_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Open an input file with the given optional flag list, calls the function
|
||||
on the input channel. When the function raises or returns, the
|
||||
channel is closed.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (same as open_in and close_in)</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: opening flags (default <code class="code">[Open_text]</code>). <code class="code">Open_rdonly</code> is used in any cases</li></ul></div></div><div class="spec val" id="val-read_chunks"><a href="#val-read_chunks" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_chunks : ?⁠size:int <span class="keyword">‑></span> Pervasives.in_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a></code></div><div class="doc"><p>Read the channel's content into chunks of size <code class="code">size</code></p></div></div><div class="spec val" id="val-read_line"><a href="#val-read_line" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_line : Pervasives.in_channel <span class="keyword">‑></span> string option</code></div><div class="doc"><p>Read a line from the channel. Returns <code class="code">None</code> if the input is terminated.
|
||||
The "\n" is removed from the line.</p></div></div><div class="spec val" id="val-read_lines"><a href="#val-read_lines" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_lines : Pervasives.in_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a></code></div><div class="doc"><p>Read all lines. The generator should be traversed only once.</p></div></div><div class="spec val" id="val-read_lines_l"><a href="#val-read_lines_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_lines_l : Pervasives.in_channel <span class="keyword">‑></span> string list</code></div><div class="doc"><p>Read all lines into a list</p></div></div><div class="spec val" id="val-read_all"><a href="#val-read_all" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_all : ?⁠size:int <span class="keyword">‑></span> Pervasives.in_channel <span class="keyword">‑></span> string</code></div><div class="doc"><p>Read the whole channel into a buffer, then converted into a string.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">size</span>: the internal buffer size</li><li><span class="at-tag since">Since</span>: 0.7</li></ul></div></div><div class="spec val" id="val-read_all_bytes"><a href="#val-read_all_bytes" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_all_bytes : ?⁠size:int <span class="keyword">‑></span> Pervasives.in_channel <span class="keyword">‑></span> Bytes.t</code></div><div class="doc"><p>Read the whole channel into a mutable byte array</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">size</span>: the internal buffer size</li><li><span class="at-tag since">Since</span>: 0.12</li></ul></div></div><h3>Output</h3><div class="spec val" id="val-with_out"><a href="#val-with_out" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_out : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.out_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Same as <a href="index.html#val-with_in">with_in</a> but for an output channel</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: opening flags (default <code class="code">[Open_creat; Open_trunc; Open_text]</code>).</li><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (same as open_out and close_out)
|
||||
<code class="code">Open_wronly</code> is used in any cases</li></ul></div></div><div class="spec val" id="val-with_out_a"><a href="#val-with_out_a" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_out_a : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.out_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Similar to <a href="index.html#val-with_out">with_out</a> but with the <code class="code">[Open_append; Open_creat; Open_wronly]</code>
|
||||
flags activated, to append to the file.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (same as open_out and close_out)</li></ul></div></div><div class="spec val" id="val-write_line"><a href="#val-write_line" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_line : Pervasives.out_channel <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given string on the channel, followed by "\n"</p></div></div><div class="spec val" id="val-write_gen"><a href="#val-write_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_gen : ?⁠sep:string <span class="keyword">‑></span> Pervasives.out_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given strings on the output. If provided, add <code class="code">sep</code> between
|
||||
every two strings (but not at the end)</p></div></div><div class="spec val" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_lines : Pervasives.out_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write every string on the output, followed by "\n".</p></div></div><div class="spec val" id="val-write_lines_l"><a href="#val-write_lines_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_lines_l : Pervasives.out_channel <span class="keyword">‑></span> string list <span class="keyword">‑></span> unit</code></div><div class="doc"></div></div><h3>Both</h3><div class="spec val" id="val-with_in_out"><a href="#val-with_in_out" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_in_out : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.in_channel <span class="keyword">‑></span> Pervasives.out_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Combines <a href="index.html#val-with_in">with_in</a> and <a href="index.html#val-with_out">with_out</a>.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: opening flags (default <code class="code">[Open_creat]</code>)</li><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error</li><li><span class="at-tag since">Since</span>: 0.12</li></ul></div></div><h3>Misc for Generators</h3><div class="spec val" id="val-tee"><a href="#val-tee" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>tee : (<span class="type-var">'a</span> <span class="keyword">‑></span> unit) list <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-gen">gen</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-gen">gen</a></code></div><div class="doc"><p><code class="code">tee funs gen</code> behaves like <code class="code">gen</code>, but each element is given to
|
||||
channel is closed.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (same as open_in and close_in).</li><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: opening flags (default <code class="code">[Open_text]</code>). <code class="code">Open_rdonly</code> is used in any cases.</li></ul></div></div><div class="spec val" id="val-read_chunks"><a href="#val-read_chunks" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_chunks : ?⁠size:int <span class="keyword">‑></span> Pervasives.in_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a></code></div><div class="doc"><p>Read the channel's content into chunks of size <code class="code">size</code>.</p></div></div><div class="spec val" id="val-read_line"><a href="#val-read_line" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_line : Pervasives.in_channel <span class="keyword">‑></span> string option</code></div><div class="doc"><p>Read a line from the channel. Returns <code class="code">None</code> if the input is terminated.
|
||||
The "\n" is removed from the line.</p></div></div><div class="spec val" id="val-read_lines"><a href="#val-read_lines" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_lines : Pervasives.in_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a></code></div><div class="doc"><p>Read all lines. The generator should be traversed only once.</p></div></div><div class="spec val" id="val-read_lines_l"><a href="#val-read_lines_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_lines_l : Pervasives.in_channel <span class="keyword">‑></span> string list</code></div><div class="doc"><p>Read all lines into a list.</p></div></div><div class="spec val" id="val-read_all"><a href="#val-read_all" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_all : ?⁠size:int <span class="keyword">‑></span> Pervasives.in_channel <span class="keyword">‑></span> string</code></div><div class="doc"><p>Read the whole channel into a buffer, then converted into a string.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">size</span>: the internal buffer size.</li><li><span class="at-tag since">Since</span>: 0.7</li></ul></div></div><div class="spec val" id="val-read_all_bytes"><a href="#val-read_all_bytes" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>read_all_bytes : ?⁠size:int <span class="keyword">‑></span> Pervasives.in_channel <span class="keyword">‑></span> Bytes.t</code></div><div class="doc"><p>Read the whole channel into a mutable byte array.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">size</span>: the internal buffer size.</li><li><span class="at-tag since">Since</span>: 0.12</li></ul></div></div><h3>Output</h3><div class="spec val" id="val-with_out"><a href="#val-with_out" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_out : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.out_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Like <a href="index.html#val-with_in">with_in</a> but for an output channel.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: opening flags (default <code class="code">[Open_creat; Open_trunc; Open_text]</code>).</li><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (same as open_out and close_out).
|
||||
<code class="code">Open_wronly</code> is used in any cases.</li></ul></div></div><div class="spec val" id="val-with_out_a"><a href="#val-with_out_a" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_out_a : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.out_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Similar to <a href="index.html#val-with_out">with_out</a> but with the <code class="code">[Open_append; Open_creat; Open_wronly]</code>
|
||||
flags activated, to append to the file.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error (same as open_out and close_out).</li></ul></div></div><div class="spec val" id="val-write_line"><a href="#val-write_line" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_line : Pervasives.out_channel <span class="keyword">‑></span> string <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given string on the channel, followed by "\n".</p></div></div><div class="spec val" id="val-write_gen"><a href="#val-write_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_gen : ?⁠sep:string <span class="keyword">‑></span> Pervasives.out_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write the given strings on the output. If provided, add <code class="code">sep</code> between
|
||||
every two strings (but not at the end).</p></div></div><div class="spec val" id="val-write_lines"><a href="#val-write_lines" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_lines : Pervasives.out_channel <span class="keyword">‑></span> string <a href="index.html#type-gen">gen</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Write every string on the output, followed by "\n".</p></div></div><div class="spec val" id="val-write_lines_l"><a href="#val-write_lines_l" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>write_lines_l : Pervasives.out_channel <span class="keyword">‑></span> string list <span class="keyword">‑></span> unit</code></div><div class="doc"></div></div><h3>Both</h3><div class="spec val" id="val-with_in_out"><a href="#val-with_in_out" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_in_out : ?⁠mode:int <span class="keyword">‑></span> ?⁠flags:Pervasives.open_flag list <span class="keyword">‑></span> string <span class="keyword">‑></span> (Pervasives.in_channel <span class="keyword">‑></span> Pervasives.out_channel <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Combines <a href="index.html#val-with_in">with_in</a> and <a href="index.html#val-with_out">with_out</a>.</p><ul class="at-tag"><li><span class="at-tag parameter">Parameter</span> <span class="module-path">flags</span>: opening flags (default <code class="code">[Open_creat]</code>).</li><li><span class="at-tag raise">Raises</span> <span class="module-path">Sys_error</span>: in case of error.</li><li><span class="at-tag since">Since</span>: 0.12</li></ul></div></div><h3>Misc for Generators</h3><div class="spec val" id="val-tee"><a href="#val-tee" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>tee : (<span class="type-var">'a</span> <span class="keyword">‑></span> unit) list <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-gen">gen</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-gen">gen</a></code></div><div class="doc"><p><code class="code">tee funs gen</code> behaves like <code class="code">gen</code>, but each element is given to
|
||||
every function <code class="code">f</code> in <code class="code">funs</code> at the time the element is produced.</p></div></div><h3>File and file names</h3><p>How to list recursively files in a directory:
|
||||
</p><pre><code class="code"> # let files = CCIO.File.read_dir ~recurse:true (CCIO.File.make "/tmp");;
|
||||
# CCIO.write_lines stdout files;;</code></pre><p>See <a href="File/index.html#val-walk">File.walk</a> if you also need to list directories:</p><pre><code class="code"> # let content = CCIO.File.walk (CCIO.File.make "/tmp");;
|
||||
|
|
|
|||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCInt.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCInt.Infix</span></h1></header><div class="doc"><h3>Infix Operators</h3><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div><div class="spec val" id="val-(=)"><a href="#val-(=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<)"><a href="#val-(<)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>)"><a href="#val-(>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(--)"><a href="#val-(--)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Alias to <a href="../index.html#val-range">range</a></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.2</li></ul></div></div><div class="spec val" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--^) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Alias to <a href="../index.html#val-range'">range'</a></p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.2</li></ul></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCInt.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCInt.Infix</span></h1></header><div class="spec val" id="val-(=)"><a href="#val-(=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<)"><a href="#val-(<)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>)"><a href="#val-(>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>=) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-(--)"><a href="#val-(--)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Alias to <a href="../index.html#val-range">range</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.2</li></ul></div></div><div class="spec val" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--^) : <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <a href="../index.html#type-t">t</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Alias to <a href="../index.html#val-range'">range'</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.2</li></ul></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,19 +1,19 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCInt64 (containers.CCInt64)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCInt64</span></h1></header><h2>Int64</h2><p>Helpers for in64.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.13</li></ul><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>int64</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-(+)"><a href="#val-(+)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(+) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Addition.</p></div></div><div class="spec val" id="val-(-)"><a href="#val-(-)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(-) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Subtraction.</p></div></div><div class="spec val" id="val-(~-)"><a href="#val-(~-)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(~-) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Unary negation.</p></div></div><div class="spec val" id="val-(*)"><a href="#val-(*)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(*) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Multiplication.</p></div></div><div class="spec val" id="val-(/)"><a href="#val-(/)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(/) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Integer division. Raise <code class="code">Division_by_zero</code> if the second
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCInt64 (containers.CCInt64)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCInt64</span></h1></header><h2>Int64</h2><p>Helpers for 64-bit integers.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.13</li></ul><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>int64</code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-(+)"><a href="#val-(+)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(+) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Addition.</p></div></div><div class="spec val" id="val-(-)"><a href="#val-(-)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(-) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Subtraction.</p></div></div><div class="spec val" id="val-(~-)"><a href="#val-(~-)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(~-) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Unary negation.</p></div></div><div class="spec val" id="val-(*)"><a href="#val-(*)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(*) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Multiplication.</p></div></div><div class="spec val" id="val-(/)"><a href="#val-(/)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(/) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Integer division. Raise <code class="code">Division_by_zero</code> if the second
|
||||
argument is zero. This division rounds the real quotient of
|
||||
its arguments towards zero, as specified for <span class="xref-unresolved" title="unresolved reference to "Pervasives.(/)"">Pervasives.(/)</span>.</p></div></div><div class="spec val" id="val-(mod)"><a href="#val-(mod)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(mod) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Integer remainder.
|
||||
If <code class="code">y = 0</code>, <code class="code">x mod y</code> raises <code class="code">Division_by_zero</code>.</p></div></div><div class="spec val" id="val-abs"><a href="#val-abs" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>abs : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Return the absolute value of its argument.</p></div></div><div class="spec val" id="val-max_int"><a href="#val-max_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>max_int : <a href="index.html#type-t">t</a></code></div><div class="doc"><p>The greatest representable 64-bit integer, 2<sup>63</sup> - 1.</p></div></div><div class="spec val" id="val-min_int"><a href="#val-min_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>min_int : <a href="index.html#type-t">t</a></code></div><div class="doc"><p>The smallest representable 64-bit integer, -2<sup>63</sup>.</p></div></div><div class="spec val" id="val-(land)"><a href="#val-(land)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(land) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical and.</p></div></div><div class="spec val" id="val-(lor)"><a href="#val-(lor)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lor) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical or.</p></div></div><div class="spec val" id="val-(lxor)"><a href="#val-(lxor)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lxor) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical exclusive or.</p></div></div><div class="spec val" id="val-(lnot)"><a href="#val-(lnot)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lnot) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical negation.</p></div></div><div class="spec val" id="val-(lsl)"><a href="#val-(lsl)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lsl) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code"> x lsl y</code> shifts <code class="code">x</code> to the left by <code class="code">y</code> bits.
|
||||
If <code class="code">y = 0</code>, <code class="code">x mod y</code> raises <code class="code">Division_by_zero</code>.</p></div></div><div class="spec val" id="val-abs"><a href="#val-abs" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>abs : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Return the absolute value of its argument.</p></div></div><div class="spec val" id="val-max_int"><a href="#val-max_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>max_int : <a href="index.html#type-t">t</a></code></div><div class="doc"><p>The greatest representable 64-bit integer, 2<sup>63</sup> - 1 = <code class="code">9_223_372_036_854_775_807</code>.</p></div></div><div class="spec val" id="val-min_int"><a href="#val-min_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>min_int : <a href="index.html#type-t">t</a></code></div><div class="doc"><p>The smallest representable 64-bit integer, -2<sup>63</sup> = <code class="code">-9_223_372_036_854_775_808</code>.</p></div></div><div class="spec val" id="val-(land)"><a href="#val-(land)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(land) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical and.</p></div></div><div class="spec val" id="val-(lor)"><a href="#val-(lor)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lor) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical or.</p></div></div><div class="spec val" id="val-(lxor)"><a href="#val-(lxor)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lxor) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical exclusive or.</p></div></div><div class="spec val" id="val-(lnot)"><a href="#val-(lnot)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lnot) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Bitwise logical negation.</p></div></div><div class="spec val" id="val-(lsl)"><a href="#val-(lsl)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lsl) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code"> x lsl y</code> shifts <code class="code">x</code> to the left by <code class="code">y</code> bits, filling in with zeroes.
|
||||
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 64</code>.</p></div></div><div class="spec val" id="val-(lsr)"><a href="#val-(lsr)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(lsr) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">x lsr y</code> shifts <code class="code">x</code> to the right by <code class="code">y</code> bits.
|
||||
This is a logical shift: zeroes are inserted in the vacated bits
|
||||
regardless of the sign of <code class="code">x</code>.
|
||||
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 64</code>.</p></div></div><div class="spec val" id="val-(asr)"><a href="#val-(asr)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(asr) : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">x asr y</code> shifts <code class="code">x</code> to the right by <code class="code">y</code> bits.
|
||||
This is an arithmetic shift: the sign bit of <code class="code">x</code> is replicated
|
||||
and inserted in the vacated bits.
|
||||
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 64</code>.</p></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>The equal function for int64s.
|
||||
Same as <span class="xref-unresolved" title="unresolved reference to "Pervasives.(=) x y)"">Pervasives.(=) x y)</span>.</p></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>The comparison function for 64-bit integers, with the same specification as
|
||||
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= 64</code>.</p></div></div><div class="spec val" id="val-equal"><a href="#val-equal" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equal : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>The equal function for 64-bit integers.
|
||||
Like <span class="xref-unresolved" title="unresolved reference to "Pervasives.(=) x y)"">Pervasives.(=) x y)</span>.</p></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>The comparison function for 64-bit integers, with the same specification as
|
||||
<span class="xref-unresolved" title="unresolved reference to "Pervasives.compare"">Pervasives.compare</span>. Along with the type <code class="code">t</code>, this function <code class="code">compare</code>
|
||||
allows the module <code class="code">CCInt64</code> to be passed as argument to the functors
|
||||
<span class="xref-unresolved" title="unresolved reference to "Set.Make"">Set.Make</span> and <span class="xref-unresolved" title="unresolved reference to "Map.Make"">Map.Make</span>.</p></div></div><div class="spec val" id="val-hash"><a href="#val-hash" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>hash : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Same as <span class="xref-unresolved" title="unresolved reference to "Pervasives.abs (to_int x)"">Pervasives.abs (to_int x)</span>.</p></div></div><h3>Conversion</h3><div class="spec val" id="val-to_int"><a href="#val-to_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_int : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Convert the given 64-bit integer (type <code class="code">int64</code>) to an
|
||||
<span class="xref-unresolved" title="unresolved reference to "Set.Make"">Set.Make</span> and <span class="xref-unresolved" title="unresolved reference to "Map.Make"">Map.Make</span>.</p></div></div><div class="spec val" id="val-hash"><a href="#val-hash" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>hash : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Like <span class="xref-unresolved" title="unresolved reference to "Pervasives.abs (to_int x)"">Pervasives.abs (to_int x)</span>.</p></div></div><h3>Conversion</h3><div class="spec val" id="val-to_int"><a href="#val-to_int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_int : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Convert the given 64-bit integer (type <code class="code">int64</code>) to an
|
||||
integer (type <code class="code">int</code>). On 64-bit platforms, the 64-bit integer
|
||||
is taken modulo 2<sup>63</sup>, i.e. the high-order bit is lost
|
||||
during the conversion. On 32-bit platforms, the 64-bit integer
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCList.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCList.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(@)"><a href="#val-(@)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(@) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<$>)"><a href="#val-(<$>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<$>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(--)"><a href="#val-(--)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--^) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCList.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCList.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix version of <code class="code">map</code> with reversed arguments.</p></div></div><div class="spec val" id="val-(@)"><a href="#val-(@)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(@) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>As <a href="../index.html#val-append">append</a>. Concatenate two lists.</p></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">fun <*> l</code> is <code class="code">product (fun f x -> f x) funs l</code>.</p></div></div><div class="spec val" id="val-(<$>)"><a href="#val-(<$>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<$>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>As <a href="../index.html#val-map">map</a>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">l >>= f</code> is <code class="code">flat_map f l</code>.</p></div></div><div class="spec val" id="val-(--)"><a href="#val-(--)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix alias for <code class="code">range</code>. Bounds included.</p></div></div><div class="spec val" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--^) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix alias for <code class="code">range'</code>. Second bound excluded.</p></div></div><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-M (containers.CCList.Traverse.1-M)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCList.Traverse.1-M</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-M (containers.CCList.Traverse.1-M)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCList.Traverse.1-M</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Traverse (containers.CCList.Traverse)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCList.Traverse</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-M"><a href="#argument-1-M" class="anchor"></a><div class="def argument"><code><a href="argument-1-M/index.html">M</a> : <a href="../index.html#module-type-MONAD">MONAD</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec val" id="val-sequence_m"><a href="#val-sequence_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sequence_m : <span class="type-var">'a</span> <a href="argument-1-M/index.html#type-t">M.t</a> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-fold_m"><a href="#val-fold_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold_m : (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m"><a href="#val-map_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m_par"><a href="#val-map_m_par" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m_par : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"><p>Same as <a href="index.html#val-map_m">map_m</a> but <code class="code">map_m_par f (x::l)</code> evaluates <code class="code">f x</code> and
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Traverse (containers.CCList.Traverse)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCList.Traverse</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-M"><a href="#argument-1-M" class="anchor"></a><div class="def argument"><code><a href="argument-1-M/index.html">M</a> : <a href="../index.html#module-type-MONAD">MONAD</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec val" id="val-sequence_m"><a href="#val-sequence_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sequence_m : <span class="type-var">'a</span> <a href="argument-1-M/index.html#type-t">M.t</a> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-fold_m"><a href="#val-fold_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold_m : (<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m"><a href="#val-map_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m_par"><a href="#val-map_m_par" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m_par : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"><p>Like <a href="index.html#val-map_m">map_m</a> but <code class="code">map_m_par f (x::l)</code> evaluates <code class="code">f x</code> and
|
||||
<code class="code">f l</code> "in parallel" before combining their result (for instance
|
||||
in Lwt).</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONAD (containers.CCList.MONAD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCList.MONAD</span></h1></header><div class="doc"><h3>Monadic Operations</h3></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONAD (containers.CCList.MONAD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCList.MONAD</span></h1></header><div class="doc"><h3>Monadic Operations</h3></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCListLabels.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCListLabels.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(@)"><a href="#val-(@)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(@) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<$>)"><a href="#val-(<$>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<$>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(--)"><a href="#val-(--)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--^) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCListLabels.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCListLabels.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix version of <code class="code">map</code> with reversed arguments.</p></div></div><div class="spec val" id="val-(@)"><a href="#val-(@)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(@) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>As <a href="../index.html#val-append">append</a>. Concatenate two lists.</p></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">fun <*> l</code> is <code class="code">product (fun f x -> f x) funs l</code>.</p></div></div><div class="spec val" id="val-(<$>)"><a href="#val-(<$>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<$>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>As <a href="../index.html#val-map">map</a>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">l >>= f</code> is <code class="code">flat_map f l</code>.</p></div></div><div class="spec val" id="val-(--)"><a href="#val-(--)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix alias for <code class="code">range</code>. Bounds included.</p></div></div><div class="spec val" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(--^) : int <span class="keyword">‑></span> int <span class="keyword">‑></span> int <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix alias for <code class="code">range'</code>. Second bound excluded.</p></div></div><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-M (containers.CCListLabels.Traverse.1-M)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCListLabels.Traverse.1-M</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-M (containers.CCListLabels.Traverse.1-M)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCListLabels.Traverse.1-M</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Traverse (containers.CCListLabels.Traverse)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCListLabels.Traverse</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-M"><a href="#argument-1-M" class="anchor"></a><div class="def argument"><code><a href="argument-1-M/index.html">M</a> : <a href="../index.html#module-type-MONAD">MONAD</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec val" id="val-sequence_m"><a href="#val-sequence_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sequence_m : <span class="type-var">'a</span> <a href="argument-1-M/index.html#type-t">M.t</a> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-fold_m"><a href="#val-fold_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold_m : f:(<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> init:<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m"><a href="#val-map_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m : f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m_par"><a href="#val-map_m_par" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m_par : f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"><p>Same as <a href="index.html#val-map_m">map_m</a> but <code class="code">map_m_par f (x::l)</code> evaluates <code class="code">f x</code> and
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Traverse (containers.CCListLabels.Traverse)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCListLabels.Traverse</span></h1></header><h3 class="heading">Parameters</h3><div><div class="spec argument" id="argument-1-M"><a href="#argument-1-M" class="anchor"></a><div class="def argument"><code><a href="argument-1-M/index.html">M</a> : <a href="../index.html#module-type-MONAD">MONAD</a></code></div><div class="doc"></div></div></div><h3 class="heading">Signature</h3><div class="spec val" id="val-sequence_m"><a href="#val-sequence_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sequence_m : <span class="type-var">'a</span> <a href="argument-1-M/index.html#type-t">M.t</a> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-fold_m"><a href="#val-fold_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold_m : f:(<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> init:<span class="type-var">'b</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m"><a href="#val-map_m" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m : f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map_m_par"><a href="#val-map_m_par" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map_m_par : f:(<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="argument-1-M/index.html#type-t">M.t</a>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <a href="argument-1-M/index.html#type-t">M.t</a></code></div><div class="doc"><p>Like <a href="index.html#val-map_m">map_m</a> but <code class="code">map_m_par f (x::l)</code> evaluates <code class="code">f x</code> and
|
||||
<code class="code">f l</code> "in parallel" before combining their result (for instance
|
||||
in Lwt).</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONAD (containers.CCListLabels.MONAD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCListLabels.MONAD</span></h1></header><div class="doc"><h3>Monadic Operations</h3></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONAD (containers.CCListLabels.MONAD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCListLabels.MONAD</span></h1></header><div class="doc"><h3>Monadic Operations</h3></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
|
|
@ -4,7 +4,7 @@ and returns <code class="code">default</code> otherwise (if <code class="code">k
|
|||
otherwise it calls <code class="code">f None</code>. In any case, if the result is <code class="code">None</code><code class="code">k</code> is removed from <code class="code">m</code>, and if the result is <code class="code">Some v'</code> then
|
||||
<code class="code">add k v' m</code> is returned.</p></div></div><div class="spec val" id="val-choose_opt"><a href="#val-choose_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>choose_opt : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-choose">choose</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-min_binding_opt"><a href="#val-min_binding_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>min_binding_opt : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-min_binding">min_binding</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-max_binding_opt"><a href="#val-max_binding_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>max_binding_opt : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-max_binding">max_binding</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-find_opt"><a href="#val-find_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find_opt : <a href="index.html#type-key">key</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-find">find</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-find_first"><a href="#val-find_first" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find_first : (<a href="index.html#type-key">key</a> <span class="keyword">‑></span> bool) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span></code></div><div class="doc"><p>Find smallest binding satisfying the monotonic predicate.
|
||||
See <span class="xref-unresolved" title="unresolved reference to "Map.S.find_first""><span class="xref-unresolved" title="unresolved reference to "Map.S"">Map.S</span>.find_first</span>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-find_first_opt"><a href="#val-find_first_opt" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>find_first_opt : (<a href="index.html#type-key">key</a> <span class="keyword">‑></span> bool) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) option</code></div><div class="doc"><p>Safe version of <a href="index.html#val-find_first">find_first</a>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.5</li></ul></div></div><div class="spec val" id="val-merge_safe"><a href="#val-merge_safe" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>merge_safe : f:(<a href="index.html#type-key">key</a> <span class="keyword">‑></span> [ `Left of <span class="type-var">'a</span> | `Right of <span class="type-var">'b</span> | `Both of <span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span> ] <span class="keyword">‑></span> <span class="type-var">'c</span> option) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">merge_safe ~f a b</code> merges the maps <code class="code">a</code> and <code class="code">b</code> together.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.17</li></ul></div></div><div class="spec val" id="val-union"><a href="#val-union" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>union : (<a href="index.html#type-key">key</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> option) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Union of both maps, using the function to combine bindings
|
||||
that belong to both inputs.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.4</li></ul></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Same as <a href="index.html#val-of_list">of_list</a>.</p></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) list <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Build a map from the given list of bindings <code class="code">k_i -> v_i</code>,
|
||||
that belong to both inputs.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.4</li></ul></div></div><div class="spec val" id="val-of_seq"><a href="#val-of_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_seq : (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Like <a href="index.html#val-of_list">of_list</a>.</p></div></div><div class="spec val" id="val-add_seq"><a href="#val-add_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_seq : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="../index.html#type-sequence">sequence</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div><div class="spec val" id="val-of_list"><a href="#val-of_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_list : (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) list <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Build a map from the given list of bindings <code class="code">k_i -> v_i</code>,
|
||||
added in order using <a href="index.html#val-add">add</a>.
|
||||
If a key occurs several times, only its last binding
|
||||
will be present in the result.</p></div></div><div class="spec val" id="val-add_list"><a href="#val-add_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>add_list : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) list <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.14</li></ul></div></div><div class="spec val" id="val-keys"><a href="#val-keys" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>keys : <span class="type-var">_</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on keys only.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.15</li></ul></div></div><div class="spec val" id="val-values"><a href="#val-values" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>values : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Iterate on values only.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.15</li></ul></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<a href="index.html#type-key">key</a><span class="keyword"> * </span><span class="type-var">'a</span>) list</code></div><div class="doc"></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : ?⁠start:string <span class="keyword">‑></span> ?⁠stop:string <span class="keyword">‑></span> ?⁠arrow:string <span class="keyword">‑></span> ?⁠sep:string <span class="keyword">‑></span> <a href="index.html#type-key">key</a> <a href="../index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <a href="../index.html#type-printer">printer</a></code></div><div class="doc"></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCOpt.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCOpt.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<$>)"><a href="#val-(<$>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<$>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<+>)"><a href="#val-(<+>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<+>) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCOpt.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCOpt.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">x >|= f</code> is <code class="code">map f x</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Monadic bind.</p></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">f <$> (Some x)</code> returns <code class="code">Some (f x)</code> and <code class="code">f <$> None</code> returns <code class="code">None</code>.</p></div></div><div class="spec val" id="val-(<$>)"><a href="#val-(<$>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<$>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Like <code class="code">map</code>.</p></div></div><div class="spec val" id="val-(<+>)"><a href="#val-(<+>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<+>) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">a <+> b</code> is <code class="code">a</code> if <code class="code">a</code> is <code class="code">Some _</code>, <code class="code">b</code> otherwise.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCOrd.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCOrd.Infix</span></h1></header><div class="spec val" id="val-(<?>)"><a href="#val-(<?>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<?>) : int <span class="keyword">‑></span> (<span class="type-var">'a</span> <a href="../index.html#type-t">t</a><span class="keyword"> * </span><span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'a</span>) <span class="keyword">‑></span> int</code></div><div class="doc"></div></div><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCOrd.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCOrd.Infix</span></h1></header><div class="spec val" id="val-(<?>)"><a href="#val-(<?>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<?>) : int <span class="keyword">‑></span> (<span class="type-var">'a</span> <a href="../index.html#type-t">t</a><span class="keyword"> * </span><span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'a</span>) <span class="keyword">‑></span> int</code></div><div class="doc"><p><code class="code">c1 <?> (ord, x, y)</code> returns the same as <code class="code">c1</code> if <code class="code">c1</code> is not <code class="code">0</code>;
|
||||
otherwise it uses <code class="code">ord</code> to compare the two values <code class="code">x</code> and <code class="code">y</code>,
|
||||
of type <code class="code">'a</code>.</p></div></div><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Infix equivalent of <a href="../index.html#val-map">map</a>.</p></div></div></body></html>
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCOrd (containers.CCOrd)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCOrd</span></h1></header><h2>Comparisons</h2><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int</code><code></code></div><div class="doc"><p>Comparison (total ordering) between two elements, that returns an int</p></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Polymorphic "magic" comparison</p></div></div><div class="spec val" id="val-opp"><a href="#val-opp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>opp : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Opposite order</p></div></div><div class="spec val" id="val-equiv"><a href="#val-equiv" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equiv : int <span class="keyword">‑></span> int <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Returns <code class="code">true</code> iff the two comparison results are the same</p></div></div><div class="spec val" id="val-int"><a href="#val-int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int : int <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-string"><a href="#val-string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>string : string <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-bool"><a href="#val-bool" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>bool : bool <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-float"><a href="#val-float" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>float : float <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><h3>Lexicographic Combination</h3><div class="spec val" id="val-(<?>)"><a href="#val-(<?>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<?>) : int <span class="keyword">‑></span> (<span class="type-var">'a</span> <a href="index.html#type-t">t</a><span class="keyword"> * </span><span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'a</span>) <span class="keyword">‑></span> int</code></div><div class="doc"><p><code class="code">c1 <?> (ord, x, y)</code> returns the same as <code class="code">c1</code> if <code class="code">c1</code> is not <code class="code">0</code>;
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCOrd (containers.CCOrd)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCOrd</span></h1></header><h2>Comparisons</h2><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code><span class="keyword"> = </span><span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> int</code><code></code></div><div class="doc"><p>Comparison (total ordering) between two elements, that returns an int.</p></div></div><div class="spec val" id="val-compare"><a href="#val-compare" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>compare : <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Polymorphic "magic" comparison.</p></div></div><div class="spec val" id="val-opp"><a href="#val-opp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>opp : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Opposite order.</p></div></div><div class="spec val" id="val-equiv"><a href="#val-equiv" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>equiv : int <span class="keyword">‑></span> int <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Returns <code class="code">true</code> iff the two comparison results are the same.</p></div></div><div class="spec val" id="val-int"><a href="#val-int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int : int <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-string"><a href="#val-string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>string : string <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-bool"><a href="#val-bool" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>bool : bool <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-float"><a href="#val-float" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>float : float <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><h3>Lexicographic Combination</h3><div class="spec val" id="val-(<?>)"><a href="#val-(<?>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<?>) : int <span class="keyword">‑></span> (<span class="type-var">'a</span> <a href="index.html#type-t">t</a><span class="keyword"> * </span><span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'a</span>) <span class="keyword">‑></span> int</code></div><div class="doc"><p><code class="code">c1 <?> (ord, x, y)</code> returns the same as <code class="code">c1</code> if <code class="code">c1</code> is not <code class="code">0</code>;
|
||||
otherwise it uses <code class="code">ord</code> to compare the two values <code class="code">x</code> and <code class="code">y</code>,
|
||||
of type <code class="code">'a</code>.</p><p>Example:
|
||||
</p><pre><code class="code">CCInt.compare 1 3
|
||||
|
|
@ -7,9 +7,9 @@ of type <code class="code">'a</code>.</p><p>Example:
|
|||
<?> (CCBool.compare, true, false)</code></pre><p>Same example, using only CCOrd::
|
||||
</p><pre><code class="code">CCOrd.(int 1 3
|
||||
<?> (string, "a", "b")
|
||||
<?> (bool, true, false))</code></pre></div></div><div class="spec val" id="val-option"><a href="#val-option" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>option : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Comparison of optional values. <code class="code">None</code> is smaller than any <code class="code">Some _</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.15</li></ul></div></div><div class="spec val" id="val-pair"><a href="#val-pair" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pair : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-triple"><a href="#val-triple" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>triple : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-list"><a href="#val-list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Lexicographic combination on lists</p></div></div><div class="spec val" id="val-array"><a href="#val-array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>array : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map"><a href="#val-map" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">map f ord</code> is the comparison function that, given objects <code class="code">x</code> and <code class="code">y</code>,
|
||||
<?> (bool, true, false))</code></pre></div></div><div class="spec val" id="val-option"><a href="#val-option" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>option : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Comparison of optional values. <code class="code">None</code> is smaller than any <code class="code">Some _</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.15</li></ul></div></div><div class="spec val" id="val-pair"><a href="#val-pair" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pair : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-triple"><a href="#val-triple" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>triple : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-list"><a href="#val-list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Lexicographic combination on lists.</p></div></div><div class="spec val" id="val-array"><a href="#val-array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>array : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-map"><a href="#val-map" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>map : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">map f ord</code> is the comparison function that, given objects <code class="code">x</code> and <code class="code">y</code>,
|
||||
projects <code class="code">x</code> and <code class="code">y</code> using <code class="code">f</code> (e.g. using a record field) and then
|
||||
compares those projections with <code class="code">ord</code>.
|
||||
Example:
|
||||
<code class="code">map fst CCInt.compare</code> compares values of type <code class="code">(int * 'a)</code> by their
|
||||
first component.</p></div></div><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Infix equivalent of <a href="index.html#val-map">map</a></p></div></div><div class="spec module" id="module-Infix"><a href="#module-Infix" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Infix/index.html">Infix</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div></body></html>
|
||||
first component.</p></div></div><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'b</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Infix equivalent of <a href="index.html#val-map">map</a>.</p></div></div><div class="spec module" id="module-Infix"><a href="#module-Infix" class="anchor"></a><div class="def module"><code><span class="keyword">module </span><a href="Infix/index.html">Infix</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="doc"></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,13 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCParse.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCParse.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<*)"><a href="#val-(<*)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">_</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(*>)"><a href="#val-(*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(*>) : <span class="type-var">_</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<|>)"><a href="#val-(<|>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<|>) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<?>)"><a href="#val-(<?>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<?>) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCParse.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCParse.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Map.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Monadic bind.
|
||||
<code class="code">p >>= f</code> results in a new parser which behaves as <code class="code">p</code> then,
|
||||
in case of success, applies <code class="code">f</code> to the result.</p></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Applicative.</p></div></div><div class="spec val" id="val-(<*)"><a href="#val-(<*)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">_</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">a <* b</code> parses <code class="code">a</code> into <code class="code">x</code>, parses <code class="code">b</code> and ignores its result,
|
||||
and returns <code class="code">x</code>.</p></div></div><div class="spec val" id="val-(*>)"><a href="#val-(*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(*>) : <span class="type-var">_</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">a *> b</code> parses <code class="code">a</code>, then parses <code class="code">b</code> into <code class="code">x</code>, and returns <code class="code">x</code>. The
|
||||
results of <code class="code">a</code> is ignored.</p></div></div><div class="spec val" id="val-(<|>)"><a href="#val-(<|>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<|>) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">a <|> b</code> tries to parse <code class="code">a</code>, and if <code class="code">a</code> fails without
|
||||
consuming any input, backtracks and tries
|
||||
to parse <code class="code">b</code>, otherwise it fails as <code class="code">a</code>.
|
||||
See <a href="../index.html#val-try_">try_</a> to ensure <code class="code">a</code> does not consume anything (but it is best
|
||||
to avoid wrapping large parsers with <a href="../index.html#val-try_">try_</a>).</p></div></div><div class="spec val" id="val-(<?>)"><a href="#val-(<?>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<?>) : <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> string <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">a <?> msg</code> behaves like <code class="code">a</code>, but if <code class="code">a</code> fails without
|
||||
consuming any input, it fails with <code class="code">msg</code>
|
||||
instead. Useful as the last choice in a series of <code class="code"><|></code>:
|
||||
<code class="code">a <|> b <|> c <?> "expected a|b|c"</code>.</p></div></div></body></html>
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>U (containers.CCParse.U)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCParse.U</span></h1></header><div class="spec val" id="val-list"><a href="#val-list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>list : ?⁠start:string <span class="keyword">‑></span> ?⁠stop:string <span class="keyword">‑></span> ?⁠sep:string <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">list p</code> parses a list of <code class="code">p</code>, with the OCaml conventions for
|
||||
start token "<code class="code">", stop token "</code>" and separator ";".
|
||||
Whitespace between items are skipped</p></div></div><div class="spec val" id="val-int"><a href="#val-int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int : int <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-word"><a href="#val-word" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>word : string <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>non empty string of alpha num, start with alpha</p></div></div><div class="spec val" id="val-pair"><a href="#val-pair" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pair : ?⁠start:string <span class="keyword">‑></span> ?⁠stop:string <span class="keyword">‑></span> ?⁠sep:string <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Parse a pair using OCaml whitespace conventions.
|
||||
Whitespace between items are skipped.</p></div></div><div class="spec val" id="val-int"><a href="#val-int" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>int : int <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Parse an int.</p></div></div><div class="spec val" id="val-word"><a href="#val-word" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>word : string <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Non empty string of alpha num, start with alpha.</p></div></div><div class="spec val" id="val-pair"><a href="#val-pair" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pair : ?⁠start:string <span class="keyword">‑></span> ?⁠stop:string <span class="keyword">‑></span> ?⁠sep:string <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Parse a pair using OCaml whitespace conventions.
|
||||
The default is "(a, b)".</p></div></div><div class="spec val" id="val-triple"><a href="#val-triple" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>triple : ?⁠start:string <span class="keyword">‑></span> ?⁠stop:string <span class="keyword">‑></span> ?⁠sep:string <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'c</span> <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span><span class="keyword"> * </span><span class="type-var">'b</span><span class="keyword"> * </span><span class="type-var">'c</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Parse a triple using OCaml whitespace conventions.
|
||||
The default is "(a, b, c)".</p></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
|
|
@ -1,2 +1,5 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCResult.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCResult.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : (<span class="type-var">'a</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : (<span class="type-var">'a</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCResult.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCResult.Infix</span></h1></header><div class="spec val" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>|=) : (<span class="type-var">'a</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : (<span class="type-var">'a</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a>) <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"><p>Monadic composition. <code class="code">e >>= f</code> proceeds as <code class="code">f x</code> if <code class="code">e</code> is <code class="code">Ok x</code>
|
||||
or returns <code class="code">e</code> if <code class="code">e</code> is an <code class="code">Error</code>.</p></div></div><div class="spec val" id="val-(<*>)"><a href="#val-(<*>)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(<*>) : (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'b</span>, <span class="type-var">'err</span>) <a href="../index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">a <*> b</code> evaluates <code class="code">a</code> and <code class="code">b</code>, and, in case of success, returns
|
||||
<code class="code">Ok (a b)</code>. Otherwise, it fails, and the error of <code class="code">a</code> is chosen
|
||||
over the error of <code class="code">b</code> if both fail.</p></div></div></body></html>
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-M (containers.CCResult.Traverse.1-M)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCResult.Traverse.1-M</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-M (containers.CCResult.Traverse.1-M)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../../index.html">containers</a></span></nav><header><h1><span class="keyword">Parameter</span> <span class="module-path">CCResult.Traverse.1-M</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,2 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONAD (containers.CCResult.MONAD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCResult.MONAD</span></h1></header><div class="doc"><h3>Monadic Operations</h3></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div></body></html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONAD (containers.CCResult.MONAD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCResult.MONAD</span></h1></header><div class="doc"><h3>Monadic Operations</h3></div><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>'a t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-return"><a href="#val-return" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>return : <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">return</code>.</p></div></div><div class="spec val" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>(>>=) : <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> (<span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a>) <span class="keyword">‑></span> <span class="type-var">'b</span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Monadic <code class="code">bind</code>.</p></div></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sub (containers.CCString.Sub)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCString.Sub</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>string<span class="keyword"> * </span>int<span class="keyword"> * </span>int</code><code></code></div><div class="doc"><p>A string, an offset, and the length of the slice.</p></div></div><div class="spec val" id="val-make"><a href="#val-make" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>make : string <span class="keyword">‑></span> int <span class="keyword">‑></span> len:int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-full"><a href="#val-full" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>full : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Full string.</p></div></div><div class="spec val" id="val-copy"><a href="#val-copy" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>copy : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><p>Make a copy of the substring.</p></div></div><div class="spec val" id="val-underlying"><a href="#val-underlying" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>underlying : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-sub"><a href="#val-sub" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sub : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Sub-slice.</p></div></div><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> char</code></div><div class="doc"><p><code class="code">get s i</code> gets the <code class="code">i</code>-th element, or fails.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if the index is not within <code class="code">0 ... length - 1</code>.</li><li><span class="at-tag since">Since</span>: 1.2</li></ul></div></div><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><a href="../index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">type </span><a href="../module-type-S/index.html#type-t">t</a> := <a href="index.html#type-t">t</a></code></span></summary><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-length"><a href="#val-length" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>length : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"></div></div><div class="spec val" id="val-blit"><a href="#val-blit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>blit : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> Bytes.t <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Similar to <span class="xref-unresolved" title="unresolved reference to "String.blit"">String.blit</span>.
|
||||
Compatible with the <code class="code">-safe-string</code> option.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if indices are not valid.</li></ul></div></div><div class="spec val" id="val-fold"><a href="#val-fold" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold : (<span class="type-var">'a</span> <span class="keyword">‑></span> char <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold on chars by increasing index.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.7</li></ul></div></div><h3>Conversions</h3><div class="spec val" id="val-to_gen"><a href="#val-to_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_gen : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-gen">gen</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_klist"><a href="#val-to_klist" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_klist : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-klist">klist</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char list</code></div><div class="doc"></div></div><div class="spec val" id="val-pp_buf"><a href="#val-pp_buf" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_buf : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Renamed from <code class="code">pp</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Print the string within quotes.
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Sub (containers.CCString.Sub)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">CCString.Sub</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code><span class="keyword"> = </span>string<span class="keyword"> * </span>int<span class="keyword"> * </span>int</code><code></code></div><div class="doc"><p>A string, an offset, and the length of the slice.</p></div></div><div class="spec val" id="val-make"><a href="#val-make" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>make : string <span class="keyword">‑></span> int <span class="keyword">‑></span> len:int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-full"><a href="#val-full" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>full : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Full string.</p></div></div><div class="spec val" id="val-copy"><a href="#val-copy" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>copy : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><p>Make a copy of the substring.</p></div></div><div class="spec val" id="val-underlying"><a href="#val-underlying" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>underlying : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"></div></div><div class="spec val" id="val-sub"><a href="#val-sub" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>sub : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Sub-slice.</p></div></div><div class="spec val" id="val-get"><a href="#val-get" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> char</code></div><div class="doc"><p><code class="code">get s i</code> gets the <code class="code">i</code>-th element, or fails.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if the index is not within <code class="code">0 ... length - 1</code>.</li><li><span class="at-tag since">Since</span>: 1.2</li></ul></div></div><div class="spec include"><div class="doc"></div><details open="open"><summary><span class="def"><code><span class="keyword">include </span><a href="../index.html#module-type-S">S</a><span class="keyword"> with </span><span class="keyword">type </span><a href="../module-type-S/index.html#type-t">t</a> := <a href="index.html#type-t">t</a></code></span></summary><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-length"><a href="#val-length" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>length : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Return the length (number of characters) of the given string.</p></div></div><div class="spec val" id="val-blit"><a href="#val-blit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>blit : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> Bytes.t <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Similar to <span class="xref-unresolved" title="unresolved reference to "String.blit"">String.blit</span>.
|
||||
Compatible with the <code class="code">-safe-string</code> option.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if indices are not valid.</li></ul></div></div><div class="spec val" id="val-fold"><a href="#val-fold" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold : (<span class="type-var">'a</span> <span class="keyword">‑></span> char <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold on chars by increasing index.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.7</li></ul></div></div><h3>Conversions</h3><div class="spec val" id="val-to_gen"><a href="#val-to_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_gen : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p>Return the <code class="code">gen</code> of characters contained in the string</p></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Return the <code class="code">sequence</code> of characters contained in the string</p></div></div><div class="spec val" id="val-to_klist"><a href="#val-to_klist" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_klist : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-klist">klist</a></code></div><div class="doc"><p>Return the <code class="code">klist</code> of characters contained in the string</p></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char list</code></div><div class="doc"><p>Return the list of characters contained in the string.</p></div></div><div class="spec val" id="val-pp_buf"><a href="#val-pp_buf" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_buf : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Renamed from <code class="code">pp</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Print the string within quotes.
|
||||
Renamed from <code class="code">print</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div></details></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,4 +1,4 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (containers.CCString.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCString.S</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-length"><a href="#val-length" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>length : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"></div></div><div class="spec val" id="val-blit"><a href="#val-blit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>blit : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> Bytes.t <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Similar to <span class="xref-unresolved" title="unresolved reference to "String.blit"">String.blit</span>.
|
||||
Compatible with the <code class="code">-safe-string</code> option.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if indices are not valid.</li></ul></div></div><div class="spec val" id="val-fold"><a href="#val-fold" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold : (<span class="type-var">'a</span> <span class="keyword">‑></span> char <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold on chars by increasing index.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.7</li></ul></div></div><h3>Conversions</h3><div class="spec val" id="val-to_gen"><a href="#val-to_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_gen : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-gen">gen</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_klist"><a href="#val-to_klist" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_klist : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-klist">klist</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char list</code></div><div class="doc"></div></div><div class="spec val" id="val-pp_buf"><a href="#val-pp_buf" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_buf : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Renamed from <code class="code">pp</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Print the string within quotes.
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (containers.CCString.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">containers</a></span></nav><header><h1><span class="keyword">Module type</span> <span class="module-path">CCString.S</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-length"><a href="#val-length" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>length : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int</code></div><div class="doc"><p>Return the length (number of characters) of the given string.</p></div></div><div class="spec val" id="val-blit"><a href="#val-blit" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>blit : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> Bytes.t <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Similar to <span class="xref-unresolved" title="unresolved reference to "String.blit"">String.blit</span>.
|
||||
Compatible with the <code class="code">-safe-string</code> option.</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Invalid_argument</span>: if indices are not valid.</li></ul></div></div><div class="spec val" id="val-fold"><a href="#val-fold" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>fold : (<span class="type-var">'a</span> <span class="keyword">‑></span> char <span class="keyword">‑></span> <span class="type-var">'a</span>) <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span></code></div><div class="doc"><p>Fold on chars by increasing index.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 0.7</li></ul></div></div><h3>Conversions</h3><div class="spec val" id="val-to_gen"><a href="#val-to_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_gen : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-gen">gen</a></code></div><div class="doc"><p>Return the <code class="code">gen</code> of characters contained in the string</p></div></div><div class="spec val" id="val-to_seq"><a href="#val-to_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-sequence">sequence</a></code></div><div class="doc"><p>Return the <code class="code">sequence</code> of characters contained in the string</p></div></div><div class="spec val" id="val-to_klist"><a href="#val-to_klist" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_klist : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char <a href="../index.html#type-klist">klist</a></code></div><div class="doc"><p>Return the <code class="code">klist</code> of characters contained in the string</p></div></div><div class="spec val" id="val-to_list"><a href="#val-to_list" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_list : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> char list</code></div><div class="doc"><p>Return the list of characters contained in the string.</p></div></div><div class="spec val" id="val-pp_buf"><a href="#val-pp_buf" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp_buf : Buffer.t <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Renamed from <code class="code">pp</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Print the string within quotes.
|
||||
Renamed from <code class="code">print</code>.</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></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
|
|
@ -10,14 +10,14 @@
|
|||
<div class="by-name">
|
||||
<h2>OCaml package documentation</h2>
|
||||
<ol>
|
||||
<li><a href="containers/index.html">containers</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.data/index.html">containers.data</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.iter/index.html">containers.iter</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.monomorphic/index.html">containers.monomorphic</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.sexp/index.html">containers.sexp</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.thread/index.html">containers.thread</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.top/index.html">containers.top</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers.unix/index.html">containers.unix</a> <span class="version">2.0+alpha1</span></li>
|
||||
<li><a href="containers/index.html">containers</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.data/index.html">containers.data</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.iter/index.html">containers.iter</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.monomorphic/index.html">containers.monomorphic</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.sexp/index.html">containers.sexp</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.thread/index.html">containers.thread</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.top/index.html">containers.top</a> <span class="version">2.0</span></li>
|
||||
<li><a href="containers.unix/index.html">containers.unix</a> <span class="version">2.0</span></li>
|
||||
</ol>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue