-
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
38 changed files
with
447 additions
and
4 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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Array (zarr-eio.Zarr_eio.Storage.HttpStore.Array)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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-eio</a> » <a href="../../../index.html">Zarr_eio</a> » <a href="../../index.html">Storage</a> » <a href="../index.html">HttpStore</a> » Array</nav><header class="odoc-preamble"><h1>Module <code><span>HttpStore.Array</span></code></h1></header><div class="odoc-content"><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 class="optlabel">?sep</span>:<span>[< `Dot <span>| `Slash</span> Slash ]</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?dimension_names</span>:<span><span>string option</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?attributes</span>:<span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> | ||
| <span><span class="label">codecs</span>:<span><a href="../../../../../zarr/Zarr/Codecs/index.html#type-codec">Zarr.Codecs.codec</a> list</span> <span class="arrow">-></span></span> | ||
| <span><span class="label">shape</span>:<span>int array</span> <span class="arrow">-></span></span> | ||
| <span><span class="label">chunks</span>:<span>int array</span> <span class="arrow">-></span></span> | ||
| <span><span><span class="type-var">'a</span> <a href="../../../../../zarr/Zarr/Ndarray/index.html#type-dtype">Zarr.Ndarray.dtype</a></span> <span class="arrow">-></span></span> | ||
| <span><span class="type-var">'a</span> <span class="arrow">-></span></span> | ||
| <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> | ||
| <span><a href="../index.html#type-t">t</a> <span class="arrow">-></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 ~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->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-metadata"><a href="#val-metadata" class="anchor"></a><code><span><span class="keyword">val</span> metadata : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Metadata/Array/index.html#type-t">Zarr.Metadata.Array.t</a> <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>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-delete"><a href="#val-delete" class="anchor"></a><code><span><span class="keyword">val</span> delete : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> <span>unit <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>delete t n</code> erases array node <code>n</code> from store <code>t</code>. If node <code>n</code> is not a member of store <code>t</code> then this is a no-op.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exists"><a href="#val-exists" class="anchor"></a><code><span><span class="keyword">val</span> exists : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> <span>bool <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>exists t n</code> returns <code>true</code> if array node <code>n</code> is a member of store <code>t</code> and <code>false</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : | ||
| <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> | ||
| <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> | ||
| <span><span><a href="../../../../../zarr/Zarr/Ndarray/Indexing/index.html#type-index">Zarr.Ndarray.Indexing.index</a> array</span> <span class="arrow">-></span></span> | ||
| <span><span><span class="type-var">'a</span> <a href="../../../../../zarr/Zarr/Ndarray/index.html#type-t">Zarr.Ndarray.t</a></span> <span class="arrow">-></span></span> | ||
| <span>unit <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>write 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-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : | ||
| <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> | ||
| <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> | ||
| <span><span><a href="../../../../../zarr/Zarr/Ndarray/Indexing/index.html#type-index">Zarr.Ndarray.Indexing.index</a> array</span> <span class="arrow">-></span></span> | ||
| <span><span><span class="type-var">'a</span> <a href="../../../../../zarr/Zarr/Ndarray/index.html#type-dtype">Zarr.Ndarray.dtype</a></span> <span class="arrow">-></span></span> | ||
| <span><span><span class="type-var">'a</span> <a href="../../../../../zarr/Zarr/Ndarray/index.html#type-t">Zarr.Ndarray.t</a></span> <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>read 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="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> <span><span>int array</span> <span class="arrow">-></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>. Note that when the resizing involves shrinking an array along any dimensions, any old unreachable chunks that fall outside of the array's new shape are deleted from the store.</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><div class="odoc-spec"><div class="spec value anchored" id="val-rename"><a href="#val-rename" class="anchor"></a><code><span><span class="keyword">val</span> rename : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>rename t n name</code> changes the name of array node <code>n</code> in store <code>t</code> to <code>name</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Key_not_found</code> <p>if <code>g</code> is not a member of store <code>t</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Renaming_root</code> <p>if <code>g</code> is the store's root node.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Node_invariant</code> <p>if <code>name</code> is an invalid node name.</p></li></ul></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 |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Group (zarr-eio.Zarr_eio.Storage.HttpStore.Group)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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-eio</a> » <a href="../../../index.html">Zarr_eio</a> » <a href="../../index.html">Storage</a> » <a href="../index.html">HttpStore</a> » Group</nav><header class="odoc-preamble"><h1>Module <code><span>HttpStore.Group</span></code></h1></header><div class="odoc-content"><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 class="optlabel">?attrs</span>:<span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> <span class="arrow">-></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 ?attrs t node</code> creates a group node in store <code>t</code> containing attributes <code>attrs</code>. This is a no-op if <code>node</code> is already a member of this store.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-metadata"><a href="#val-metadata" class="anchor"></a><code><span><span class="keyword">val</span> metadata : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Metadata/Group/index.html#type-t">Zarr.Metadata.Group.t</a> <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>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-children"><a href="#val-children" class="anchor"></a><code><span><span class="keyword">val</span> children : | ||
| <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> | ||
| <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> <span class="arrow">-></span></span> | ||
| <span><span>(<span><a href="../../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> list</span> * <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.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>children 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><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Parse_error</code> <p>if any child node has invalid <code>node_type</code> metadata.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-delete"><a href="#val-delete" class="anchor"></a><code><span><span class="keyword">val</span> delete : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> <span class="arrow">-></span></span> <span>unit <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>delete t n</code> erases group node <code>n</code> from store <code>t</code>. This also erases all child nodes of <code>n</code>. If node <code>n</code> is not a member of store <code>t</code> then this is a no-op.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exists"><a href="#val-exists" class="anchor"></a><code><span><span class="keyword">val</span> exists : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> <span class="arrow">-></span></span> <span>bool <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>exists t n</code> returns <code>true</code> if group node <code>n</code> is a member of store <code>t</code> and <code>false</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rename"><a href="#val-rename" class="anchor"></a><code><span><span class="keyword">val</span> rename : <span><a href="../index.html#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span>unit <a href="../../Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>rename t g name</code> changes the name of group node <code>g</code> in store <code>t</code> to <code>name</code>.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Key_not_found</code> <p>if <code>g</code> is not a member of store <code>t</code>.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Renaming_root</code> <p>if <code>g</code> is the store's root node.</p></li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Node_invariant</code> <p>if <code>name</code> is an invalid node name.</p></li></ul></div></div></div></body></html> |
Oops, something went wrong.