-
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
8 changed files
with
80 additions
and
66 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,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>ArrayNode (zarr.Zarr.Node.ArrayNode)</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">Node</a> » ArrayNode</nav><header class="odoc-preamble"><h1>Module <code><span>Node.ArrayNode</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 class="spec-doc"><p>The type of an array node.</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><a href="../GroupNode/index.html#type-t">GroupNode.t</a> <span class="arrow">-></span></span> <span>string <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 class="spec-doc"><p><code>create p n</code> returns an array node with parent <code>p</code> and name <code>n</code> or an error if this operation fails.</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="../GroupNode/index.html#type-t">GroupNode.t</a> <span class="arrow">-></span></span> <span>string <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 class="spec-doc"><p>The infix operator alias of <a href="#val-create"><code>ArrayNode.create</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_path"><a href="#val-of_path" class="anchor"></a><code><span><span class="keyword">val</span> of_path : <span>string <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 class="spec-doc"><p><code>of_path s</code> returns an array node from string <code>s</code> or an error upon failure.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_path"><a href="#val-to_path" class="anchor"></a><code><span><span class="keyword">val</span> to_path : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_path n</code> returns array node <code>n</code> as a string path.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>name n</code> returns the name of array node <code>n</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parent"><a href="#val-parent" class="anchor"></a><code><span><span class="keyword">val</span> parent : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <a href="../GroupNode/index.html#type-t">GroupNode.t</a></span></code></div><div class="spec-doc"><p><code>parent n</code> returns parent group node of <code>n</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">-></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 <code>true</code> if nodes <code>x</code> and <code>y</code> are equal, and <code>false</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ancestors"><a href="#val-ancestors" class="anchor"></a><code><span><span class="keyword">val</span> ancestors : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../GroupNode/index.html#type-t">GroupNode.t</a> list</span></span></code></div><div class="spec-doc"><p><code>ancestors n</code> returns ancestor group nodes of <code>n</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_parent"><a href="#val-is_parent" class="anchor"></a><code><span><span class="keyword">val</span> is_parent : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="../GroupNode/index.html#type-t">GroupNode.t</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p><code>is_parent n g</code> returns <code>true</code> if group node <code>g</code> is the immediate parent of array node <code>n</code> and <code>false</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_key"><a href="#val-to_key" class="anchor"></a><code><span><span class="keyword">val</span> to_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_key n</code> converts a node's path to a key, as defined in the Zarr V3 specification.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_metakey"><a href="#val-to_metakey" class="anchor"></a><code><span><span class="keyword">val</span> to_metakey : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_prefix n</code> returns the metadata key associated with node <code>n</code>, as defined in the Zarr V3 specification.</p></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 class="spec-doc"><p><code>show n</code> returns a string representation of a node type.</p></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 class="spec-doc"><p><code>pp fmt t</code> pretty prints a node type value.</p></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,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>GroupNode (zarr.Zarr.Node.GroupNode)</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">Node</a> » GroupNode</nav><header class="odoc-preamble"><h1>Module <code><span>Node.GroupNode</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 class="spec-doc"><p>The type of a Group node.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-root"><a href="#val-root" class="anchor"></a><code><span><span class="keyword">val</span> root : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>creates the root node</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><a href="#type-t">t</a> <span class="arrow">-></span></span> <span>string <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 class="spec-doc"><p><code>create p n</code> returns a group node with parent <code>p</code> and name <code>n</code> or an error if this operation fails.</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>string <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 class="spec-doc"><p>The infix operator alias of <a href="#val-create"><code>create</code></a></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_path"><a href="#val-of_path" class="anchor"></a><code><span><span class="keyword">val</span> of_path : <span>string <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 class="spec-doc"><p><code>of_path s</code> returns a node from string <code>s</code> or an error upon failure.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_path"><a href="#val-to_path" class="anchor"></a><code><span><span class="keyword">val</span> to_path : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_path n</code> returns node <code>n</code> as a string path.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>name n</code> returns the name of node <code>n</code>. The root node does not have a name and thus the empty string <code>""</code> is returned if <code>n</code> is a root node.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parent"><a href="#val-parent" class="anchor"></a><code><span><span class="keyword">val</span> parent : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> option</span></span></code></div><div class="spec-doc"><p><code>parent n</code> returns <code>Some p</code> where <code>p</code> is the parent node of <code>n</code> of <code>None</code> if node <code>n</code> is the root node.</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 <code>true</code> if nodes <code>x</code> and <code>y</code> are equal, and <code>false</code> otherwise.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ancestors"><a href="#val-ancestors" class="anchor"></a><code><span><span class="keyword">val</span> ancestors : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><a href="#type-t">t</a> list</span></span></code></div><div class="spec-doc"><p><code>ancestors n</code> returns ancestor nodes of <code>n</code> including the root node. The root node has no ancestors, thus this returns the empty list is called on a root node.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_key"><a href="#val-to_key" class="anchor"></a><code><span><span class="keyword">val</span> to_key : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_key n</code> converts a node's path to a key, as defined in the Zarr V3 specification.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_prefix"><a href="#val-to_prefix" class="anchor"></a><code><span><span class="keyword">val</span> to_prefix : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_prefix n</code> converts a node's path to a prefix key, as defined in the Zarr V3 specification.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_metakey"><a href="#val-to_metakey" class="anchor"></a><code><span><span class="keyword">val</span> to_metakey : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>to_prefix n</code> returns the metadata key associated with node <code>n</code>, as defined in the Zarr V3 specification.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_child_group"><a href="#val-is_child_group" class="anchor"></a><code><span><span class="keyword">val</span> is_child_group : <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>is_child_group m n</code> Tests if group node <code>m</code> is a the immediate parent of group node <code>n</code>. Returns <code>true</code> when the test passes and <code>false</code> otherwise.</p></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 class="spec-doc"><p><code>show n</code> returns a string representation of a node type.</p></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 class="spec-doc"><p><code>pp fmt t</code> pretty prints a node type value.</p></div></div></div></body></html> |
Oops, something went wrong.