mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2025-12-05 19:00:31 -05:00
update doc for 2.0
This commit is contained in:
Simon Cruanes
parent
c358f4e1c0
commit
9259c841f5
21 changed files with 34 additions and 23 deletions
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_data-generated (containers.data.containers_data-generated)</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.data</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.data</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.data.index)</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.data</a></span></nav><header></header><h2>Library containers.data</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-CCBV" class="anchored"><td class="module"><a href="#listing-module-CCBV" class="anchor"></a><a href="CCBV/index.html">CCBV</a></td><td class="doc"></td></tr><tr id="listing-module-CCBitField" class="anchored"><td class="module"><a href="#listing-module-CCBitField" class="anchor"></a><a href="CCBitField/index.html">CCBitField</a></td><td class="doc"></td></tr><tr id="listing-module-CCCache" class="anchored"><td class="module"><a href="#listing-module-CCCache" class="anchor"></a><a href="CCCache/index.html">CCCache</a></td><td class="doc"></td></tr><tr id="listing-module-CCDeque" class="anchored"><td class="module"><a href="#listing-module-CCDeque" class="anchor"></a><a href="CCDeque/index.html">CCDeque</a></td><td class="doc"></td></tr><tr id="listing-module-CCFQueue" class="anchored"><td class="module"><a href="#listing-module-CCFQueue" class="anchor"></a><a href="CCFQueue/index.html">CCFQueue</a></td><td class="doc"></td></tr><tr id="listing-module-CCGraph" class="anchored"><td class="module"><a href="#listing-module-CCGraph" class="anchor"></a><a href="CCGraph/index.html">CCGraph</a></td><td class="doc"></td></tr><tr id="listing-module-CCHashSet" class="anchored"><td class="module"><a href="#listing-module-CCHashSet" class="anchor"></a><a href="CCHashSet/index.html">CCHashSet</a></td><td class="doc"></td></tr><tr id="listing-module-CCHashTrie" class="anchored"><td class="module"><a href="#listing-module-CCHashTrie" class="anchor"></a><a href="CCHashTrie/index.html">CCHashTrie</a></td><td class="doc"></td></tr><tr id="listing-module-CCHet" class="anchored"><td class="module"><a href="#listing-module-CCHet" class="anchor"></a><a href="CCHet/index.html">CCHet</a></td><td class="doc"></td></tr><tr id="listing-module-CCImmutArray" class="anchored"><td class="module"><a href="#listing-module-CCImmutArray" class="anchor"></a><a href="CCImmutArray/index.html">CCImmutArray</a></td><td class="doc"></td></tr><tr id="listing-module-CCIntMap" class="anchored"><td class="module"><a href="#listing-module-CCIntMap" class="anchor"></a><a href="CCIntMap/index.html">CCIntMap</a></td><td class="doc"></td></tr><tr id="listing-module-CCMixmap" class="anchored"><td class="module"><a href="#listing-module-CCMixmap" class="anchor"></a><a href="CCMixmap/index.html">CCMixmap</a></td><td class="doc"></td></tr><tr id="listing-module-CCMixset" class="anchored"><td class="module"><a href="#listing-module-CCMixset" class="anchor"></a><a href="CCMixset/index.html">CCMixset</a></td><td class="doc"></td></tr><tr id="listing-module-CCMixtbl" class="anchored"><td class="module"><a href="#listing-module-CCMixtbl" class="anchor"></a><a href="CCMixtbl/index.html">CCMixtbl</a></td><td class="doc"></td></tr><tr id="listing-module-CCMultiMap" class="anchored"><td class="module"><a href="#listing-module-CCMultiMap" class="anchor"></a><a href="CCMultiMap/index.html">CCMultiMap</a></td><td class="doc"></td></tr><tr id="listing-module-CCMultiSet" class="anchored"><td class="module"><a href="#listing-module-CCMultiSet" class="anchor"></a><a href="CCMultiSet/index.html">CCMultiSet</a></td><td class="doc"></td></tr><tr id="listing-module-CCPersistentArray" class="anchored"><td class="module"><a href="#listing-module-CCPersistentArray" class="anchor"></a><a href="CCPersistentArray/index.html">CCPersistentArray</a></td><td class="doc"></td></tr><tr id="listing-module-CCPersistentHashtbl" class="anchored"><td class="module"><a href="#listing-module-CCPersistentHashtbl" class="anchor"></a><a href="CCPersistentHashtbl/index.html">CCPersistentHashtbl</a></td><td class="doc"></td></tr><tr id="listing-module-CCRAL" class="anchored"><td class="module"><a href="#listing-module-CCRAL" class="anchor"></a><a href="CCRAL/index.html">CCRAL</a></td><td class="doc"></td></tr><tr id="listing-module-CCRingBuffer" class="anchored"><td class="module"><a href="#listing-module-CCRingBuffer" class="anchor"></a><a href="CCRingBuffer/index.html">CCRingBuffer</a></td><td class="doc"></td></tr><tr id="listing-module-CCSimple_queue" class="anchored"><td class="module"><a href="#listing-module-CCSimple_queue" class="anchor"></a><a href="CCSimple_queue/index.html">CCSimple_queue</a></td><td class="doc"></td></tr><tr id="listing-module-CCTrie" class="anchored"><td class="module"><a href="#listing-module-CCTrie" class="anchor"></a><a href="CCTrie/index.html">CCTrie</a></td><td class="doc"></td></tr><tr id="listing-module-CCWBTree" class="anchored"><td class="module"><a href="#listing-module-CCWBTree" class="anchor"></a><a href="CCWBTree/index.html">CCWBTree</a></td><td class="doc"></td></tr><tr id="listing-module-CCZipper" class="anchored"><td class="module"><a href="#listing-module-CCZipper" class="anchor"></a><a href="CCZipper/index.html">CCZipper</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_iter-generated (containers.iter.containers_iter-generated)</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.iter</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.iter</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.iter.index)</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.iter</a></span></nav><header></header><h2>Library containers.iter</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-CCKList" class="anchored"><td class="module"><a href="#listing-module-CCKList" class="anchor"></a><a href="CCKList/index.html">CCKList</a></td><td class="doc"></td></tr><tr id="listing-module-CCKTree" class="anchored"><td class="module"><a href="#listing-module-CCKTree" class="anchor"></a><a href="CCKTree/index.html">CCKTree</a></td><td class="doc"></td></tr><tr id="listing-module-CCLazy_list" class="anchored"><td class="module"><a href="#listing-module-CCLazy_list" class="anchor"></a><a href="CCLazy_list/index.html">CCLazy_list</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_monomorphic-generated (containers.monomorphic.containers_monomorphic-generated)</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.monomorphic</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.monomorphic</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.monomorphic.index)</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.monomorphic</a></span></nav><header></header><h2>Library containers.monomorphic</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-CCMonomorphic" class="anchored"><td class="module"><a href="#listing-module-CCMonomorphic" class="anchor"></a><a href="CCMonomorphic/index.html">CCMonomorphic</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_sexp-generated (containers.sexp.containers_sexp-generated)</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.sexp</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.sexp</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.sexp.index)</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.sexp</a></span></nav><header></header><h2>Library containers.sexp</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-CCSexp" class="anchored"><td class="module"><a href="#listing-module-CCSexp" class="anchor"></a><a href="CCSexp/index.html">CCSexp</a></td><td class="doc"></td></tr><tr id="listing-module-CCSexp_lex" class="anchored"><td class="module"><a href="#listing-module-CCSexp_lex" class="anchor"></a><a href="CCSexp_lex/index.html">CCSexp_lex</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_thread-generated (containers.thread.containers_thread-generated)</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.thread</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.thread</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.thread.index)</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.thread</a></span></nav><header></header><h2>Library containers.thread</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-CCBlockingQueue" class="anchored"><td class="module"><a href="#listing-module-CCBlockingQueue" class="anchor"></a><a href="CCBlockingQueue/index.html">CCBlockingQueue</a></td><td class="doc"></td></tr><tr id="listing-module-CCLock" class="anchored"><td class="module"><a href="#listing-module-CCLock" class="anchor"></a><a href="CCLock/index.html">CCLock</a></td><td class="doc"></td></tr><tr id="listing-module-CCPool" class="anchored"><td class="module"><a href="#listing-module-CCPool" class="anchor"></a><a href="CCPool/index.html">CCPool</a></td><td class="doc"></td></tr><tr id="listing-module-CCSemaphore" class="anchored"><td class="module"><a href="#listing-module-CCSemaphore" class="anchor"></a><a href="CCSemaphore/index.html">CCSemaphore</a></td><td class="doc"></td></tr><tr id="listing-module-CCThread" class="anchored"><td class="module"><a href="#listing-module-CCThread" class="anchor"></a><a href="CCThread/index.html">CCThread</a></td><td class="doc"></td></tr><tr id="listing-module-CCTimer" class="anchored"><td class="module"><a href="#listing-module-CCTimer" class="anchor"></a><a href="CCTimer/index.html">CCTimer</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_top-generated (containers.top.containers_top-generated)</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.top</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.top</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.top.index)</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.top</a></span></nav><header></header><h2>Library containers.top</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-Containers_top" class="anchored"><td class="module"><a href="#listing-module-Containers_top" class="anchor"></a><a href="Containers_top/index.html">Containers_top</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
|
|
@ -1,3 +1,3 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>containers_unix-generated (containers.unix.containers_unix-generated)</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.unix</a></span></nav><header></header><nav><a href="../index.html">Up</a></nav><h2>Library containers.unix</h2><p>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (containers.unix.index)</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.unix</a></span></nav><header></header><h2>Library containers.unix</h2><p>
|
||||
This library exposes the following toplevel modules: </p><table class="modules"><tr id="listing-module-CCUnix" class="anchored"><td class="module"><a href="#listing-module-CCUnix" class="anchor"></a><a href="CCUnix/index.html">CCUnix</a></td><td class="doc"></td></tr></table><p>.</p></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -11,7 +11,8 @@ and returns a printer actionable by <code class="code">()</code>.
|
|||
Examples:
|
||||
</p><ul><li><code class="code">return ",@ "</code></li><li><code class="code">return "@{<Red>and then@}@,"</code></li><li><code class="code">return "@[<v>a@ b@]"</code></li></ul><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-of_to_string"><a href="#val-of_to_string" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_to_string : (<span class="type-var">'a</span> <span class="keyword">‑></span> string) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a></code></div><div class="doc"><p><code class="code">of_to_string f</code> converts its input to a string using <code class="code">f</code>,
|
||||
then prints the string.</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-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> <a href="index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit <a href="index.html#type-printer">printer</a></code></div><div class="doc"><p><code class="code">const pp x</code> is a unit printer that uses <code class="code">pp</code> on <code class="code">x</code>.</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-some"><a href="#val-some" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>some : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'a</span> option <a href="index.html#type-printer">printer</a></code></div><div class="doc"><p><code class="code">some pp</code> will print options as follows:
|
||||
</p><ul><li><code class="code">Some x</code> is printed using <code class="code">pp</code> on <code class="code">x</code>.</li><li><code class="code">None</code> is not printed at all.</li></ul><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><h3>ANSI codes</h3><p>Use ANSI escape codes https://en.wikipedia.org/wiki/ANSI_escape_code
|
||||
</p><ul><li><code class="code">Some x</code> is printed using <code class="code">pp</code> on <code class="code">x</code>.</li><li><code class="code">None</code> is not printed at all.</li></ul><ul class="at-tag"><li><span class="at-tag since">Since</span>: 1.0</li></ul></div></div><div class="spec val" id="val-lazy_force"><a href="#val-lazy_force" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lazy_force : <span class="type-var">'a</span> <a href="index.html#type-printer">printer</a> <span class="keyword">‑></span> <span class="type-var">'a</span> lazy_t <a href="index.html#type-printer">printer</a></code></div><div class="doc"><p><code class="code">lazy_force pp out x</code> forces <code class="code">x</code> and prints the result with <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-lazy_or"><a href="#val-lazy_or" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>lazy_or : ?⁠default:unit <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> lazy_t <a href="index.html#type-printer">printer</a></code></div><div class="doc"><p><code class="code">lazy_or ?default pp out x</code> prints <code class="code">default</code> if <code class="code">x</code> is not
|
||||
evaluated yet, or uses <code class="code">pp</code> otherwise</p><ul class="at-tag"><li><span class="at-tag since">Since</span>: 2.0</li></ul></div></div><h3>ANSI codes</h3><p>Use ANSI escape codes https://en.wikipedia.org/wiki/ANSI_escape_code
|
||||
to put some colors on the terminal.</p><p>This uses <b>tags</b> in format strings to specify the style. Current styles
|
||||
are the following:</p><ul><li>"reset" resets style</li><li>"black"</li><li>"red"</li><li>"green"</li><li>"yellow"</li><li>"blue"</li><li>"magenta"</li><li>"cyan"</li><li>"white"</li><li>"bold" bold font</li><li>"Black" bold black</li><li>"Red" bold red</li><li>"Green" bold green</li><li>"Yellow" bold yellow</li><li>"Blue" bold blue</li><li>"Magenta" bold magenta</li><li>"Cyan" bold cyan</li><li>"White" bold white</li></ul><p>Example:</p><pre><code class="code"> set_color_default true;;
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<!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>.
|
||||
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>.
|
||||
If the key is in the Hashtable multiple times, all occurrences will be returned.</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>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.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<!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>.
|
||||
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>.
|
||||
If the key is in the Hashtable multiple times, all occurrences will be returned.</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>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.
|
||||
|
|
|
|||
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
File diff suppressed because one or more lines are too long
|
|
@ -34,7 +34,7 @@ according to <code class="code">eq</code>.</p><ul class="at-tag"><li><span class
|
|||
the element as first argument (counting from 0), and the element
|
||||
itself as second argument.</p></div></div><div class="spec val" id="val-iteri"><a href="#val-iteri" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>iteri : f:(int <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> unit) <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"><p>Like <a href="index.html#val-iter">iter</a>, but the function is applied to the index of
|
||||
the element as first argument (counting from 0), and the element
|
||||
itself as second argument.</p></div></div><div class="spec val" id="val-foldi"><a href="#val-foldi" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>foldi : f:(<span class="type-var">'b</span> <span class="keyword">‑></span> int <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <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></code></div><div class="doc"><p>Like <code class="code">fold</code> but it also passes in the index of each element to the folded function.</p></div></div><div class="spec val" id="val-get_at_idx"><a href="#val-get_at_idx" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_at_idx : 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> option</code></div><div class="doc"><p>Get by index in the list.
|
||||
itself as second argument.</p></div></div><div class="spec val" id="val-foldi"><a href="#val-foldi" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>foldi : f:(<span class="type-var">'b</span> <span class="keyword">‑></span> int <span class="keyword">‑></span> <span class="type-var">'a</span> <span class="keyword">‑></span> <span class="type-var">'b</span>) <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></code></div><div class="doc"><p>Like <code class="code">fold</code> but it also passes in the index of each element to the folded function. Tail-recursive.</p></div></div><div class="spec val" id="val-get_at_idx"><a href="#val-get_at_idx" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_at_idx : 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> option</code></div><div class="doc"><p>Get by index in the list.
|
||||
If the index is negative, it will get element starting from the end
|
||||
of the list.</p></div></div><div class="spec val" id="val-get_at_idx_exn"><a href="#val-get_at_idx_exn" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_at_idx_exn : 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></code></div><div class="doc"><p>Get the i-th element, or</p><ul class="at-tag"><li><span class="at-tag raise">Raises</span> <span class="module-path">Not_found</span>: if the index is invalid.
|
||||
If the index is negative, it will get element starting from the end
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ of the elements (might swap with the last element).</p></div></div><div class="s
|
|||
index than <code class="code">size v</code> are undefined (do not access!).</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, <span class="type-var">'mut</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Range of integers, either ascending or descending (both included,
|
||||
therefore the result is never empty).
|
||||
Example: <code class="code">1 -- 10</code> returns the vector <code class="code">[1;2;3;4;5;6;7;8;9;10]</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, <span class="type-var">'mut</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Range of integers, either ascending or descending, but excluding right.
|
||||
Example: <code class="code">1 --^ 10</code> returns the vector <code class="code">[1;2;3;4;5;6;7;8;9]</code>.</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-of_array"><a href="#val-of_array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_array : <span class="type-var">'a</span> array <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'mut</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">of_array a</code> returns a vector corresponding to the array <code class="code">a</code>.</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> list <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'mut</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_array"><a href="#val-to_array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_array : (<span class="type-var">'a</span>, <span class="type-var">_</span>) <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array</code></div><div class="doc"><p><code class="code">to_array v</code> returns an array corresponding to the vector <code class="code">v</code>.</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 : (<span class="type-var">'a</span>, <span class="type-var">_</span>) <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list</code></div><div class="doc"><p>Return a list with the elements contained in the vector.</p></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 : ?⁠init:(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <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> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <a href="index.html#type-t">t</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 : (<span class="type-var">'a</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-sequence">sequence</a></code></div><div class="doc"><p>Return a <code class="code">sequence</code> with the elements contained in the vector.</p></div></div><div class="spec val" id="val-to_seq_rev"><a href="#val-to_seq_rev" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq_rev : (<span class="type-var">'a</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-sequence">sequence</a></code></div><div class="doc"><p><code class="code">to_seq_rev v</code> returns the sequence of elements of <code class="code">v</code> in reverse order,
|
||||
Example: <code class="code">1 --^ 10</code> returns the vector <code class="code">[1;2;3;4;5;6;7;8;9]</code>.</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-of_array"><a href="#val-of_array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_array : <span class="type-var">'a</span> array <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'mut</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">of_array a</code> returns a vector corresponding to the array <code class="code">a</code>. Operates in <code class="code">O(n)</code> time.</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> list <span class="keyword">‑></span> (<span class="type-var">'a</span>, <span class="type-var">'mut</span>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-to_array"><a href="#val-to_array" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_array : (<span class="type-var">'a</span>, <span class="type-var">_</span>) <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array</code></div><div class="doc"><p><code class="code">to_array v</code> returns an array corresponding to the vector <code class="code">v</code>.</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 : (<span class="type-var">'a</span>, <span class="type-var">_</span>) <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> list</code></div><div class="doc"><p>Return a list with the elements contained in the vector.</p></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 : ?⁠init:(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <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> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <a href="index.html#type-t">t</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 : (<span class="type-var">'a</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-sequence">sequence</a></code></div><div class="doc"><p>Return a <code class="code">sequence</code> with the elements contained in the vector.</p></div></div><div class="spec val" id="val-to_seq_rev"><a href="#val-to_seq_rev" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>to_seq_rev : (<span class="type-var">'a</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-sequence">sequence</a></code></div><div class="doc"><p><code class="code">to_seq_rev v</code> returns the sequence of elements of <code class="code">v</code> in reverse order,
|
||||
that is, the last elements of <code class="code">v</code> are iterated on first.</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-slice"><a href="#val-slice" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>slice : (<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <span class="type-var">'a</span> array<span class="keyword"> * </span>int<span class="keyword"> * </span>int</code></div><div class="doc"><p>Vector as an array slice. By doing it we expose the internal array, so
|
||||
be careful!.</p></div></div><div class="spec val" id="val-slice_seq"><a href="#val-slice_seq" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>slice_seq : (<span class="type-var">'a</span>, <span class="type-var">_</span>) <a href="index.html#type-t">t</a> <span class="keyword">‑></span> int <span class="keyword">‑></span> int <span class="keyword">‑></span> <span class="type-var">'a</span> <a href="index.html#type-sequence">sequence</a></code></div><div class="doc"><p><code class="code">slice_seq v start len</code> is the sequence of elements from <code class="code">v.(start)</code>
|
||||
to <code class="code">v.(start+len-1)</code>.</p></div></div><div class="spec val" id="val-of_klist"><a href="#val-of_klist" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_klist : ?⁠init:(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <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> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <a href="index.html#type-t">t</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 : (<span class="type-var">'a</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-klist">klist</a></code></div><div class="doc"></div></div><div class="spec val" id="val-of_gen"><a href="#val-of_gen" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>of_gen : ?⁠init:(<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <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> <span class="keyword">‑></span> (<span class="type-var">'a</span>, <a href="index.html#type-rw">rw</a>) <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><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 : (<span class="type-var">'a</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-gen">gen</a></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> ?⁠sep:string <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>, <span class="type-var">_</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>
|
||||
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
File diff suppressed because one or more lines are too long
Loading…
Add table
Reference in a new issue