Skip to content

Commit

Permalink
deploy: f3d6fb6
Browse files Browse the repository at this point in the history
  • Loading branch information
@zoj613
zoj613 committed Jul 20, 2024
1 parent 8ceb88c commit f1c3a46
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion zarr/Zarr/ArrayMetadata/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
<span><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 class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>int array</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-t">t</a>, <span>[&gt; <span class="xref-unresolved">Zarr__.Metadata.error</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>create ~shape kind fv cshp</code> Creates a new array metadata document with shape <code>shape</code>, fill value <code>fv</code>, data type <code>kind</code> and chunk shape <code>cshp</code>. This operation returns an error if chunk shape is invalid.</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> string</span></code></div><div class="spec-doc"><p><code>encode t</code> returns a byte string representing a JSON Zarr array metadata.</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>string <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>decode s</code> decodes a bytes string <code>s</code> into a <a href="#type-t"><code>ArrayMetadata.t</code></a> type, and returns an error if the decoding process fails.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shape"><a href="#val-shape" class="anchor"></a><code><span><span class="keyword">val</span> shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int array</span></span></code></div><div class="spec-doc"><p><code>shape t</code> returns the shape of the zarr array represented by metadata type <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ndim"><a href="#val-ndim" class="anchor"></a><code><span><span class="keyword">val</span> ndim : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p><code>ndim t</code> returns the number of dimension in a Zarr array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_shape"><a href="#val-chunk_shape" class="anchor"></a><code><span><span class="keyword">val</span> chunk_shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int array</span></span></code></div><div class="spec-doc"><p><code>chunk_shape t</code> returns the shape a chunk in this zarr array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_valid_kind"><a href="#val-is_valid_kind" class="anchor"></a><code><span><span class="keyword">val</span> is_valid_kind : <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">Stdlib</span>.Bigarray.kind</span> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>is_valid_kind t kind</code> checks if <code>kind</code> is a valid Bigarray kind that matches the data type of the zarr array represented by this metadata type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fillvalue_of_kind"><a href="#val-fillvalue_of_kind" class="anchor"></a><code><span><span class="keyword">val</span> fillvalue_of_kind : <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">Stdlib</span>.Bigarray.kind</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>fillvalue_of_kind t kind</code> returns the fill value of uninitialized chunks in this zarr array given <code>kind</code>. Raises Failure if the kind is not compatible with this array's fill value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-attributes"><a href="#val-attributes" class="anchor"></a><code><span><span class="keyword">val</span> attributes : <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>attributes t</code> Returns a Yojson type containing user attributes assigned to the zarr array represented by <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dimension_names"><a href="#val-dimension_names" class="anchor"></a><code><span><span class="keyword">val</span> dimension_names : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>string option</span> list</span></span></code></div><div class="spec-doc"><p><code>dimension_name t</code> returns a list of dimension names. If none are defined then an empty list is returned.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-codecs"><a href="#val-codecs" class="anchor"></a><code><span><span class="keyword">val</span> codecs : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Codecs/Chain/index.html#type-t">Codecs.Chain.t</a></span></code></div><div class="spec-doc"><p><code>codecs t</code> Returns a type representing the chain of codecs applied when decoding/encoding a Zarr array chunk.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-grid_shape"><a href="#val-grid_shape" class="anchor"></a><code><span><span class="keyword">val</span> grid_shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span>int array</span></span></code></div><div class="spec-doc"><p><code>grip_shape t</code> returns the shape of the Zarr array's regular chunk grid, as defined in the Zarr V3 specification.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-index_coord_pair"><a href="#val-index_coord_pair" class="anchor"></a><code><span><span class="keyword">val</span> index_coord_pair : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span>int array</span> * <span>int array</span></span></code></div><div class="spec-doc"><p><code>index_coord_pair t coord</code> maps a coordinate of this Zarr array to a pair of chunk index and coordinate <i>within</i> that chunk.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_indices"><a href="#val-chunk_indices" class="anchor"></a><code><span><span class="keyword">val</span> chunk_indices : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> list</span></span></code></div><div class="spec-doc"><p><code>chunk_indices t shp</code> returns a list of all chunk indices that would be contained in a zarr array of shape <code>shp</code> given the regular grid defined in array metadata <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_key"><a href="#val-chunk_key" class="anchor"></a><code><span><span class="keyword">val</span> chunk_key : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>chunk_key t idx</code> returns a key encoding of a the chunk index <code>idx</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_attributes"><a href="#val-update_attributes" class="anchor"></a><code><span><span class="keyword">val</span> update_attributes : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>update_attributes t json</code> returns a new metadata type with an updated attribute field containing contents in <code>json</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_shape"><a href="#val-update_shape" class="anchor"></a><code><span><span class="keyword">val</span> update_shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>update_shape t new_shp</code> returns a new metadata type containing shape <code>new_shp</code>.</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">&#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>a = b</code> returns true if <code>a</code> <code>b</code> are equal array metadata documents 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 json</code> converts a <code>Yojson.Safe.t</code> object into a <a href="#type-t"><code>ArrayMetadata.t</code></a> and returns an error message upon failure.</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 t</code> serializes an array metadata type into a <code>Yojson.Safe.t</code> object.</p></div></div></div></body></html>
<span><span>(<a href="#type-t">t</a>, <span>[&gt; <span class="xref-unresolved">Zarr__.Metadata.error</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>create ~shape kind fv cshp</code> Creates a new array metadata document with shape <code>shape</code>, fill value <code>fv</code>, data type <code>kind</code> and chunk shape <code>cshp</code>. This operation returns an error if chunk shape is invalid.</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> string</span></code></div><div class="spec-doc"><p><code>encode t</code> returns a byte string representing a JSON Zarr array metadata.</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>string <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>decode s</code> decodes a bytes string <code>s</code> into a <a href="#type-t"><code>ArrayMetadata.t</code></a> type, and returns an error if the decoding process fails.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shape"><a href="#val-shape" class="anchor"></a><code><span><span class="keyword">val</span> shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int array</span></span></code></div><div class="spec-doc"><p><code>shape t</code> returns the shape of the zarr array represented by metadata type <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_shape"><a href="#val-chunk_shape" class="anchor"></a><code><span><span class="keyword">val</span> chunk_shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>int array</span></span></code></div><div class="spec-doc"><p><code>chunk_shape t</code> returns the shape a chunk in this zarr array.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_valid_kind"><a href="#val-is_valid_kind" class="anchor"></a><code><span><span class="keyword">val</span> is_valid_kind : <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">Stdlib</span>.Bigarray.kind</span> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>is_valid_kind t kind</code> checks if <code>kind</code> is a valid Bigarray kind that matches the data type of the zarr array represented by this metadata type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-fillvalue_of_kind"><a href="#val-fillvalue_of_kind" class="anchor"></a><code><span><span class="keyword">val</span> fillvalue_of_kind : <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">Stdlib</span>.Bigarray.kind</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>fillvalue_of_kind t kind</code> returns the fill value of uninitialized chunks in this zarr array given <code>kind</code>. Raises Failure if the kind is not compatible with this array's fill value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-attributes"><a href="#val-attributes" class="anchor"></a><code><span><span class="keyword">val</span> attributes : <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>attributes t</code> Returns a Yojson type containing user attributes assigned to the zarr array represented by <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dimension_names"><a href="#val-dimension_names" class="anchor"></a><code><span><span class="keyword">val</span> dimension_names : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>string option</span> list</span></span></code></div><div class="spec-doc"><p><code>dimension_name t</code> returns a list of dimension names. If none are defined then an empty list is returned.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-codecs"><a href="#val-codecs" class="anchor"></a><code><span><span class="keyword">val</span> codecs : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="../Codecs/Chain/index.html#type-t">Codecs.Chain.t</a></span></code></div><div class="spec-doc"><p><code>codecs t</code> Returns a type representing the chain of codecs applied when decoding/encoding a Zarr array chunk.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-index_coord_pair"><a href="#val-index_coord_pair" class="anchor"></a><code><span><span class="keyword">val</span> index_coord_pair : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span>int array</span> * <span>int array</span></span></code></div><div class="spec-doc"><p><code>index_coord_pair t coord</code> maps a coordinate of this Zarr array to a pair of chunk index and coordinate <i>within</i> that chunk.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_indices"><a href="#val-chunk_indices" class="anchor"></a><code><span><span class="keyword">val</span> chunk_indices : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> list</span></span></code></div><div class="spec-doc"><p><code>chunk_indices t shp</code> returns a list of all chunk indices that would be contained in a zarr array of shape <code>shp</code> given the regular grid defined in array metadata <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-chunk_key"><a href="#val-chunk_key" class="anchor"></a><code><span><span class="keyword">val</span> chunk_key : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>chunk_key t idx</code> returns a key encoding of a the chunk index <code>idx</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_attributes"><a href="#val-update_attributes" class="anchor"></a><code><span><span class="keyword">val</span> update_attributes : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>update_attributes t json</code> returns a new metadata type with an updated attribute field containing contents in <code>json</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_shape"><a href="#val-update_shape" class="anchor"></a><code><span><span class="keyword">val</span> update_shape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>update_shape t new_shp</code> returns a new metadata type containing shape <code>new_shp</code>.</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">&#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>a = b</code> returns true if <code>a</code> <code>b</code> are equal array metadata documents and false otherwise.</p></div></div></div></body></html>
Loading

0 comments on commit f1c3a46

Please sign in to comment.