Skip to content

Commit

Permalink
deploy: 95d30bd
Browse files Browse the repository at this point in the history
  • Loading branch information
@zoj613
zoj613 committed Jul 22, 2024
1 parent dd3c67e commit 9115ac1
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 7 deletions.
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="zarr/index.html">zarr</a></li>
<li><a href="zarr/index.html">zarr</a> <span class="version">0.1.0</span></li>
</ol>
</div>
</main>
Expand Down
8 changes: 4 additions & 4 deletions zarr/Zarr/Codecs/Chain/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!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> &#x00BB; <a href="../../index.html">Zarr</a> &#x00BB; <a href="../index.html">Codecs</a> &#x00BB; 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">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../index.html#type-array_repr">array_repr</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../index.html#type-codec_chain">codec_chain</a> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-t">t</a>, <span>[&gt; <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-is_just_sharding"><a href="#val-is_just_sharding" class="anchor"></a><code><span><span class="keyword">val</span> is_just_sharding : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>is_just_sharding t</code> is <code>true</code> if the codec chain <code>t</code> contains only the <code>sharding_indexed</code> codec.</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">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>, <span class="xref-unresolved">Stdlib</span>.Bigarray.c_layout)</span> <span class="xref-unresolved">Stdlib</span>.Bigarray.Genarray.t</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(string, <span>[&gt; <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">&#45;&gt;</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">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../index.html#type-array_repr">array_repr</a></span> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>, <span class="xref-unresolved">Stdlib</span>.Bigarray.c_layout)</span> <span class="xref-unresolved">Stdlib</span>.Bigarray.Genarray.t</span>,
<span>[&gt; <span>`Store_read of string</span> <span>| <a href="../index.html#type-error">error</a></span> ]</span>)</span>
Expand All @@ -17,13 +17,13 @@
<span><span>(<span>string list</span>, <span>[&gt; <span>`Store_read of string</span> <span>| <a href="../index.html#type-error">error</a></span> ]</span> <span class="keyword">as</span> 'c)</span> <span class="xref-unresolved">Stdlib</span>.result</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><a href="../index.html#type-partial_setter">partial_setter</a> <span class="arrow">&#45;&gt;</span></span>
<span>int <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../index.html#type-array_repr">array_repr</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(<span>int array</span> * <span class="type-var">'a</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(unit, <span class="type-var">'c</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-partial_decode"><a href="#val-partial_decode" class="anchor"></a><code><span><span class="keyword">val</span> partial_decode :
<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span><span>(int * <span>int option</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span>string list</span>, <span>[&gt; <span>`Store_read of string</span> <span>| <a href="../index.html#type-error">error</a></span> ]</span> <span class="keyword">as</span> 'c)</span> <span class="xref-unresolved">Stdlib</span>.result</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span>int <span class="arrow">&#45;&gt;</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">&#45;&gt;</span></span>
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <a href="../index.html#type-array_repr">array_repr</a></span> <span class="arrow">&#45;&gt;</span></span>
<span><span><span>(int * <span>int array</span>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span>(int * <span class="type-var">'a</span>)</span> list</span>, <span class="type-var">'c</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">&#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><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">&#45;&gt;</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">&#45;&gt;</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>
2 changes: 1 addition & 1 deletion zarr/Zarr/Codecs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
<span><span>| `Bytes</span> of <a href="#type-endianness">endianness</a></span>
<span><span>| `ShardingIndexed</span> of <a href="#type-shard_config">shard_config</a></span>
<span>| <a href="#type-fixed_bytestobytes">fixed_bytestobytes</a></span> ]</span>
list</span>;</span></code></li><li id="type-shard_config.index_location" class="def record field anchored"><a href="#type-shard_config.index_location" class="anchor"></a><code><span>index_location : <a href="#type-loc">loc</a>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A type representing the Sharding indexed codec's configuration parameters.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-codec_chain"><a href="#type-codec_chain" class="anchor"></a><code><span><span class="keyword">type</span> codec_chain</span><span> = <span><span>[ <a href="#type-arraytoarray">arraytoarray</a> <span>| <a href="#type-arraytobytes">arraytobytes</a></span> <span>| <a href="#type-bytestobytes">bytestobytes</a></span> ]</span> list</span></span></code></div><div class="spec-doc"><p>A type used to build a user-defined chain of codecs when creating a Zarr array.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> error</span><span> = </span><span>[ </span></code><ol><li id="type-error.Extension" class="def variant constructor anchored"><a href="#type-error.Extension" class="anchor"></a><code><span>| </span><span>`Extension <span class="keyword">of</span> string</span></code></li><li id="type-error.Gzip" class="def variant constructor anchored"><a href="#type-error.Gzip" class="anchor"></a><code><span>| </span><span>`Gzip <span class="keyword">of</span> <span class="xref-unresolved">Ezgzip</span>.error</span></code></li><li id="type-error.Transpose_order" class="def variant constructor anchored"><a href="#type-error.Transpose_order" class="anchor"></a><code><span>| </span><span>`Transpose_order <span class="keyword">of</span> <span>int array</span> * string</span></code></li><li id="type-error.CodecChain" class="def variant constructor anchored"><a href="#type-error.CodecChain" class="anchor"></a><code><span>| </span><span>`CodecChain <span class="keyword">of</span> string</span></code></li><li id="type-error.Sharding" class="def variant constructor anchored"><a href="#type-error.Sharding" class="anchor"></a><code><span>| </span><span>`Sharding <span class="keyword">of</span> <span>int array</span> * <span>int array</span> * string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of errors returned upon failure when an calling a function on a <a href="Chain/index.html"><code>Chain</code></a> type.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-partial_setter"><a href="#type-partial_setter" class="anchor"></a><code><span><span class="keyword">type</span> partial_setter</span><span> = <span><span class="optlabel">?append</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><span><span>(int * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Chain"><a href="#module-Chain" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Chain/index.html">Chain</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A module containing functions to encode/decode an array chunk using a predefined set of codecs.</p></div></div></div></body></html>
list</span>;</span></code></li><li id="type-shard_config.index_location" class="def record field anchored"><a href="#type-shard_config.index_location" class="anchor"></a><code><span>index_location : <a href="#type-loc">loc</a>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>A type representing the Sharding indexed codec's configuration parameters.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-codec_chain"><a href="#type-codec_chain" class="anchor"></a><code><span><span class="keyword">type</span> codec_chain</span><span> = <span><span>[ <a href="#type-arraytoarray">arraytoarray</a> <span>| <a href="#type-arraytobytes">arraytobytes</a></span> <span>| <a href="#type-bytestobytes">bytestobytes</a></span> ]</span> list</span></span></code></div><div class="spec-doc"><p>A type used to build a user-defined chain of codecs when creating a Zarr array.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> error</span><span> = </span><span>[ </span></code><ol><li id="type-error.Extension" class="def variant constructor anchored"><a href="#type-error.Extension" class="anchor"></a><code><span>| </span><span>`Extension <span class="keyword">of</span> string</span></code></li><li id="type-error.Gzip" class="def variant constructor anchored"><a href="#type-error.Gzip" class="anchor"></a><code><span>| </span><span>`Gzip <span class="keyword">of</span> <span class="xref-unresolved">Ezgzip</span>.error</span></code></li><li id="type-error.Transpose_order" class="def variant constructor anchored"><a href="#type-error.Transpose_order" class="anchor"></a><code><span>| </span><span>`Transpose_order <span class="keyword">of</span> <span>int array</span> * string</span></code></li><li id="type-error.CodecChain" class="def variant constructor anchored"><a href="#type-error.CodecChain" class="anchor"></a><code><span>| </span><span>`CodecChain <span class="keyword">of</span> string</span></code></li><li id="type-error.Sharding" class="def variant constructor anchored"><a href="#type-error.Sharding" class="anchor"></a><code><span>| </span><span>`Sharding <span class="keyword">of</span> <span>int array</span> * <span>int array</span> * string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of errors returned upon failure when an calling a function on a <a href="Chain/index.html"><code>Chain</code></a> type.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-partial_setter"><a href="#type-partial_setter" class="anchor"></a><code><span><span class="keyword">type</span> partial_setter</span><span> = <span><span class="optlabel">?append</span>:bool <span class="arrow">&#45;&gt;</span></span> <span><span><span>(int * string)</span> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-array_repr"><a href="#type-array_repr" class="anchor"></a><code><span><span class="keyword">type</span> <span>('a, 'b) array_repr</span></span><span> = </span><span>{</span></code><ol><li id="type-array_repr.kind" class="def record field anchored"><a href="#type-array_repr.kind" class="anchor"></a><code><span>kind : <span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.Bigarray.kind</span>;</span></code></li><li id="type-array_repr.shape" class="def record field anchored"><a href="#type-array_repr.shape" class="anchor"></a><code><span>shape : <span>int array</span>;</span></code></li><li id="type-array_repr.fill_value" class="def record field anchored"><a href="#type-array_repr.fill_value" class="anchor"></a><code><span>fill_value : <span class="type-var">'a</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>The type summarizing the decoded/encoded representation of a Zarr array or chunk.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Chain"><a href="#module-Chain" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Chain/index.html">Chain</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>A module containing functions to encode/decode an array chunk using a predefined set of codecs.</p></div></div></div></body></html>
Loading

0 comments on commit 9115ac1

Please sign in to comment.