simon/ocaml-containers
1
0
Fork 0
mirror of https://github.com/c-cube/ocaml-containers.git synced 2025-12-06 19:25:28 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

deploy: 81acaaa2cb

Browse source
This commit is contained in:
c-cube 2023-06-06 15:23:46 +00:00
parent fde0e66477
commit 70877f74ea
6 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
dev/_odoc-theme/manual.css
View file

@ -4,7 +4,7 @@
/* Copyright (c) 2019 The odig programmers. All rights reserved. /* Copyright (c) 2019 The odig programmers. All rights reserved.
Distributed under the ISC license, see terms at the end of the file. Distributed under the ISC license, see terms at the end of the file.
odig v0.0.8 */ odig v0.0.9 */
:root { --font-headings: "PT-Sans-Caption"; :root { --font-headings: "PT-Sans-Caption";
--font-body: "PT-Sans"; --font-body: "PT-Sans";

15
dev/_odoc-theme/odoc.css
View file

@ -175,6 +175,8 @@ code, pre
color: var(--color-code-fg); color: var(--color-code-fg);
overflow-wrap: anywhere; } overflow-wrap: anywhere; }
code span span { white-space: nowrap } /* Do not break these units */
pre code { font-size: inherit } /* don't apply transform twice... */ pre code { font-size: inherit } /* don't apply transform twice... */
a code { color: inherit } a code { color: inherit }
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { text-transform: none; } h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { text-transform: none; }
@ -259,13 +261,16 @@ a.anchor
.spec.type { padding-left: 0; text-indent: 0 } .spec.type { padding-left: 0; text-indent: 0 }
.spec.type > a.anchor .spec.type > a.anchor
{ padding-left: 1ch; padding-right: 1ch; /* values from a.anchor */ } { padding-left: 1ch; padding-right: 1ch; /* values from a.anchor */ }
.spec li > a.anchor, .spec > a.anchor
.spec td > a.anchor, .spec > a.anchor
{ padding-right: 0.5ch; padding-left: 2ch; } { padding-right: 0.5ch; padding-left: 2ch; }
.odoc-spec table { margin-top: 0 } .spec ol { margin:0; list-style-type: none; }
.odoc-spec .def-doc { padding-left: 1ch; } .spec li { margin-left: 0; padding-left: 4ch; text-indent: -4ch }
.odoc-spec .def-doc *:first-child { margin-top: 0 } .spec li.record.field { margin-left: 2ch }
.spec .def-doc { display: inline-block }
.spec .def-doc { padding-left: /* 4 + 3 */ 7ch; }
.spec .def-doc p { margin-left: -4ch; text-indent: 0 }
.odoc-include summary { cursor: pointer } .odoc-include summary { cursor: pointer }

2
dev/containers-data/CCBitField/Make/argument-1-_/index.html
View file

@ -1,2 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>_ (containers-data.CCBitField.Make._)</title><link rel="stylesheet" href="../../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../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">containers-data</a> &#x00BB; <a href="../../index.html">CCBitField</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; _</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make._</span></code></h1></header><div class="odoc-content"></div></body></html>

2
dev/containers-data/CCBitField/Make/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-data.CCBitField.Make)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../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">containers-data</a> &#x00BB; <a href="../index.html">CCBitField</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>CCBitField.Make</span></code></h1><p>Create a new bitfield type</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-_"><a href="#argument-1-_" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-_/index.html">_</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><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 class="keyword">private</span> int</span></code></div><div class="spec-doc"><p>Generative type of bitfields. Each instantiation of the functor should create a new, incompatible type</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Empty bitfields (all bits 0).</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-field"><a href="#type-field" class="anchor"></a><code><span><span class="keyword">type</span> field</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-field">field</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Get the value of this field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="#type-field">field</a> <span class="arrow">&#45;&gt;</span></span> <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Set the value of this field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mk_field"><a href="#val-mk_field" class="anchor"></a><code><span><span class="keyword">val</span> mk_field : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-field">field</a></span></code></div><div class="spec-doc"><p>Make a new field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-freeze"><a href="#val-freeze" class="anchor"></a><code><span><span class="keyword">val</span> freeze : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Prevent new fields from being added. From now on, creating a field will raise Frozen.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-total_width"><a href="#val-total_width" class="anchor"></a><code><span><span class="keyword">val</span> total_width : <span>unit <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Current width of the bitfield.</p></div></div></div></body></html> <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (containers-data.CCBitField.Make)</title><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../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">containers-data</a> &#x00BB; <a href="../index.html">CCBitField</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>CCBitField.Make</span></code></h1><p>Create a new bitfield type</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><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 class="keyword">private</span> int</span></code></div><div class="spec-doc"><p>Generative type of bitfields. Each instantiation of the functor should create a new, incompatible type</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-empty"><a href="#val-empty" class="anchor"></a><code><span><span class="keyword">val</span> empty : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Empty bitfields (all bits 0).</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-field"><a href="#type-field" class="anchor"></a><code><span><span class="keyword">type</span> field</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-field">field</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Get the value of this field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-set"><a href="#val-set" class="anchor"></a><code><span><span class="keyword">val</span> set : <span><a href="#type-field">field</a> <span class="arrow">&#45;&gt;</span></span> <span>bool <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Set the value of this field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mk_field"><a href="#val-mk_field" class="anchor"></a><code><span><span class="keyword">val</span> mk_field : <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-field">field</a></span></code></div><div class="spec-doc"><p>Make a new field.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-freeze"><a href="#val-freeze" class="anchor"></a><code><span><span class="keyword">val</span> freeze : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Prevent new fields from being added. From now on, creating a field will raise Frozen.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-total_width"><a href="#val-total_width" class="anchor"></a><code><span><span class="keyword">val</span> total_width : <span>unit <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Current width of the bitfield.</p></div></div></div></body></html>

2
dev/containers-data/CCBitField/index.html
View file

@ -9,4 +9,4 @@ let f = B.empty |&gt; B.set x true |&gt; B.set y true;;
assert (not (B.get z f)) ;; assert (not (B.get z f)) ;;
assert (f |&gt; B.set z true |&gt; B.get z);;</code></pre></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-TooManyFields"><a href="#exception-TooManyFields" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">TooManyFields</span></span></code></div><div class="spec-doc"><p>Raised when too many fields are packed into one bitfield.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Frozen"><a href="#exception-Frozen" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Frozen</span></span></code></div><div class="spec-doc"><p>Raised when a frozen bitfield is modified.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_width"><a href="#val-max_width" class="anchor"></a><code><span><span class="keyword">val</span> max_width : int</span></code></div><div class="spec-doc"><p>System-dependent maximum width for a bitfield, typically 30 or 62.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> (<a href="Make/argument-1-_/index.html">_</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span>) : <a href="module-type-S/index.html">S</a></span></code></div><div class="spec-doc"><p>Create a new bitfield type</p></div></div></div></body></html> assert (f |&gt; B.set z true |&gt; B.get z);;</code></pre></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-TooManyFields"><a href="#exception-TooManyFields" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">TooManyFields</span></span></code></div><div class="spec-doc"><p>Raised when too many fields are packed into one bitfield.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Frozen"><a href="#exception-Frozen" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Frozen</span></span></code></div><div class="spec-doc"><p>Raised when a frozen bitfield is modified.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-max_width"><a href="#val-max_width" class="anchor"></a><code><span><span class="keyword">val</span> max_width : int</span></code></div><div class="spec-doc"><p>System-dependent maximum width for a bitfield, typically 30 or 62.</p></div></div><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-S"><a href="#module-type-S" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-S/index.html">S</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span> () : <a href="module-type-S/index.html">S</a></span></code></div><div class="spec-doc"><p>Create a new bitfield type</p></div></div></div></body></html>

2
dev/index.html
View file

@ -1,2 +1,2 @@
<!DOCTYPE html> <!DOCTYPE html>
<html><head><meta charset="utf-8"><meta name="generator" content="odig v0.0.8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><link rel="stylesheet" type="text/css" media="screen, print" href="_odoc-theme/odoc.css"><title>_opam</title></head><body class="odoc"><nav class="odoc-nav">🐫</nav><header class="odoc-preamble"><h1>OCaml package documentation</h1><p>Browse <a href="#by-name">by name</a>, <a href="#by-tag">by tag</a>, the <a href="ocaml/Stdlib/index.html#modules">standard library</a> and the <a href="https://ocaml.org/manual/">OCaml manual</a> (online, latest version).</p><p><small>Generated for <code>/home/runner/work/ocaml-containers/ocaml-containers/_opam/lib</code></small></p></header><nav class="odoc-toc"><ul><li><a href="ocaml/Stdlib/index.html#modules">OCaml standard library</a></li><li><a href="https://ocaml.org/manual/">OCaml manual</a></li><li><a href="#by-name">Packages by name</a></li><li><a href="#by-tag">Packages by tag</a></li></ul></nav><div class="odoc-content"><h2 id="by-name"><a href="#by-name" aria-hidden="true" class="anchor"></a>Packages by name</h2><div class="by-name"><nav><a href="#name-c">c</a><a href="#name-e">e</a><a href="#name-o">o</a></nav><h3 id="name-c"><a href="#name-c" aria-hidden="true" class="anchor"></a>c</h3><ol class="packages"><li id="package-containers"><a href="#package-containers" aria-hidden="true" class="anchor"></a><a href="containers/index.html">containers</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-containers-data"><a href="#package-containers-data" aria-hidden="true" class="anchor"></a><a href="containers-data/index.html">containers-data</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-containers-thread"><a href="#package-containers-thread" aria-hidden="true" class="anchor"></a><a href="containers-thread/index.html">containers-thread</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-e"><a href="#name-e" aria-hidden="true" class="anchor"></a>e</h3><ol class="packages"><li id="package-either"><a href="#package-either" aria-hidden="true" class="anchor"></a><a href="either/index.html">either</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-o"><a href="#name-o" aria-hidden="true" class="anchor"></a>o</h3><ol class="packages"><li id="package-ocaml"><a href="#package-ocaml" aria-hidden="true" class="anchor"></a><a href="ocaml/index.html">ocaml</a> <span class="version"></span> <span class="synopsis"></span></li></ol></div><h2 id="by-tag"><a href="#by-tag" aria-hidden="true" class="anchor"></a>Packages by tag</h2><div class="by-tag"><nav><table></table></nav></div></div></body></html> <html><head><meta charset="utf-8"><meta name="generator" content="odig v0.0.9"><meta name="viewport" content="width=device-width, initial-scale=1.0"><link rel="stylesheet" type="text/css" media="screen, print" href="_odoc-theme/odoc.css"><title>_opam</title></head><body class="odoc"><nav class="odoc-nav">🐫</nav><header class="odoc-preamble"><h1>OCaml package documentation</h1><p>Browse <a href="#by-name">by name</a>, <a href="#by-tag">by tag</a>, the <a href="ocaml/Stdlib/index.html#modules">standard library</a> and the <a href="https://ocaml.org/manual/">OCaml manual</a> (online, latest version).</p><p><small>Generated for <code>/home/runner/work/ocaml-containers/ocaml-containers/_opam/lib</code></small></p></header><nav class="odoc-toc"><ul><li><a href="ocaml/Stdlib/index.html#modules">OCaml standard library</a></li><li><a href="https://ocaml.org/manual/">OCaml manual</a></li><li><a href="#by-name">Packages by name</a></li><li><a href="#by-tag">Packages by tag</a></li></ul></nav><div class="odoc-content"><h2 id="by-name"><a href="#by-name" aria-hidden="true" class="anchor"></a>Packages by name</h2><div class="by-name"><nav><a href="#name-c">c</a><a href="#name-e">e</a><a href="#name-o">o</a></nav><h3 id="name-c"><a href="#name-c" aria-hidden="true" class="anchor"></a>c</h3><ol class="packages"><li id="package-containers"><a href="#package-containers" aria-hidden="true" class="anchor"></a><a href="containers/index.html">containers</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-containers-data"><a href="#package-containers-data" aria-hidden="true" class="anchor"></a><a href="containers-data/index.html">containers-data</a> <span class="version"></span> <span class="synopsis"></span></li><li id="package-containers-thread"><a href="#package-containers-thread" aria-hidden="true" class="anchor"></a><a href="containers-thread/index.html">containers-thread</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-e"><a href="#name-e" aria-hidden="true" class="anchor"></a>e</h3><ol class="packages"><li id="package-either"><a href="#package-either" aria-hidden="true" class="anchor"></a><a href="either/index.html">either</a> <span class="version"></span> <span class="synopsis"></span></li></ol><h3 id="name-o"><a href="#name-o" aria-hidden="true" class="anchor"></a>o</h3><ol class="packages"><li id="package-ocaml"><a href="#package-ocaml" aria-hidden="true" class="anchor"></a><a href="ocaml/index.html">ocaml</a> <span class="version"></span> <span class="synopsis"></span></li></ol></div><h2 id="by-tag"><a href="#by-tag" aria-hidden="true" class="anchor"></a>Packages by tag</h2><div class="by-tag"><nav><table></table></nav></div></div></body></html>