-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Sync website for native with Kappa-Dev/KaSim@
- Loading branch information
Showing
149 changed files
with
161 additions
and
161 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Base64 (kappa-library.Kappa_data_structures.Base64)</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">kappa-library</a> » <a href="../index.html">Kappa_data_structures</a> » Base64</nav><header class="odoc-preamble"><h1>Module <code><span>Kappa_data_structures.Base64</span></code></h1><p>Base64 RFC4648 implementation.</p><p>Base64 is a group of similar binary-to-text encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. It is specified in RFC 4648.</p><p><em>Release %%VERSION%% - %%PKG_HOMEPAGE%%</em></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-default_alphabet"><a href="#val-default_alphabet" class="anchor"></a><code><span><span class="keyword">val</span> default_alphabet : string</span></code></div><div class="spec-doc"><p>A 64-character string specifying the regular Base64 alphabet.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-uri_safe_alphabet"><a href="#val-uri_safe_alphabet" class="anchor"></a><code><span><span class="keyword">val</span> uri_safe_alphabet : string</span></code></div><div class="spec-doc"><p>A 64-character string specifying the URI- and filename-safe Base64 alphabet.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode : <span><span class="optlabel">?alphabet</span>:string <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <a href="../Bigbuffer/index.html#type-bigstring">Bigbuffer.bigstring</a></span></code></div><div class="spec-doc"><p><code>decode s</code> decodes the string <code>s</code> that is encoded in Base64 format. Will leave trailing NULLs on the string, padding it out to a multiple of 3 characters. <code>alphabet</code> defaults to <a href="#val-default_alphabet"><code>default_alphabet</code></a>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Not_found</code> <p>if <code>s</code> is not a valid Base64 string.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode"><a href="#val-encode" class="anchor"></a><code><span><span class="keyword">val</span> encode : <span><span class="optlabel">?pad</span>:bool <span class="arrow">-></span></span> <span><span class="optlabel">?alphabet</span>:string <span class="arrow">-></span></span> <span><a href="../Bigbuffer/index.html#type-bigstring">Bigbuffer.bigstring</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>encode s</code> encodes the string <code>s</code> into base64. If <code>pad</code> is false, no trailing padding is added. <code>pad</code> defaults to <code>true</code>, and <code>alphabet</code> to <a href="#val-default_alphabet"><code>default_alphabet</code></a>.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Base64 (kappa-library.Kappa_data_structures.Base64)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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">kappa-library</a> » <a href="../index.html">Kappa_data_structures</a> » Base64</nav><header class="odoc-preamble"><h1>Module <code><span>Kappa_data_structures.Base64</span></code></h1><p>Base64 RFC4648 implementation.</p><p>Base64 is a group of similar binary-to-text encoding schemes that represent binary data in an ASCII string format by translating it into a radix-64 representation. It is specified in RFC 4648.</p><p><em>Release %%VERSION%% - %%PKG_HOMEPAGE%%</em></p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-default_alphabet"><a href="#val-default_alphabet" class="anchor"></a><code><span><span class="keyword">val</span> default_alphabet : string</span></code></div><div class="spec-doc"><p>A 64-character string specifying the regular Base64 alphabet.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-uri_safe_alphabet"><a href="#val-uri_safe_alphabet" class="anchor"></a><code><span><span class="keyword">val</span> uri_safe_alphabet : string</span></code></div><div class="spec-doc"><p>A 64-character string specifying the URI- and filename-safe Base64 alphabet.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode : <span><span class="optlabel">?alphabet</span>:string <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <a href="../Bigbuffer/index.html#type-bigstring">Bigbuffer.bigstring</a></span></code></div><div class="spec-doc"><p><code>decode s</code> decodes the string <code>s</code> that is encoded in Base64 format. Will leave trailing NULLs on the string, padding it out to a multiple of 3 characters. <code>alphabet</code> defaults to <a href="#val-default_alphabet"><code>default_alphabet</code></a>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Not_found</code> <p>if <code>s</code> is not a valid Base64 string.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode"><a href="#val-encode" class="anchor"></a><code><span><span class="keyword">val</span> encode : <span><span class="optlabel">?pad</span>:bool <span class="arrow">-></span></span> <span><span class="optlabel">?alphabet</span>:string <span class="arrow">-></span></span> <span><a href="../Bigbuffer/index.html#type-bigstring">Bigbuffer.bigstring</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>encode s</code> encodes the string <code>s</code> into base64. If <code>pad</code> is false, no trailing padding is added. <code>pad</code> defaults to <code>true</code>, and <code>alphabet</code> to <a href="#val-default_alphabet"><code>default_alphabet</code></a>.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bigbuffer (kappa-library.Kappa_data_structures.Bigbuffer)</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">kappa-library</a> » <a href="../index.html">Kappa_data_structures</a> » Bigbuffer</nav><header class="odoc-preamble"><h1>Module <code><span>Kappa_data_structures.Bigbuffer</span></code></h1><p>Extensible buffers.</p><p>This module implements buffers that automatically expand as necessary. It provides accumulative concatenation of strings in quasi-linear time (instead of quadratic time when strings are concatenated pairwise).</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-bigstring"><a href="#type-bigstring" class="anchor"></a><code><span><span class="keyword">type</span> bigstring</span><span> = | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Bigbuffer (kappa-library.Kappa_data_structures.Bigbuffer)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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">kappa-library</a> » <a href="../index.html">Kappa_data_structures</a> » Bigbuffer</nav><header class="odoc-preamble"><h1>Module <code><span>Kappa_data_structures.Bigbuffer</span></code></h1><p>Extensible buffers.</p><p>This module implements buffers that automatically expand as necessary. It provides accumulative concatenation of strings in quasi-linear time (instead of quadratic time when strings are concatenated pairwise).</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-bigstring"><a href="#type-bigstring" class="anchor"></a><code><span><span class="keyword">type</span> bigstring</span><span> = | ||
| <span><span>(char, <span class="xref-unresolved">Stdlib</span>.Bigarray.int8_unsigned_elt, <span class="xref-unresolved">Stdlib</span>.Bigarray.c_layout)</span> | ||
| <span class="xref-unresolved">Stdlib</span>.Bigarray.Array1.t</span></span></code></div></div><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></code></div><div class="spec-doc"><p>The abstract type of buffers.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create"><a href="#val-create" class="anchor"></a><code><span><span class="keyword">val</span> create : <span>int <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create n</code> returns a fresh buffer, initially empty. The <code>n</code> parameter is the initial size of the internal byte sequence that holds the buffer contents. That byte sequence is automatically reallocated when more than <code>n</code> characters are stored in the buffer, but shrinks back to <code>n</code> characters when <code>reset</code> is called. For best performance, <code>n</code> should be of the same order of magnitude as the number of characters that are expected to be stored in the buffer (for instance, 80 for a buffer that holds one output line). Nothing bad will happen if the buffer grows beyond that limit, however. In doubt, take <code>n = 16</code> for instance. If <code>n</code> is not between 1 and <code>Sys.max_string_length</code>, it will be clipped to that interval.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-contents"><a href="#val-contents" class="anchor"></a><code><span><span class="keyword">val</span> contents : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="#type-bigstring">bigstring</a></span></code></div><div class="spec-doc"><p>Return a copy of the current contents of the buffer. The buffer itself is unchanged.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_char"><a href="#val-add_char" class="anchor"></a><code><span><span class="keyword">val</span> add_char : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>char <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>add_char b c</code> appends the character <code>c</code> at the end of buffer <code>b</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-length"><a href="#val-length" class="anchor"></a><code><span><span class="keyword">val</span> length : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p>Return the number of characters currently contained in the buffer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_string"><a href="#val-add_string" class="anchor"></a><code><span><span class="keyword">val</span> add_string : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>add_string b s</code> appends the string <code>s</code> at the end of buffer <code>b</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_substring"><a href="#val-add_substring" class="anchor"></a><code><span><span class="keyword">val</span> add_substring : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>add_substring b s ofs len</code> takes <code>len</code> characters from offset <code>ofs</code> in string <code>s</code> and appends them at the end of buffer <code>b</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-add_subbytes"><a href="#val-add_subbytes" class="anchor"></a><code><span><span class="keyword">val</span> add_subbytes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>bytes <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>add_subbytes b s ofs len</code> takes <code>len</code> characters from offset <code>ofs</code> in byte sequence <code>s</code> and appends them at the end of buffer <code>b</code>.</p><ul class="at-tags"><li class="since"><span class="at-tag">since</span> 4.02</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-nth"><a href="#val-nth" class="anchor"></a><code><span><span class="keyword">val</span> nth : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> char</span></code></div><div class="spec-doc"><p>Get the n-th character of the buffer. Raise <code>Invalid_argument</code> if index out of bounds</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-clear"><a href="#val-clear" class="anchor"></a><code><span><span class="keyword">val</span> clear : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Empty the buffer.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reset"><a href="#val-reset" class="anchor"></a><code><span><span class="keyword">val</span> reset : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Empty the buffer and deallocate the internal byte sequence holding the buffer contents, replacing it with the initial internal byte sequence of length <code>n</code> that was allocated by <code>Buffer.create</code> <code>n</code>. For long-lived buffers that may have grown a lot, <code>reset</code> allows faster reclamation of the space used by the buffer.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Buffers (kappa-library.Kappa_data_structures.Buffers)</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">kappa-library</a> » <a href="../index.html">Kappa_data_structures</a> » Buffers</nav><header class="odoc-preamble"><h1>Module <code><span>Kappa_data_structures.Buffers</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Buffers"><a href="#module-type-Buffers" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Buffers/index.html">Buffers</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Buffers (kappa-library.Kappa_data_structures.Buffers)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><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">kappa-library</a> » <a href="../index.html">Kappa_data_structures</a> » Buffers</nav><header class="odoc-preamble"><h1>Module <code><span>Kappa_data_structures.Buffers</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module-type anchored" id="module-type-Buffers"><a href="#module-type-Buffers" class="anchor"></a><code><span><span class="keyword">module</span> <span class="keyword">type</span> <a href="module-type-Buffers/index.html">Buffers</a></span><span> = <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html> |
Oops, something went wrong.