deploy: aab74bb

zarr-lwt/Zarr_lwt/Storage/MemoryStore/index.html

@@ -14,13 +14,13 @@
   <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
-  <span>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>create_array ~sep ~dimension_names ~attributes ~codecs ~shape ~chunks kind fill node t</code> creates an array node in store <code>t</code> where:</p><ul><li>Separator <code>sep</code> is used in the array's chunk key encoding.</li><li>Dimension names <code>dimension_names</code> and user attributes <code>attributes</code> are included in it's metadata document.</li><li>A codec chain defined by <code>codecs</code>.</li><li>The array has shape <code>shape</code> and chunk shape <code>chunks</code>.</li><li>The array has data kind <code>kind</code> and fill value <code>fv</code>.</li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <p>if the codec chain is not well defined.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-array_metadata"><a href="#val-array_metadata" class="anchor"></a><code><span><span class="keyword">val</span> array_metadata : 
+  <span>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>create_array ~sep ~dimension_names ~attributes ~codecs ~shape ~chunks kind fill node t</code> creates an array node in store <code>t</code> where:</p><ul><li>Separator <code>sep</code> is used in the array's chunk key encoding.</li><li>Dimension names <code>dimension_names</code> and user attributes <code>attributes</code> are included in it's metadata document.</li><li>A codec chain defined by <code>codecs</code>.</li><li>The array has shape <code>shape</code> and chunk shape <code>chunks</code>.</li><li>The array has data kind <code>kind</code> and fill value <code>fv</code>.</li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Codecs.Bytes_to_bytes_invariant</code> <p>if <code>codecs</code> contains more than one bytes-&gt;bytes codec.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Codecs.Invalid_transpose_order</code> <p>if <code>codecs</code> contains a transpose codec with invalid order array.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Codecs.Invalid_sharding_chunk_shape</code> <p>if <code>codecs</code> contains a shardingindexed codec with an incorrect inner chunk shape.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-array_metadata"><a href="#val-array_metadata" class="anchor"></a><code><span><span class="keyword">val</span> array_metadata : 
   <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> <span class="arrow">&#45;&gt;</span></span>
-  <span><a href="../../../../zarr/Zarr/Metadata/ArrayMetadata/index.html#type-t">Zarr.Metadata.ArrayMetadata.t</a> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>array_metadata node t</code> returns the metadata of array node <code>node</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <p>if node is not a member of store <code>t</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-group_metadata"><a href="#val-group_metadata" class="anchor"></a><code><span><span class="keyword">val</span> group_metadata : 
+  <span><a href="../../../../zarr/Zarr/Metadata/ArrayMetadata/index.html#type-t">Zarr.Metadata.ArrayMetadata.t</a> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>array_metadata node t</code> returns the metadata of array node <code>node</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Key_not_found</code> <p>if node is not a member of store <code>t</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-group_metadata"><a href="#val-group_metadata" class="anchor"></a><code><span><span class="keyword">val</span> group_metadata : 
   <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="../../../../zarr/Zarr/Node/GroupNode/index.html#type-t">Zarr.Node.GroupNode.t</a> <span class="arrow">&#45;&gt;</span></span>
-  <span><a href="../../../../zarr/Zarr/Metadata/GroupMetadata/index.html#type-t">Zarr.Metadata.GroupMetadata.t</a> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>group_metadata node t</code> returns the metadata of group node <code>node</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <p>if node is not a member of store <code>t</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_child_nodes"><a href="#val-find_child_nodes" class="anchor"></a><code><span><span class="keyword">val</span> find_child_nodes : 
+  <span><a href="../../../../zarr/Zarr/Metadata/GroupMetadata/index.html#type-t">Zarr.Metadata.GroupMetadata.t</a> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>group_metadata node t</code> returns the metadata of group node <code>node</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Key_not_found</code> <p>if node is not a member of store <code>t</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_child_nodes"><a href="#val-find_child_nodes" class="anchor"></a><code><span><span class="keyword">val</span> find_child_nodes : 
   <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="../../../../zarr/Zarr/Node/GroupNode/index.html#type-t">Zarr.Node.GroupNode.t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span>(<span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> list</span> * <span><a href="../../../../zarr/Zarr/Node/GroupNode/index.html#type-t">Zarr.Node.GroupNode.t</a> list</span>)</span> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>find_child_nodes t n</code> returns a tuple of child nodes of group node <code>n</code>. This operation returns a pair of empty lists if node <code>n</code> has no children or is not a member of store <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-find_all_nodes"><a href="#val-find_all_nodes" class="anchor"></a><code><span><span class="keyword">val</span> find_all_nodes : 
@@ -30,9 +30,9 @@
   <span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span class="xref-unresolved">Owl_types</span>.index array</span> <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>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>set_array t n s x</code> writes n-dimensional array <code>x</code> to the slice <code>s</code> of array node <code>n</code> in store <code>t</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <ul><li>if the ndarray <code>x</code> size does not equal slice <code>s</code>.</li><li>if the kind of <code>x</code> is not compatible with node <code>n</code>'s data type as described in its metadata document.</li><li>if there is a problem decoding/encoding node <code>n</code> chunks.</li></ul></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_array"><a href="#val-get_array" class="anchor"></a><code><span><span class="keyword">val</span> get_array : 
+  <span>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>set_array t n s x</code> writes n-dimensional array <code>x</code> to the slice <code>s</code> of array node <code>n</code> in store <code>t</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_array_slice</code> <p>if the ndarray <code>x</code> size does not equal slice <code>s</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_data_type</code> <p>if the kind of <code>x</code> is not compatible with node <code>n</code>'s data type as described in its metadata document.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_array"><a href="#val-get_array" class="anchor"></a><code><span><span class="keyword">val</span> get_array : 
   <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span class="xref-unresolved">Owl_types</span>.index array</span> <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><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> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>get_array t n s k</code> reads an n-dimensional array of size determined by slice <code>s</code> from array node <code>n</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <ul><li>if there is a problem decoding/encoding node <code>n</code> chunks.</li><li>if kind <code>k</code> is not compatible with node <code>n</code>'s data type as described in its metadata document.</li><li>if the slice <code>s</code> is not a valid slice of array node <code>n</code>.</li></ul></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reshape"><a href="#val-reshape" class="anchor"></a><code><span><span class="keyword">val</span> reshape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>reshape t n shape</code> resizes array node <code>n</code> of store <code>t</code> into new size <code>shape</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Failure</code> <ul><li>if <code>shape</code> does not have the same dimensions as <code>n</code>'s shape.</li><li>if node <code>n</code> is not a member of store <code>t</code> then this is a no-op.</li></ul></li></ul></div></div></details></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>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ()</code> returns a new In-memory Zarr store type.</p></div></div></div></body></html>
+  <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> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>get_array t n s k</code> reads an n-dimensional array of size determined by slice <code>s</code> from array node <code>n</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_data_type</code> <p>if kind <code>k</code> is not compatible with node <code>n</code>'s data type as described in its metadata document.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_array_slice</code> <p>if the slice <code>s</code> is not a valid slice of array node <code>n</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reshape"><a href="#val-reshape" class="anchor"></a><code><span><span class="keyword">val</span> reshape : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../../../zarr/Zarr/Node/ArrayNode/index.html#type-t">Zarr.Node.ArrayNode.t</a> <span class="arrow">&#45;&gt;</span></span> <span><span>int array</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>reshape t n shape</code> resizes array node <code>n</code> of store <code>t</code> into new size <code>shape</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Invalid_resize_shape</code> <p>if <code>shape</code> does not have the same dimensions as <code>n</code>'s shape.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Key_not_found</code> <p>if node <code>n</code> is not a member of store <code>t</code>.</p></li></ul></div></div></details></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>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>create ()</code> returns a new In-memory Zarr store type.</p></div></div></div></body></html>