mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-01-23 09:36:41 -05:00
add docs for 2.8.1
This commit is contained in:
parent
d7de9998a8
commit
f1e59f4321
359 changed files with 1493 additions and 1 deletions
0
2.8.1/containers/CCArray/.dune-keep
Normal file
0
2.8.1/containers/CCArray/.dune-keep
Normal file
2
2.8.1/containers/CCArray/Infix/index.html
Normal file
2
2.8.1/containers/CCArray/Infix/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCArray.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCArray</a> » Infix</nav><h1>Module <code>CCArray.Infix</code></h1></header><dl><dt class="spec value" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span class="keyword">val</span> (>>=) : <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>a >>= f</code> is the infix version of <a href="../index.html#val-flat_map"><code>flat_map</code></a>.</p></dd></dl><dl><dt class="spec value" id="val-(>>|)"><a href="#val-(>>|)" class="anchor"></a><code><span class="keyword">val</span> (>>|) : <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>a >>| f</code> is the infix version of <a href="../index.html#val-map"><code>map</code></a>.</p><dl><dt>since</dt><dd>0.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span class="keyword">val</span> (>|=) : <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>a >|= f</code> is the infix version of <a href="../index.html#val-map"><code>map</code></a>.</p><dl><dt>since</dt><dd>0.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-(--)"><a href="#val-(--)" class="anchor"></a><code><span class="keyword">val</span> (--) : int <span>-></span> int <span>-></span> <span>int <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>x -- y</code> creates an array containing integers in the range <code>x .. y</code>. Bounds included.</p></dd></dl><dl><dt class="spec value" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><code><span class="keyword">val</span> (--^) : int <span>-></span> int <span>-></span> <span>int <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>x --^ y</code> creates an array containing integers in the range <code>x .. y</code>. Right bound excluded.</p><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><div><div class="spec include"><div class="doc"><p>Let operators on OCaml >= 4.08.0, nothing otherwise</p><dl><dt>since</dt><dd>2.8</dd></dl><details open="open"><summary><span class="def"><code><span class="keyword">include</span> <a href="../../CCShimsMkLet_/index.html#module-type-S">CCShimsMkLet_.S</a> <span class="keyword">with</span> <span class="keyword">type</span> <span>'a <a href="../../CCShimsMkLet_/module-type-S/index.html#type-t_let">t_let</a></span> := <span><span class="type-var">'a</span> array</span></code></span></summary><dl><dt class="spec type" id="type-t_let"><a href="#type-t_let" class="anchor"></a><code><span class="keyword">type</span> <span>'a t_let</span></code></dt></dl></details></div></div></div></div></body></html>
|
||||
2
2.8.1/containers/CCArray/index.html
Normal file
2
2.8.1/containers/CCArray/index.html
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONO_ARRAY (containers.CCArray.MONO_ARRAY)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCArray</a> » MONO_ARRAY</nav><h1>Module type <code>CCArray.MONO_ARRAY</code></h1></header><dl><dt class="spec type" id="type-elt"><a href="#type-elt" class="anchor"></a><code><span class="keyword">type</span> elt</code></dt><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-length"><a href="#val-length" class="anchor"></a><code><span class="keyword">val</span> length : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : <a href="index.html#type-t">t</a> <span>-></span> int <span>-></span> <a href="index.html#type-elt">elt</a></code></dt><dt class="spec value" id="val-set"><a href="#val-set" class="anchor"></a><code><span class="keyword">val</span> set : <a href="index.html#type-t">t</a> <span>-></span> int <span>-></span> <a href="index.html#type-elt">elt</a> <span>-></span> unit</code></dt></dl></div></body></html>
|
||||
0
2.8.1/containers/CCArrayLabels/.dune-keep
Normal file
0
2.8.1/containers/CCArrayLabels/.dune-keep
Normal file
2
2.8.1/containers/CCArrayLabels/Floatarray/index.html
Normal file
2
2.8.1/containers/CCArrayLabels/Floatarray/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Floatarray (containers.CCArrayLabels.Floatarray)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCArrayLabels</a> » Floatarray</nav><h1>Module <code>CCArrayLabels.Floatarray</code></h1></header><dl><dt class="spec external" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : int <span>-></span> floatarray</code></dt><dt class="spec external" id="val-length"><a href="#val-length" class="anchor"></a><code><span class="keyword">val</span> length : floatarray <span>-></span> int</code></dt><dt class="spec external" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : floatarray <span>-></span> int <span>-></span> float</code></dt><dt class="spec external" id="val-set"><a href="#val-set" class="anchor"></a><code><span class="keyword">val</span> set : floatarray <span>-></span> int <span>-></span> float <span>-></span> unit</code></dt><dt class="spec external" id="val-unsafe_get"><a href="#val-unsafe_get" class="anchor"></a><code><span class="keyword">val</span> unsafe_get : floatarray <span>-></span> int <span>-></span> float</code></dt><dt class="spec external" id="val-unsafe_set"><a href="#val-unsafe_set" class="anchor"></a><code><span class="keyword">val</span> unsafe_set : floatarray <span>-></span> int <span>-></span> float <span>-></span> unit</code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCArrayLabels/Infix/index.html
Normal file
2
2.8.1/containers/CCArrayLabels/Infix/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCArrayLabels.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCArrayLabels</a> » Infix</nav><h1>Module <code>CCArrayLabels.Infix</code></h1></header><dl><dt class="spec value" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span class="keyword">val</span> (>>=) : <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>a >>= f</code> is the infix version of <a href="../index.html#val-flat_map"><code>flat_map</code></a>.</p></dd></dl><dl><dt class="spec value" id="val-(>>|)"><a href="#val-(>>|)" class="anchor"></a><code><span class="keyword">val</span> (>>|) : <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>a >>| f</code> is the infix version of <a href="../index.html#val-map"><code>map</code></a>.</p><dl><dt>since</dt><dd>0.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span class="keyword">val</span> (>|=) : <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>a >|= f</code> is the infix version of <a href="../index.html#val-map"><code>map</code></a>.</p><dl><dt>since</dt><dd>0.8</dd></dl></dd></dl><dl><dt class="spec value" id="val-(--)"><a href="#val-(--)" class="anchor"></a><code><span class="keyword">val</span> (--) : int <span>-></span> int <span>-></span> <span>int <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>x -- y</code> creates an array containing integers in the range <code>x .. y</code>. Bounds included.</p></dd></dl><dl><dt class="spec value" id="val-(--^)"><a href="#val-(--^)" class="anchor"></a><code><span class="keyword">val</span> (--^) : int <span>-></span> int <span>-></span> <span>int <a href="../index.html#type-t">t</a></span></code></dt><dd><p><code>x --^ y</code> creates an array containing integers in the range <code>x .. y</code>. Right bound excluded.</p><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><div><div class="spec include"><div class="doc"><p>Let operators on OCaml >= 4.08.0, nothing otherwise</p><dl><dt>since</dt><dd>2.8</dd></dl><details open="open"><summary><span class="def"><code><span class="keyword">include</span> <a href="../../CCShimsMkLet_/index.html#module-type-S">CCShimsMkLet_.S</a> <span class="keyword">with</span> <span class="keyword">type</span> <span>'a <a href="../../CCShimsMkLet_/module-type-S/index.html#type-t_let">t_let</a></span> := <span><span class="type-var">'a</span> array</span></code></span></summary><dl><dt class="spec type" id="type-t_let"><a href="#type-t_let" class="anchor"></a><code><span class="keyword">type</span> <span>'a t_let</span></code></dt></dl></details></div></div></div></div></body></html>
|
||||
2
2.8.1/containers/CCArrayLabels/index.html
Normal file
2
2.8.1/containers/CCArrayLabels/index.html
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>MONO_ARRAY (containers.CCArrayLabels.MONO_ARRAY)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCArrayLabels</a> » MONO_ARRAY</nav><h1>Module type <code>CCArrayLabels.MONO_ARRAY</code></h1></header><dl><dt class="spec type" id="type-elt"><a href="#type-elt" class="anchor"></a><code><span class="keyword">type</span> elt</code></dt><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-length"><a href="#val-length" class="anchor"></a><code><span class="keyword">val</span> length : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : <a href="index.html#type-t">t</a> <span>-></span> int <span>-></span> <a href="index.html#type-elt">elt</a></code></dt><dt class="spec value" id="val-set"><a href="#val-set" class="anchor"></a><code><span class="keyword">val</span> set : <a href="index.html#type-t">t</a> <span>-></span> int <span>-></span> <a href="index.html#type-elt">elt</a> <span>-></span> unit</code></dt></dl></div></body></html>
|
||||
0
2.8.1/containers/CCArray_slice/.dune-keep
Normal file
0
2.8.1/containers/CCArray_slice/.dune-keep
Normal file
2
2.8.1/containers/CCArray_slice/index.html
Normal file
2
2.8.1/containers/CCArray_slice/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCArray_sliceLabels/.dune-keep
Normal file
0
2.8.1/containers/CCArray_sliceLabels/.dune-keep
Normal file
2
2.8.1/containers/CCArray_sliceLabels/index.html
Normal file
2
2.8.1/containers/CCArray_sliceLabels/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCBV/.dune-keep
Normal file
0
2.8.1/containers/CCBV/.dune-keep
Normal file
2
2.8.1/containers/CCBV/index.html
Normal file
2
2.8.1/containers/CCBV/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCBijection/.dune-keep
Normal file
0
2.8.1/containers/CCBijection/.dune-keep
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-L (containers.CCBijection.Make.1-L)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCBijection</a> » <a href="../index.html">Make</a> » 1-L</nav><h1>Parameter <code>Make.1-L</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt></dl></div></body></html>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>2-R (containers.CCBijection.Make.2-R)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCBijection</a> » <a href="../index.html">Make</a> » 2-R</nav><h1>Parameter <code>Make.2-R</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCBijection/Make/index.html
Normal file
2
2.8.1/containers/CCBijection/Make/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCBijection/index.html
Normal file
2
2.8.1/containers/CCBijection/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCBijection (containers.CCBijection)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCBijection</nav><h1>Module <code>CCBijection</code></h1><h2 id="bijection"><a href="#bijection" class="anchor"></a>Bijection</h2><p>Represents 1-to-1 mappings between two types. Each element from the "left" is mapped to one "right" value, and conversely.</p><dl><dt>since</dt><dd>2.1</dd></dl></header><dl><dt class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><code><span class="keyword">type</span> <span>'a sequence</span></code><code> = <span>(<span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> unit</code></dt></dl><div class="spec module-type" id="module-type-OrderedType"><a href="#module-type-OrderedType" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-OrderedType/index.html">OrderedType</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> <a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-L/index.html">L</a> : <a href="index.html#module-type-OrderedType">OrderedType</a>) <span>-></span> <span class="keyword">functor</span> (<a href="Make/argument-2-R/index.html">R</a> : <a href="index.html#module-type-OrderedType">OrderedType</a>) <span>-></span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="Make/index.html#type-left">left</a> = <a href="Make/argument-1-L/index.html#type-t">L.t</a> <span class="keyword">and</span> <span class="keyword">type</span> <a href="Make/index.html#type-right">right</a> = <a href="Make/argument-2-R/index.html#type-t">R.t</a></code></div></div></body></html>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>OrderedType (containers.CCBijection.OrderedType)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCBijection</a> » OrderedType</nav><h1>Module type <code>CCBijection.OrderedType</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCBijection/module-type-S/index.html
Normal file
2
2.8.1/containers/CCBijection/module-type-S/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCBitField/.dune-keep
Normal file
0
2.8.1/containers/CCBitField/.dune-keep
Normal file
2
2.8.1/containers/CCBitField/Make/argument-1-X/index.html
Normal file
2
2.8.1/containers/CCBitField/Make/argument-1-X/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-X (containers.CCBitField.Make.1-X)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCBitField</a> » <a href="../index.html">Make</a> » 1-X</nav><h1>Parameter <code>Make.1-X</code></h1></header></div></body></html>
|
||||
2
2.8.1/containers/CCBitField/Make/index.html
Normal file
2
2.8.1/containers/CCBitField/Make/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers.CCBitField.Make)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCBitField</a> » Make</nav><h1>Module <code>CCBitField.Make</code></h1><p>Create a new bitfield type</p></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <span class="keyword">private</span> int</code></dt><dd><p>Generative type of bitfields. Each instantiation of the functor should create a new, incompatible type</p></dd></dl><dl><dt class="spec value" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span class="keyword">val</span> empty : <a href="index.html#type-t">t</a></code></dt><dd><p>Empty bitfields (all bits 0).</p></dd></dl><dl><dt class="spec type" id="type-field"><a href="#type-field" class="anchor"></a><code><span class="keyword">type</span> field</code></dt></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : <a href="index.html#type-field">field</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Get the value of this field.</p></dd></dl><dl><dt class="spec value" id="val-set"><a href="#val-set" class="anchor"></a><code><span class="keyword">val</span> set : <a href="index.html#type-field">field</a> <span>-></span> bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Set the value of this field.</p></dd></dl><dl><dt class="spec value" id="val-mk_field"><a href="#val-mk_field" class="anchor"></a><code><span class="keyword">val</span> mk_field : unit <span>-></span> <a href="index.html#type-field">field</a></code></dt><dd><p>Make a new field.</p></dd></dl><dl><dt class="spec value" id="val-freeze"><a href="#val-freeze" class="anchor"></a><code><span class="keyword">val</span> freeze : unit <span>-></span> unit</code></dt><dd><p>Prevent new fields from being added. From now on, creating a field will raise Frozen.</p></dd></dl><dl><dt class="spec value" id="val-total_width"><a href="#val-total_width" class="anchor"></a><code><span class="keyword">val</span> total_width : unit <span>-></span> int</code></dt><dd><p>Current width of the bitfield.</p></dd></dl></div></body></html>
|
||||
12
2.8.1/containers/CCBitField/index.html
Normal file
12
2.8.1/containers/CCBitField/index.html
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCBitField (containers.CCBitField)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCBitField</nav><h1>Module <code>CCBitField</code></h1><h2 id="bit-field"><a href="#bit-field" class="anchor"></a>Bit Field</h2><p>This module defines efficient bitfields up to 30 or 62 bits (depending on the architecture) in a relatively type-safe way.</p><pre><code class="ml">module B = CCBitField.Make(struct end);;
|
||||
|
||||
let x = B.mk_field ()
|
||||
let y = B.mk_field ()
|
||||
let z = B.mk_field ()
|
||||
|
||||
let f = B.empty |> B.set x true |> B.set y true;;
|
||||
|
||||
assert (not (B.get z f)) ;;
|
||||
|
||||
assert (f |> B.set z true |> B.get z);;</code></pre></header><dl><dt class="spec exception" id="exception-TooManyFields"><a href="#exception-TooManyFields" class="anchor"></a><code><span class="keyword">exception</span> </code><code><span class="exception">TooManyFields</span></code></dt><dd><p>Raised when too many fields are packed into one bitfield.</p></dd></dl><dl><dt class="spec exception" id="exception-Frozen"><a href="#exception-Frozen" class="anchor"></a><code><span class="keyword">exception</span> </code><code><span class="exception">Frozen</span></code></dt><dd><p>Raised when a frozen bitfield is modified.</p></dd></dl><dl><dt class="spec value" id="val-max_width"><a href="#val-max_width" class="anchor"></a><code><span class="keyword">val</span> max_width : int</code></dt><dd><p>System-dependent maximum width for a bitfield, typically 30 or 62.</p></dd></dl><dl><dt class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> <a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) <span>-></span> <a href="index.html#module-type-S">S</a></code></dt><dd><p>Create a new bitfield type</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCBitField/module-type-S/index.html
Normal file
2
2.8.1/containers/CCBitField/module-type-S/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>S (containers.CCBitField.S)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCBitField</a> » S</nav><h1>Module type <code>CCBitField.S</code></h1><h3 id="bitfield-signature"><a href="#bitfield-signature" class="anchor"></a>Bitfield Signature</h3></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = <span class="keyword">private</span> int</code></dt><dd><p>Generative type of bitfields. Each instantiation of the functor should create a new, incompatible type</p></dd></dl><dl><dt class="spec value" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span class="keyword">val</span> empty : <a href="index.html#type-t">t</a></code></dt><dd><p>Empty bitfields (all bits 0).</p></dd></dl><dl><dt class="spec type" id="type-field"><a href="#type-field" class="anchor"></a><code><span class="keyword">type</span> field</code></dt></dl><dl><dt class="spec value" id="val-get"><a href="#val-get" class="anchor"></a><code><span class="keyword">val</span> get : <a href="index.html#type-field">field</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Get the value of this field.</p></dd></dl><dl><dt class="spec value" id="val-set"><a href="#val-set" class="anchor"></a><code><span class="keyword">val</span> set : <a href="index.html#type-field">field</a> <span>-></span> bool <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Set the value of this field.</p></dd></dl><dl><dt class="spec value" id="val-mk_field"><a href="#val-mk_field" class="anchor"></a><code><span class="keyword">val</span> mk_field : unit <span>-></span> <a href="index.html#type-field">field</a></code></dt><dd><p>Make a new field.</p></dd></dl><dl><dt class="spec value" id="val-freeze"><a href="#val-freeze" class="anchor"></a><code><span class="keyword">val</span> freeze : unit <span>-></span> unit</code></dt><dd><p>Prevent new fields from being added. From now on, creating a field will raise Frozen.</p></dd></dl><dl><dt class="spec value" id="val-total_width"><a href="#val-total_width" class="anchor"></a><code><span class="keyword">val</span> total_width : unit <span>-></span> int</code></dt><dd><p>Current width of the bitfield.</p></dd></dl></div></body></html>
|
||||
0
2.8.1/containers/CCBlockingQueue/.dune-keep
Normal file
0
2.8.1/containers/CCBlockingQueue/.dune-keep
Normal file
2
2.8.1/containers/CCBlockingQueue/index.html
Normal file
2
2.8.1/containers/CCBlockingQueue/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCBool/.dune-keep
Normal file
0
2.8.1/containers/CCBool/.dune-keep
Normal file
2
2.8.1/containers/CCBool/index.html
Normal file
2
2.8.1/containers/CCBool/index.html
Normal file
|
|
@ -0,0 +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="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCBool</nav><h1>Module <code>CCBool</code></h1><h2 id="basic-bool-functions"><a href="#basic-bool-functions" class="anchor"></a>Basic Bool functions</h2></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code><code> = bool</code></dt></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Total ordering on booleans, similar to <span class="xref-unresolved" title="unresolved reference to "Pervasives.compare""><code>Pervasives</code>.compare</span>.</p></dd></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-to_int"><a href="#val-to_int" class="anchor"></a><code><span class="keyword">val</span> to_int : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p><code>to_int true = 1</code>, <code>to_int false = 0</code>.</p><dl><dt>since</dt><dd>2.7</dd></dl></dd></dl><dl><dt class="spec value" id="val-of_int"><a href="#val-of_int" class="anchor"></a><code><span class="keyword">val</span> of_int : int <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>of_int i</code> is the same as <code>i <> 0</code></p><dl><dt>since</dt><dd>2.7</dd></dl></dd></dl><dl><dt class="spec value" id="val-negate"><a href="#val-negate" class="anchor"></a><code><span class="keyword">val</span> negate : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a></code></dt></dl><dl><dt class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span class="keyword">type</span> <span>'a printer</span></code><code> = Format.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt></dl><dl><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : <span><a href="index.html#type-t">t</a> <a href="index.html#type-printer">printer</a></span></code></dt></dl></div></body></html>
|
||||
0
2.8.1/containers/CCCache/.dune-keep
Normal file
0
2.8.1/containers/CCCache/.dune-keep
Normal file
15
2.8.1/containers/CCCache/index.html
Normal file
15
2.8.1/containers/CCCache/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCChar/.dune-keep
Normal file
0
2.8.1/containers/CCChar/.dune-keep
Normal file
2
2.8.1/containers/CCChar/index.html
Normal file
2
2.8.1/containers/CCChar/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCDeque/.dune-keep
Normal file
0
2.8.1/containers/CCDeque/.dune-keep
Normal file
2
2.8.1/containers/CCDeque/index.html
Normal file
2
2.8.1/containers/CCDeque/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCEqual/.dune-keep
Normal file
0
2.8.1/containers/CCEqual/.dune-keep
Normal file
2
2.8.1/containers/CCEqual/Infix/index.html
Normal file
2
2.8.1/containers/CCEqual/Infix/index.html
Normal file
|
|
@ -0,0 +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="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCEqual</a> » Infix</nav><h1>Module <code>CCEqual.Infix</code></h1></header><dl><dt class="spec value" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span class="keyword">val</span> (>|=) : <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p>Infix equivalent of <a href="../index.html#val-map"><code>map</code></a>.</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCEqual/index.html
Normal file
2
2.8.1/containers/CCEqual/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCEqualLabels/.dune-keep
Normal file
0
2.8.1/containers/CCEqualLabels/.dune-keep
Normal file
2
2.8.1/containers/CCEqualLabels/Infix/index.html
Normal file
2
2.8.1/containers/CCEqualLabels/Infix/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Infix (containers.CCEqualLabels.Infix)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCEqualLabels</a> » Infix</nav><h1>Module <code>CCEqualLabels.Infix</code></h1></header><dl><dt class="spec value" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span class="keyword">val</span> (>|=) : <span><span class="type-var">'b</span> <a href="../index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'a</span> <a href="../index.html#type-t">t</a></span></code></dt><dd><p>Infix equivalent of <a href="../index.html#val-map"><code>map</code></a>.</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCEqualLabels/index.html
Normal file
2
2.8.1/containers/CCEqualLabels/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCFQueue/.dune-keep
Normal file
0
2.8.1/containers/CCFQueue/.dune-keep
Normal file
2
2.8.1/containers/CCFQueue/index.html
Normal file
2
2.8.1/containers/CCFQueue/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCFloat/.dune-keep
Normal file
0
2.8.1/containers/CCFloat/.dune-keep
Normal file
2
2.8.1/containers/CCFloat/Infix/index.html
Normal file
2
2.8.1/containers/CCFloat/Infix/index.html
Normal file
|
|
@ -0,0 +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="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCFloat</a> » Infix</nav><h1>Module <code>CCFloat.Infix</code></h1></header><dl><dt class="spec value" id="val-(=)"><a href="#val-(=)" class="anchor"></a><code><span class="keyword">val</span> (=) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-(<>)"><a href="#val-(<>)" class="anchor"></a><code><span class="keyword">val</span> (<>) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-(<)"><a href="#val-(<)" class="anchor"></a><code><span class="keyword">val</span> (<) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-(>)"><a href="#val-(>)" class="anchor"></a><code><span class="keyword">val</span> (>) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-(<=)"><a href="#val-(<=)" class="anchor"></a><code><span class="keyword">val</span> (<=) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-(>=)"><a href="#val-(>=)" class="anchor"></a><code><span class="keyword">val</span> (>=) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><dl><dt>since</dt><dd>0.17</dd></dl></dd></dl><dl><dt class="spec value" id="val-(+)"><a href="#val-(+)" class="anchor"></a><code><span class="keyword">val</span> (+) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Addition.</p><dl><dt>since</dt><dd>2.1</dd></dl></dd></dl><dl><dt class="spec value" id="val-(-)"><a href="#val-(-)" class="anchor"></a><code><span class="keyword">val</span> (-) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Subtraction.</p><dl><dt>since</dt><dd>2.1</dd></dl></dd></dl><dl><dt class="spec value" id="val-(~-)"><a href="#val-(~-)" class="anchor"></a><code><span class="keyword">val</span> (~-) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Unary negation.</p><dl><dt>since</dt><dd>2.1</dd></dl></dd></dl><dl><dt class="spec value" id="val-(*)"><a href="#val-(*)" class="anchor"></a><code><span class="keyword">val</span> (*) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Multiplication.</p><dl><dt>since</dt><dd>2.1</dd></dl></dd></dl><dl><dt class="spec value" id="val-(/)"><a href="#val-(/)" class="anchor"></a><code><span class="keyword">val</span> (/) : <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a> <span>-></span> <a href="../index.html#type-t">t</a></code></dt><dd><p>Division.</p><dl><dt>since</dt><dd>2.1</dd></dl></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCFloat/index.html
Normal file
2
2.8.1/containers/CCFloat/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCFormat/.dune-keep
Normal file
0
2.8.1/containers/CCFormat/.dune-keep
Normal file
2
2.8.1/containers/CCFormat/Dump/index.html
Normal file
2
2.8.1/containers/CCFormat/Dump/index.html
Normal file
File diff suppressed because one or more lines are too long
14
2.8.1/containers/CCFormat/index.html
Normal file
14
2.8.1/containers/CCFormat/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCFun/.dune-keep
Normal file
0
2.8.1/containers/CCFun/.dune-keep
Normal file
2
2.8.1/containers/CCFun/Monad/argument-1-X/index.html
Normal file
2
2.8.1/containers/CCFun/Monad/argument-1-X/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-X (containers.CCFun.Monad.1-X)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCFun</a> » <a href="../index.html">Monad</a> » 1-X</nav><h1>Parameter <code>Monad.1-X</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCFun/Monad/index.html
Normal file
2
2.8.1/containers/CCFun/Monad/index.html
Normal file
|
|
@ -0,0 +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="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCFun</a> » Monad</nav><h1>Module <code>CCFun.Monad</code></h1></header><h3 class="heading">Parameters</h3><ul><li><code><a href="argument-1-X/index.html">X</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></li></ul><h3 class="heading">Signature</h3><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>'a t</span></code><code> = <a href="argument-1-X/index.html#type-t">X.t</a> <span>-></span> <span class="type-var">'a</span></code></dt></dl><dl><dt class="spec value" id="val-return"><a href="#val-return" class="anchor"></a><code><span class="keyword">val</span> return : <span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Monadic <code>return</code>.</p></dd></dl><dl><dt class="spec value" id="val-(>|=)"><a href="#val-(>|=)" class="anchor"></a><code><span class="keyword">val</span> (>|=) : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span class="keyword">val</span> (>>=) : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span></code></dt><dd><p>Monadic <code>bind</code>.</p></dd></dl></div></body></html>
|
||||
4
2.8.1/containers/CCFun/index.html
Normal file
4
2.8.1/containers/CCFun/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCFun_vec/.dune-keep
Normal file
0
2.8.1/containers/CCFun_vec/.dune-keep
Normal file
2
2.8.1/containers/CCFun_vec/index.html
Normal file
2
2.8.1/containers/CCFun_vec/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCGraph/.dune-keep
Normal file
0
2.8.1/containers/CCGraph/.dune-keep
Normal file
2
2.8.1/containers/CCGraph/Dot/index.html
Normal file
2
2.8.1/containers/CCGraph/Dot/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCGraph/Iter/index.html
Normal file
2
2.8.1/containers/CCGraph/Iter/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Iter (containers.CCGraph.Iter)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCGraph</a> » Iter</nav><h1>Module <code>CCGraph.Iter</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>'a t</span></code><code> = <span><span class="type-var">'a</span> <a href="../index.html#type-iter">iter</a></span></code></dt></dl><dl><dt class="spec value" id="val-return"><a href="#val-return" class="anchor"></a><code><span class="keyword">val</span> return : <span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-(>>=)"><a href="#val-(>>=)" class="anchor"></a><code><span class="keyword">val</span> (>>=) : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span>(<span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span>)</span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-map"><a href="#val-map" class="anchor"></a><code><span class="keyword">val</span> map : <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-filter_map"><a href="#val-filter_map" class="anchor"></a><code><span class="keyword">val</span> filter_map : <span>(<span class="type-var">'a</span> <span>-></span> <span><span class="type-var">'b</span> option</span>)</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'b</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-iter"><a href="#val-iter" class="anchor"></a><code><span class="keyword">val</span> iter : <span>(<span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> unit</code></dt><dt class="spec value" id="val-fold"><a href="#val-fold" class="anchor"></a><code><span class="keyword">val</span> fold : <span>(<span class="type-var">'b</span> <span>-></span> <span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span class="type-var">'b</span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span class="type-var">'b</span></code></dt><dt class="spec value" id="val-to_list"><a href="#val-to_list" class="anchor"></a><code><span class="keyword">val</span> to_list : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> list</span></code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCGraph/Lazy_tree/index.html
Normal file
2
2.8.1/containers/CCGraph/Lazy_tree/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Lazy_tree (containers.CCGraph.Lazy_tree)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCGraph</a> » Lazy_tree</nav><h1>Module <code>CCGraph.Lazy_tree</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>('v, 'e) t</span></code><code> = </code><code>{</code><table class="record"><tr id="type-t.vertex" class="anchored"><td class="def field"><a href="#type-t.vertex" class="anchor"></a><code>vertex : <span class="type-var">'v</span>;</code></td></tr><tr id="type-t.children" class="anchored"><td class="def field"><a href="#type-t.children" class="anchor"></a><code>children : <span><span><span>(<span class="type-var">'e</span> * <span><span>(<span class="type-var">'v</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span>)</span> list</span> Lazy.t</span>;</code></td></tr></table><code>}</code></dt></dl><dl><dt class="spec value" id="val-map_v"><a href="#val-map_v" class="anchor"></a><code><span class="keyword">val</span> map_v : <span>(<span class="type-var">'a</span> <span>-></span> <span class="type-var">'b</span>)</span> <span>-></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span>(<span class="type-var">'b</span>, <span class="type-var">'e</span>)</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-fold_v"><a href="#val-fold_v" class="anchor"></a><code><span class="keyword">val</span> fold_v : <span>(<span class="type-var">'acc</span> <span>-></span> <span class="type-var">'v</span> <span>-></span> <span class="type-var">'acc</span>)</span> <span>-></span> <span class="type-var">'acc</span> <span>-></span> <span><span>(<span class="type-var">'v</span>, <span class="type-var">_</span>)</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span class="type-var">'acc</span></code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCGraph/Map/index.html
Normal file
2
2.8.1/containers/CCGraph/Map/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCGraph/Traverse/Event/index.html
Normal file
2
2.8.1/containers/CCGraph/Traverse/Event/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCGraph/Traverse/index.html
Normal file
2
2.8.1/containers/CCGraph/Traverse/index.html
Normal file
File diff suppressed because one or more lines are too long
7
2.8.1/containers/CCGraph/index.html
Normal file
7
2.8.1/containers/CCGraph/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCGraph/module-type-MAP/index.html
Normal file
2
2.8.1/containers/CCGraph/module-type-MAP/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCHash/.dune-keep
Normal file
0
2.8.1/containers/CCHash/.dune-keep
Normal file
2
2.8.1/containers/CCHash/index.html
Normal file
2
2.8.1/containers/CCHash/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCHashSet/.dune-keep
Normal file
0
2.8.1/containers/CCHashSet/.dune-keep
Normal file
2
2.8.1/containers/CCHashSet/Make/argument-1-E/index.html
Normal file
2
2.8.1/containers/CCHashSet/Make/argument-1-E/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-E (containers.CCHashSet.Make.1-E)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCHashSet</a> » <a href="../index.html">Make</a> » 1-E</nav><h1>Parameter <code>Make.1-E</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span class="keyword">val</span> hash : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Positive value</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHashSet/Make/index.html
Normal file
2
2.8.1/containers/CCHashSet/Make/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHashSet/index.html
Normal file
2
2.8.1/containers/CCHashSet/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHashSet (containers.CCHashSet)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCHashSet</nav><h1>Module <code>CCHashSet</code></h1><h2 id="mutable-set"><a href="#mutable-set" class="anchor"></a>Mutable Set</h2><p><b>status: unstable</b></p><dl><dt>since</dt><dd>0.13</dd></dl></header><dl><dt class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><code><span class="keyword">type</span> <span>'a sequence</span></code><code> = <span>(<span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> unit</code></dt><dt class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span class="keyword">type</span> <span>'a printer</span></code><code> = Format.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt></dl><div class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="spec module-type" id="module-type-ELEMENT"><a href="#module-type-ELEMENT" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-ELEMENT/index.html">ELEMENT</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> <a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-E/index.html">E</a> : <a href="index.html#module-type-ELEMENT">ELEMENT</a>) <span>-></span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="Make/index.html#type-elt">elt</a> = <a href="Make/argument-1-E/index.html#type-t">E.t</a></code></div></div></body></html>
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ELEMENT (containers.CCHashSet.ELEMENT)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCHashSet</a> » ELEMENT</nav><h1>Module type <code>CCHashSet.ELEMENT</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span class="keyword">val</span> hash : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p>Positive value</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHashSet/module-type-S/index.html
Normal file
2
2.8.1/containers/CCHashSet/module-type-S/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCHashTrie/.dune-keep
Normal file
0
2.8.1/containers/CCHashTrie/.dune-keep
Normal file
2
2.8.1/containers/CCHashTrie/Make/argument-1-K/index.html
Normal file
2
2.8.1/containers/CCHashTrie/Make/argument-1-K/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-K (containers.CCHashTrie.Make.1-K)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCHashTrie</a> » <a href="../index.html">Make</a> » 1-K</nav><h1>Parameter <code>Make.1-K</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span class="keyword">val</span> hash : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHashTrie/Make/index.html
Normal file
2
2.8.1/containers/CCHashTrie/Make/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHashTrie/Transient/index.html
Normal file
2
2.8.1/containers/CCHashTrie/Transient/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Transient (containers.CCHashTrie.Transient)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCHashTrie</a> » Transient</nav><h1>Module <code>CCHashTrie.Transient</code></h1><h3 id="transient-identifiers"><a href="#transient-identifiers" class="anchor"></a>Transient Identifiers</h3></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Identifiers for transient modifications. A transient modification is uniquely identified by a <code>Transient.t</code>. Once <code>Transient.freeze r</code> is called, <code>r</code> cannot be used to modify the structure again.</p></dd></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : unit <span>-></span> <a href="index.html#type-t">t</a></code></dt><dd><p>Create a new, active ID.</p></dd></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p>Equality between IDs.</p></dd></dl><dl><dt class="spec value" id="val-frozen"><a href="#val-frozen" class="anchor"></a><code><span class="keyword">val</span> frozen : <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p><code>frozen i</code> returns <code>true</code> if <code>freeze i</code> was called before. In this case, the ID cannot be used for modifications again.</p></dd></dl><dl><dt class="spec value" id="val-active"><a href="#val-active" class="anchor"></a><code><span class="keyword">val</span> active : <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p><code>active i</code> is <code>not (frozen i)</code>.</p></dd></dl><dl><dt class="spec value" id="val-freeze"><a href="#val-freeze" class="anchor"></a><code><span class="keyword">val</span> freeze : <a href="index.html#type-t">t</a> <span>-></span> unit</code></dt><dd><p><code>freeze i</code> makes <code>i</code> unusable for new modifications. The values created with <code>i</code> will now be immutable.</p></dd></dl><dl><dt class="spec value" id="val-with_"><a href="#val-with_" class="anchor"></a><code><span class="keyword">val</span> with_ : <span>(<a href="index.html#type-t">t</a> <span>-></span> <span class="type-var">'a</span>)</span> <span>-></span> <span class="type-var">'a</span></code></dt><dd><p><code>with_ f</code> creates a transient ID <code>i</code>, calls <code>f i</code>, freezes the ID <code>i</code> and returns the result of <code>f i</code>.</p></dd></dl><dl><dt class="spec exception" id="exception-Frozen"><a href="#exception-Frozen" class="anchor"></a><code><span class="keyword">exception</span> </code><code><span class="exception">Frozen</span></code></dt><dd><p>Raised when a frozen ID is used.</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHashTrie/index.html
Normal file
2
2.8.1/containers/CCHashTrie/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHashTrie (containers.CCHashTrie)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCHashTrie</nav><h1>Module <code>CCHashTrie</code></h1><h2 id="hash-tries"><a href="#hash-tries" class="anchor"></a>Hash Tries</h2><p>Trie indexed by the hash of the keys, where the branching factor is fixed. The goal is to have a quite efficient functional structure with fast update and access <b>if</b> the hash function is good. The trie is not binary, to improve cache locality and decrease depth.</p><p>Preliminary benchmarks (see the "tbl" section of benchmarks) tend to show that this type is quite efficient for small data sets.</p><p><b>status: unstable</b></p><dl><dt>since</dt><dd>0.13</dd></dl></header><dl><dt class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><code><span class="keyword">type</span> <span>'a sequence</span></code><code> = <span>(<span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> unit</code></dt><dt class="spec type" id="type-gen"><a href="#type-gen" class="anchor"></a><code><span class="keyword">type</span> <span>'a gen</span></code><code> = unit <span>-></span> <span><span class="type-var">'a</span> option</span></code></dt><dt class="spec type" id="type-printer"><a href="#type-printer" class="anchor"></a><code><span class="keyword">type</span> <span>'a printer</span></code><code> = Format.formatter <span>-></span> <span class="type-var">'a</span> <span>-></span> unit</code></dt><dt class="spec type" id="type-ktree"><a href="#type-ktree" class="anchor"></a><code><span class="keyword">type</span> <span>'a ktree</span></code><code> = unit <span>-></span> <span>[ `Nil <span><span>| `Node</span> of <span class="type-var">'a</span> * <span><span><span class="type-var">'a</span> <a href="index.html#type-ktree">ktree</a></span> list</span></span> ]</span></code></dt></dl><dl><dt class="spec module" id="module-Transient"><a href="#module-Transient" class="anchor"></a><code><span class="keyword">module</span> <a href="Transient/index.html">Transient</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module-type" id="module-type-KEY"><a href="#module-type-KEY" class="anchor"></a><code><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-KEY/index.html">KEY</a> = <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span class="keyword">module</span> <a href="Make/index.html">Make</a> : <span class="keyword">functor</span> (<a href="Make/argument-1-K/index.html">K</a> : <a href="index.html#module-type-KEY">KEY</a>) <span>-></span> <a href="index.html#module-type-S">S</a> <span class="keyword">with</span> <span class="keyword">type</span> <a href="Make/index.html#type-key">key</a> = <a href="Make/argument-1-K/index.html#type-t">K.t</a></code></dt><dd></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHashTrie/module-type-KEY/index.html
Normal file
2
2.8.1/containers/CCHashTrie/module-type-KEY/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>KEY (containers.CCHashTrie.KEY)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCHashTrie</a> » KEY</nav><h1>Module type <code>CCHashTrie.KEY</code></h1><h3 id="type-for-keys"><a href="#type-for-keys" class="anchor"></a>Type for keys</h3></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dt class="spec value" id="val-hash"><a href="#val-hash" class="anchor"></a><code><span class="keyword">val</span> hash : <a href="index.html#type-t">t</a> <span>-></span> int</code></dt></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHashTrie/module-type-S/index.html
Normal file
2
2.8.1/containers/CCHashTrie/module-type-S/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCHashtbl/.dune-keep
Normal file
0
2.8.1/containers/CCHashtbl/.dune-keep
Normal file
2
2.8.1/containers/CCHashtbl/Poly/index.html
Normal file
2
2.8.1/containers/CCHashtbl/Poly/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHashtbl/index.html
Normal file
2
2.8.1/containers/CCHashtbl/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHashtbl/module-type-S/index.html
Normal file
2
2.8.1/containers/CCHashtbl/module-type-S/index.html
Normal file
File diff suppressed because one or more lines are too long
0
2.8.1/containers/CCHeap/.dune-keep
Normal file
0
2.8.1/containers/CCHeap/.dune-keep
Normal file
2
2.8.1/containers/CCHeap/Make/argument-1-E/index.html
Normal file
2
2.8.1/containers/CCHeap/Make/argument-1-E/index.html
Normal file
|
|
@ -0,0 +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="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCHeap</a> » <a href="../index.html">Make</a> » 1-E</nav><h1>Parameter <code>Make.1-E</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-leq"><a href="#val-leq" class="anchor"></a><code><span class="keyword">val</span> leq : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p><code>leq x y</code> shall return <code>true</code> iff <code>x</code> is lower or equal to <code>y</code>.</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHeap/Make/index.html
Normal file
2
2.8.1/containers/CCHeap/Make/index.html
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>1-E (containers.CCHeap.Make_from_compare.1-E)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../../index.html">containers</a> » <a href="../../index.html">CCHeap</a> » <a href="../index.html">Make_from_compare</a> » 1-E</nav><h1>Parameter <code>Make_from_compare.1-E</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p><code>compare a b</code> shall return a negative value if <code>a</code> is smaller than <code>b</code>, <code>0</code> if <code>a</code> and <code>b</code> are equal or a positive value if <code>a</code> is greater than <code>b</code></p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHeap/Make_from_compare/index.html
Normal file
2
2.8.1/containers/CCHeap/Make_from_compare/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHeap/index.html
Normal file
2
2.8.1/containers/CCHeap/index.html
Normal file
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +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="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCHeap</a> » PARTIAL_ORD</nav><h1>Module type <code>CCHeap.PARTIAL_ORD</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-leq"><a href="#val-leq" class="anchor"></a><code><span class="keyword">val</span> leq : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> bool</code></dt><dd><p><code>leq x y</code> shall return <code>true</code> iff <code>x</code> is lower or equal to <code>y</code>.</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHeap/module-type-S/index.html
Normal file
2
2.8.1/containers/CCHeap/module-type-S/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHeap/module-type-TOTAL_ORD/index.html
Normal file
2
2.8.1/containers/CCHeap/module-type-TOTAL_ORD/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>TOTAL_ORD (containers.CCHeap.TOTAL_ORD)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCHeap</a> » TOTAL_ORD</nav><h1>Module type <code>CCHeap.TOTAL_ORD</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-compare"><a href="#val-compare" class="anchor"></a><code><span class="keyword">val</span> compare : <a href="index.html#type-t">t</a> <span>-></span> <a href="index.html#type-t">t</a> <span>-></span> int</code></dt><dd><p><code>compare a b</code> shall return a negative value if <code>a</code> is smaller than <code>b</code>, <code>0</code> if <code>a</code> and <code>b</code> are equal or a positive value if <code>a</code> is greater than <code>b</code></p></dd></dl></div></body></html>
|
||||
0
2.8.1/containers/CCHet/.dune-keep
Normal file
0
2.8.1/containers/CCHet/.dune-keep
Normal file
2
2.8.1/containers/CCHet/Key/index.html
Normal file
2
2.8.1/containers/CCHet/Key/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (containers.CCHet.Key)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../../index.html">containers</a> » <a href="../index.html">CCHet</a> » Key</nav><h1>Module <code>CCHet.Key</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> <span>'a t</span></code></dt></dl><dl><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : unit <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span></code></dt><dt class="spec value" id="val-equal"><a href="#val-equal" class="anchor"></a><code><span class="keyword">val</span> equal : <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> <span><span class="type-var">'a</span> <a href="index.html#type-t">t</a></span> <span>-></span> bool</code></dt><dd><p>Compare two keys that have compatible types.</p></dd></dl></div></body></html>
|
||||
2
2.8.1/containers/CCHet/Map/index.html
Normal file
2
2.8.1/containers/CCHet/Map/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHet/Tbl/index.html
Normal file
2
2.8.1/containers/CCHet/Tbl/index.html
Normal file
File diff suppressed because one or more lines are too long
2
2.8.1/containers/CCHet/index.html
Normal file
2
2.8.1/containers/CCHet/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>CCHet (containers.CCHet)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">containers</a> » CCHet</nav><h1>Module <code>CCHet</code></h1><h2 id="associative-containers-with-heterogeneous-values"><a href="#associative-containers-with-heterogeneous-values" class="anchor"></a>Associative containers with Heterogeneous Values</h2><p>This is similar to <a href="../CCMixtbl/index.html"><code>CCMixtbl</code></a>, but the injection is directly used as a key.</p><dl><dt>since</dt><dd>0.17</dd></dl></header><dl><dt class="spec type" id="type-sequence"><a href="#type-sequence" class="anchor"></a><code><span class="keyword">type</span> <span>'a sequence</span></code><code> = <span>(<span class="type-var">'a</span> <span>-></span> unit)</span> <span>-></span> unit</code></dt><dt class="spec type" id="type-gen"><a href="#type-gen" class="anchor"></a><code><span class="keyword">type</span> <span>'a gen</span></code><code> = unit <span>-></span> <span><span class="type-var">'a</span> option</span></code></dt></dl><div class="spec module" id="module-Key"><a href="#module-Key" class="anchor"></a><code><span class="keyword">module</span> <a href="Key/index.html">Key</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec type" id="type-pair"><a href="#type-pair" class="anchor"></a><code><span class="keyword">type</span> pair</code><code> = </code><table class="variant"><tr id="type-pair.Pair" class="anchored"><td class="def constructor"><a href="#type-pair.Pair" class="anchor"></a><code>| </code><code><span class="constructor">Pair</span> : <span><span class="type-var">'a</span> <a href="Key/index.html#type-t">Key.t</a></span> * <span class="type-var">'a</span> <span>-></span> <a href="index.html#type-pair">pair</a></code></td></tr></table></dt></dl><dl><dt class="spec module" id="module-Tbl"><a href="#module-Tbl" class="anchor"></a><code><span class="keyword">module</span> <a href="Tbl/index.html">Tbl</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl><dl><dt class="spec module" id="module-Map"><a href="#module-Map" class="anchor"></a><code><span class="keyword">module</span> <a href="Map/index.html">Map</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd></dd></dl></div></body></html>
|
||||
0
2.8.1/containers/CCIO/.dune-keep
Normal file
0
2.8.1/containers/CCIO/.dune-keep
Normal file
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue