-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
5 additions
and
5 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,9 +1,9 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Chain (zarr.Zarr.Codecs.Chain)</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">zarr</a> » <a href="../../index.html">Zarr</a> » <a href="../index.html">Codecs</a> » Chain</nav><header class="odoc-preamble"><h1>Module <code><span>Codecs.Chain</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></code></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 : | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Chain (zarr.Zarr.Codecs.Chain)</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">zarr</a> » <a href="../../index.html">Zarr</a> » <a href="../index.html">Codecs</a> » Chain</nav><header class="odoc-preamble"><h1>Module <code><span>Codecs.Chain</span></code></h1><p>A module containing functions to encode/decode an array chunk using a predefined set of codecs.</p></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></code></div><div class="spec-doc"><p>A type representing a valid chain of codecs for decoding/encoding a Zarr array chunk.</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><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Zarr__.Util.array_repr</span></span> <span class="arrow">-></span></span> | ||
| <span><a href="../index.html#type-codec_chain">codec_chain</a> <span class="arrow">-></span></span> | ||
| <span><span>(<a href="#type-t">t</a>, <span>[> <a href="../index.html#type-error">error</a> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compute_encoded_size"><a href="#val-compute_encoded_size" class="anchor"></a><code><span><span class="keyword">val</span> compute_encoded_size : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></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><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Ndarray</span>.t</span> <span class="arrow">-></span></span> <span><span>(string, <span>[> <a href="../index.html#type-error">error</a> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></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>(<a href="#type-t">t</a>, <span>[> <a href="../index.html#type-error">error</a> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>create r c</code> returns a type representing a chain of codecs defined by chain <code>c</code> and decoded array representation type <code>r</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>default</code> returns the default codec chain that contains only the required codecs as defined in the Zarr Version 3 specification.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compute_encoded_size"><a href="#val-compute_encoded_size" class="anchor"></a><code><span><span class="keyword">val</span> compute_encoded_size : <span>int <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>compute_encoded_size init t</code> returns the size (in bytes) of the encoded byte string given the size <code>init</code> of its decoded representation.</p></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><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Ndarray</span>.t</span> <span class="arrow">-></span></span> <span><span>(string, <span>[> <a href="../index.html#type-error">error</a> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>encode t x</code> computes the encoded byte string representation of array chunk <code>x</code>. Returns an error upon failure.</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><a href="#type-t">t</a> <span class="arrow">-></span></span> | ||
| <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Zarr__.Util.array_repr</span></span> <span class="arrow">-></span></span> | ||
| <span>string <span class="arrow">-></span></span> | ||
| <span><span>(<span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Ndarray</span>.t</span>, <span>[> <a href="../index.html#type-error">error</a> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(=)"><a href="#val-(=)" class="anchor"></a><code><span><span class="keyword">val</span> (=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_yojson"><a href="#val-of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> of_yojson : <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_yojson"><a href="#val-to_yojson" class="anchor"></a><code><span><span class="keyword">val</span> to_yojson : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span><span class="keyword">val</span> pp : <span><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-show"><a href="#val-show" class="anchor"></a><code><span><span class="keyword">val</span> show : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div></div></div></body></html> | ||
| <span><span>(<span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Ndarray</span>.t</span>, <span>[> <a href="../index.html#type-error">error</a> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>decode t repr x</code> decodes the byte string <code>x</code> using codec chain <code>t</code> and decoded representation type <code>repr</code>. Returns an error upon failure.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-(=)"><a href="#val-(=)" class="anchor"></a><code><span><span class="keyword">val</span> (=) : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>x = y</code> returns true if chain <code>x</code> is equal to chain <code>y</code>, and false otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_yojson"><a href="#val-of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> of_yojson : <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_yojson x</code> returns a code chain of type <a href="#type-t"><code>t</code></a> from its json object representation.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_yojson"><a href="#val-to_yojson" class="anchor"></a><code><span><span class="keyword">val</span> to_yojson : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div><div class="spec-doc"><p><code>to_yojson x</code> returns a json object representation of codec chain <code>x</code>.</p></div></div></div></body></html> |
Oops, something went wrong.