Skip to content

Commit

Permalink
Update obatcher doc to 1.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
koonwen committed Sep 9, 2024
1 parent aff1bca commit 236c334
Show file tree
Hide file tree
Showing 54 changed files with 2,162 additions and 0 deletions.
Empty file removed README
Empty file.
19 changes: 19 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.support/odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
<body>
<main class="content">
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="obatcher/index.html">obatcher</a> <span class="version">v1.0</span></li>
</ol>
</div>
</main>
</body>
</html>
2 changes: 2 additions & 0 deletions obatcher/Ds/Batched_counter/Batched/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Batched (obatcher.Ds.Batched_counter.Batched)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">obatcher</a> &#x00BB; <a href="../../index.html">Ds</a> &#x00BB; <a href="../index.html">Batched_counter</a> &#x00BB; Batched</nav><header class="odoc-preamble"><h1>Module <code><span>Batched_counter.Batched</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span>int <span class="xref-unresolved">Stdlib</span>.Atomic.t</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-cfg"><a href="#type-cfg" class="anchor"></a><code><span><span class="keyword">type</span> cfg</span><span> = unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-init"><a href="#val-init" class="anchor"></a><code><span><span class="keyword">val</span> init : <span><span class="optlabel">?cfg</span>:<span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <span>int <span class="xref-unresolved">Stdlib</span>.Atomic.t</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-op"><a href="#type-op" class="anchor"></a><code><span><span class="keyword">type</span> <span>_ op</span></span><span> = </span></code><ol><li id="type-op.Incr" class="def variant constructor anchored"><a href="#type-op.Incr" class="anchor"></a><code><span>| </span><span><span class="constructor">Incr</span> : <span>unit <a href="#type-op">op</a></span></span></code></li><li id="type-op.Decr" class="def variant constructor anchored"><a href="#type-op.Decr" class="anchor"></a><code><span>| </span><span><span class="constructor">Decr</span> : <span>unit <a href="#type-op">op</a></span></span></code></li><li id="type-op.Get" class="def variant constructor anchored"><a href="#type-op.Get" class="anchor"></a><code><span>| </span><span><span class="constructor">Get</span> : <span>int <a href="#type-op">op</a></span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-wrapped_op"><a href="#type-wrapped_op" class="anchor"></a><code><span><span class="keyword">type</span> wrapped_op</span><span> = </span></code><ol><li id="type-wrapped_op.Mk" class="def variant constructor anchored"><a href="#type-wrapped_op.Mk" class="anchor"></a><code><span>| </span><span><span class="constructor">Mk</span> : <span><span class="type-var">'a</span> <a href="#type-op">op</a></span> * <span><span class="type-var">'a</span> <span class="xref-unresolved">Picos</span>.Computation.t</span> <span class="arrow">&#45;&gt;</span> <a href="#type-wrapped_op">wrapped_op</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><a href="#type-wrapped_op">wrapped_op</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions obatcher/Ds/Batched_counter/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Batched_counter (obatcher.Ds.Batched_counter)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">obatcher</a> &#x00BB; <a href="../index.html">Ds</a> &#x00BB; Batched_counter</nav><header class="odoc-preamble"><h1>Module <code><span>Ds.Batched_counter</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Batched"><a href="#module-Batched" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Batched/index.html">Batched</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <a href="../../Obatcher/Make/index.html#type-t">Obatcher.Make(Batched).t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-init"><a href="#val-init" class="anchor"></a><code><span><span class="keyword">val</span> init : <span><span class="optlabel">?cfg</span>:<a href="Batched/index.html#type-cfg">Batched.cfg</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exec"><a href="#val-exec" class="anchor"></a><code><span><span class="keyword">val</span> exec : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> <a href="Batched/index.html#type-op">Batched.op</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_internal"><a href="#val-get_internal" class="anchor"></a><code><span><span class="keyword">val</span> get_internal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Batched/index.html#type-t">Batched.t</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unsafe Should not be used typically by application</li></ul></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-incr"><a href="#val-incr" class="anchor"></a><code><span><span class="keyword">val</span> incr : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decr"><a href="#val-decr" class="anchor"></a><code><span><span class="keyword">val</span> decr : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get"><a href="#val-get" class="anchor"></a><code><span><span class="keyword">val</span> get : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions obatcher/Ds/Batched_hashtbl/Batched/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Batched (obatcher.Ds.Batched_hashtbl.Batched)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">obatcher</a> &#x00BB; <a href="../../index.html">Ds</a> &#x00BB; <a href="../index.html">Batched_hashtbl</a> &#x00BB; Batched</nav><header class="odoc-preamble"><h1>Module <code><span>Batched_hashtbl.Batched</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span><span>(int, string)</span> <span class="xref-unresolved">Stdlib</span>.Hashtbl.t</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-op"><a href="#type-op" class="anchor"></a><code><span><span class="keyword">type</span> <span>'a op</span></span><span> = </span></code><ol><li id="type-op.Add" class="def variant constructor anchored"><a href="#type-op.Add" class="anchor"></a><code><span>| </span><span><span class="constructor">Add</span> : int * string <span class="arrow">&#45;&gt;</span> <span>unit <a href="#type-op">op</a></span></span></code></li><li id="type-op.Replace" class="def variant constructor anchored"><a href="#type-op.Replace" class="anchor"></a><code><span>| </span><span><span class="constructor">Replace</span> : int * string <span class="arrow">&#45;&gt;</span> <span>unit <a href="#type-op">op</a></span></span></code></li><li id="type-op.Remove" class="def variant constructor anchored"><a href="#type-op.Remove" class="anchor"></a><code><span>| </span><span><span class="constructor">Remove</span> : int <span class="arrow">&#45;&gt;</span> <span>unit <a href="#type-op">op</a></span></span></code></li><li id="type-op.Find" class="def variant constructor anchored"><a href="#type-op.Find" class="anchor"></a><code><span>| </span><span><span class="constructor">Find</span> : int <span class="arrow">&#45;&gt;</span> <span>string <a href="#type-op">op</a></span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-wrapped_op"><a href="#type-wrapped_op" class="anchor"></a><code><span><span class="keyword">type</span> wrapped_op</span><span> = </span></code><ol><li id="type-wrapped_op.Mk" class="def variant constructor anchored"><a href="#type-wrapped_op.Mk" class="anchor"></a><code><span>| </span><span><span class="constructor">Mk</span> : <span><span class="type-var">'a</span> <a href="#type-op">op</a></span> * <span><span class="type-var">'a</span> <span class="xref-unresolved">Picos</span>.Computation.t</span> <span class="arrow">&#45;&gt;</span> <a href="#type-wrapped_op">wrapped_op</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-cfg"><a href="#type-cfg" class="anchor"></a><code><span><span class="keyword">type</span> cfg</span><span> = </span><span>{</span></code><ol><li id="type-cfg.random" class="def record field anchored"><a href="#type-cfg.random" class="anchor"></a><code><span>random : <span>bool option</span>;</span></code></li><li id="type-cfg.initial_size" class="def record field anchored"><a href="#type-cfg.initial_size" class="anchor"></a><code><span>initial_size : int;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-init"><a href="#val-init" class="anchor"></a><code><span><span class="keyword">val</span> init : <span><span class="optlabel">?cfg</span>:<a href="#type-cfg">cfg</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.Hashtbl.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run"><a href="#val-run" class="anchor"></a><code><span><span class="keyword">val</span> run : <span><span><span>(int, string)</span> <span class="xref-unresolved">Stdlib</span>.Hashtbl.t</span> <span class="arrow">&#45;&gt;</span></span> <span><span><a href="#type-wrapped_op">wrapped_op</a> array</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions obatcher/Ds/Batched_hashtbl/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Batched_hashtbl (obatcher.Ds.Batched_hashtbl)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">obatcher</a> &#x00BB; <a href="../index.html">Ds</a> &#x00BB; Batched_hashtbl</nav><header class="odoc-preamble"><h1>Module <code><span>Ds.Batched_hashtbl</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Batched"><a href="#module-Batched" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Batched/index.html">Batched</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></summary><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <a href="../../Obatcher/Make/index.html#type-t">Obatcher.Make(Batched).t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-init"><a href="#val-init" class="anchor"></a><code><span><span class="keyword">val</span> init : <span><span class="optlabel">?cfg</span>:<a href="Batched/index.html#type-cfg">Batched.cfg</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exec"><a href="#val-exec" class="anchor"></a><code><span><span class="keyword">val</span> exec : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="type-var">'a</span> <a href="Batched/index.html#type-op">Batched.op</a></span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_internal"><a href="#val-get_internal" class="anchor"></a><code><span><span class="keyword">val</span> get_internal : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="Batched/index.html#type-t">Batched.t</a></span></code></div><div class="spec-doc"><ul class="at-tags"><li class="alert"><span class="at-tag">alert</span> unsafe Should not be used typically by application</li></ul></div></div></details></div></div></body></html>
Loading

0 comments on commit 236c334

Please sign in to comment.