Skip to content

Commit

Permalink
deploy: f6cd148
Browse files Browse the repository at this point in the history
  • Loading branch information
@zoj613
zoj613 committed Jul 20, 2024
1 parent f1c3a46 commit f306f1e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion zarr/Zarr/Codecs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Codecs (zarr.Zarr.Codecs)</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; Codecs</nav><header class="odoc-preamble"><h1>Module <code><span>Zarr.Codecs</span></code></h1><p>An array has an associated list of codecs. Each codec specifies a bidirectional transform (an encode transform and a decode transform). This module contains building blocks for creating and working with a chain of codecs.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-arraytoarray"><a href="#type-arraytoarray" class="anchor"></a><code><span><span class="keyword">type</span> arraytoarray</span><span> = </span><span>[ </span></code><ol><li id="type-arraytoarray.Transpose" class="def variant constructor anchored"><a href="#type-arraytoarray.Transpose" class="anchor"></a><code><span>| </span><span>`Transpose <span class="keyword">of</span> <span>int array</span></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of <code>array -&gt; array</code> codecs.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-compression_level"><a href="#type-compression_level" class="anchor"></a><code><span><span class="keyword">type</span> compression_level</span><span> = </span></code><ol><li id="type-compression_level.L0" class="def variant constructor anchored"><a href="#type-compression_level.L0" class="anchor"></a><code><span>| </span><span><span class="constructor">L0</span></span></code></li><li id="type-compression_level.L1" class="def variant constructor anchored"><a href="#type-compression_level.L1" class="anchor"></a><code><span>| </span><span><span class="constructor">L1</span></span></code></li><li id="type-compression_level.L2" class="def variant constructor anchored"><a href="#type-compression_level.L2" class="anchor"></a><code><span>| </span><span><span class="constructor">L2</span></span></code></li><li id="type-compression_level.L3" class="def variant constructor anchored"><a href="#type-compression_level.L3" class="anchor"></a><code><span>| </span><span><span class="constructor">L3</span></span></code></li><li id="type-compression_level.L4" class="def variant constructor anchored"><a href="#type-compression_level.L4" class="anchor"></a><code><span>| </span><span><span class="constructor">L4</span></span></code></li><li id="type-compression_level.L5" class="def variant constructor anchored"><a href="#type-compression_level.L5" class="anchor"></a><code><span>| </span><span><span class="constructor">L5</span></span></code></li><li id="type-compression_level.L6" class="def variant constructor anchored"><a href="#type-compression_level.L6" class="anchor"></a><code><span>| </span><span><span class="constructor">L6</span></span></code></li><li id="type-compression_level.L7" class="def variant constructor anchored"><a href="#type-compression_level.L7" class="anchor"></a><code><span>| </span><span><span class="constructor">L7</span></span></code></li><li id="type-compression_level.L8" class="def variant constructor anchored"><a href="#type-compression_level.L8" class="anchor"></a><code><span>| </span><span><span class="constructor">L8</span></span></code></li><li id="type-compression_level.L9" class="def variant constructor anchored"><a href="#type-compression_level.L9" class="anchor"></a><code><span>| </span><span><span class="constructor">L9</span></span></code></li></ol></div><div class="spec-doc"><p>A type representing valid Gzip codec compression levels.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-fixed_bytestobytes"><a href="#type-fixed_bytestobytes" class="anchor"></a><code><span><span class="keyword">type</span> fixed_bytestobytes</span><span> = </span><span>[ </span></code><ol><li id="type-fixed_bytestobytes.Crc32c" class="def variant constructor anchored"><a href="#type-fixed_bytestobytes.Crc32c" class="anchor"></a><code><span>| </span><span>`Crc32c</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>A type representing <code>bytes -&gt; bytes</code> codecs that produce fixed sized encoded strings.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-variable_bytestobytes"><a href="#type-variable_bytestobytes" class="anchor"></a><code><span><span class="keyword">type</span> variable_bytestobytes</span><span> = </span><span>[ </span></code><ol><li id="type-variable_bytestobytes.Gzip" class="def variant constructor anchored"><a href="#type-variable_bytestobytes.Gzip" class="anchor"></a><code><span>| </span><span>`Gzip <span class="keyword">of</span> <a href="#type-compression_level">compression_level</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>A type representing <code>bytes -&gt; bytes</code> codecs that produce variable sized encoded strings.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-bytestobytes"><a href="#type-bytestobytes" class="anchor"></a><code><span><span class="keyword">type</span> bytestobytes</span><span> = </span><span>[ </span></code><ol><li id="type-bytestobytes.fixed_bytestobytes" class="def variant type anchored"><a href="#type-bytestobytes.fixed_bytestobytes" class="anchor"></a><code><span>| </span><span><a href="#type-fixed_bytestobytes">fixed_bytestobytes</a></span></code></li><li id="type-bytestobytes.variable_bytestobytes" class="def variant type anchored"><a href="#type-bytestobytes.variable_bytestobytes" class="anchor"></a><code><span>| </span><span><a href="#type-variable_bytestobytes">variable_bytestobytes</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of <code>bytes -&gt; bytes</code> codecs.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-endianness"><a href="#type-endianness" class="anchor"></a><code><span><span class="keyword">type</span> endianness</span><span> = </span></code><ol><li id="type-endianness.Little" class="def variant constructor anchored"><a href="#type-endianness.Little" class="anchor"></a><code><span>| </span><span><span class="constructor">Little</span></span></code></li><li id="type-endianness.Big" class="def variant constructor anchored"><a href="#type-endianness.Big" class="anchor"></a><code><span>| </span><span><span class="constructor">Big</span></span></code></li></ol></div><div class="spec-doc"><p>A type representing the configured endianness of an array.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-loc"><a href="#type-loc" class="anchor"></a><code><span><span class="keyword">type</span> loc</span><span> = </span></code><ol><li id="type-loc.Start" class="def variant constructor anchored"><a href="#type-loc.Start" class="anchor"></a><code><span>| </span><span><span class="constructor">Start</span></span></code></li><li id="type-loc.End" class="def variant constructor anchored"><a href="#type-loc.End" class="anchor"></a><code><span>| </span><span><span class="constructor">End</span></span></code></li></ol></div><div class="spec-doc"><p>A type representing the location of a shard's index array in an encoded byte string.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-arraytobytes"><a href="#type-arraytobytes" class="anchor"></a><code><span><span class="keyword">type</span> arraytobytes</span><span> = </span><span>[ </span></code><ol><li id="type-arraytobytes.Bytes" class="def variant constructor anchored"><a href="#type-arraytobytes.Bytes" class="anchor"></a><code><span>| </span><span>`Bytes <span class="keyword">of</span> <a href="#type-endianness">endianness</a></span></code></li><li id="type-arraytobytes.ShardingIndexed" class="def variant constructor anchored"><a href="#type-arraytobytes.ShardingIndexed" class="anchor"></a><code><span>| </span><span>`ShardingIndexed <span class="keyword">of</span> <a href="#type-shard_config">shard_config</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of <code>array -&gt; bytes</code> codecs.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-shard_config"><a href="#type-shard_config" class="anchor"></a><code><span><span class="keyword">and</span> shard_config</span><span> = </span><span>{</span></code><ol><li id="type-shard_config.chunk_shape" class="def record field anchored"><a href="#type-shard_config.chunk_shape" class="anchor"></a><code><span>chunk_shape : <span>int array</span>;</span></code></li><li id="type-shard_config.codecs" class="def record field anchored"><a href="#type-shard_config.codecs" class="anchor"></a><code><span>codecs : <span><span>[ <a href="#type-arraytoarray">arraytoarray</a>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Codecs (zarr.Zarr.Codecs)</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; Codecs</nav><header class="odoc-preamble"><h1>Module <code><span>Zarr.Codecs</span></code></h1><p>An array has an associated list of codecs. Each codec specifies a bidirectional transform (an encode transform and a decode transform). This module contains building blocks for creating and working with a chain of codecs.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-arraytoarray"><a href="#type-arraytoarray" class="anchor"></a><code><span><span class="keyword">type</span> arraytoarray</span><span> = </span><span>[ </span></code><ol><li id="type-arraytoarray.Transpose" class="def variant constructor anchored"><a href="#type-arraytoarray.Transpose" class="anchor"></a><code><span>| </span><span>`Transpose <span class="keyword">of</span> <span>int array</span></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of <code>array -&gt; array</code> codecs.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-compression_level"><a href="#type-compression_level" class="anchor"></a><code><span><span class="keyword">type</span> compression_level</span><span> = </span></code><ol><li id="type-compression_level.L0" class="def variant constructor anchored"><a href="#type-compression_level.L0" class="anchor"></a><code><span>| </span><span><span class="constructor">L0</span></span></code></li><li id="type-compression_level.L1" class="def variant constructor anchored"><a href="#type-compression_level.L1" class="anchor"></a><code><span>| </span><span><span class="constructor">L1</span></span></code></li><li id="type-compression_level.L2" class="def variant constructor anchored"><a href="#type-compression_level.L2" class="anchor"></a><code><span>| </span><span><span class="constructor">L2</span></span></code></li><li id="type-compression_level.L3" class="def variant constructor anchored"><a href="#type-compression_level.L3" class="anchor"></a><code><span>| </span><span><span class="constructor">L3</span></span></code></li><li id="type-compression_level.L4" class="def variant constructor anchored"><a href="#type-compression_level.L4" class="anchor"></a><code><span>| </span><span><span class="constructor">L4</span></span></code></li><li id="type-compression_level.L5" class="def variant constructor anchored"><a href="#type-compression_level.L5" class="anchor"></a><code><span>| </span><span><span class="constructor">L5</span></span></code></li><li id="type-compression_level.L6" class="def variant constructor anchored"><a href="#type-compression_level.L6" class="anchor"></a><code><span>| </span><span><span class="constructor">L6</span></span></code></li><li id="type-compression_level.L7" class="def variant constructor anchored"><a href="#type-compression_level.L7" class="anchor"></a><code><span>| </span><span><span class="constructor">L7</span></span></code></li><li id="type-compression_level.L8" class="def variant constructor anchored"><a href="#type-compression_level.L8" class="anchor"></a><code><span>| </span><span><span class="constructor">L8</span></span></code></li><li id="type-compression_level.L9" class="def variant constructor anchored"><a href="#type-compression_level.L9" class="anchor"></a><code><span>| </span><span><span class="constructor">L9</span></span></code></li></ol></div><div class="spec-doc"><p>A type representing valid Gzip codec compression levels.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-fixed_bytestobytes"><a href="#type-fixed_bytestobytes" class="anchor"></a><code><span><span class="keyword">type</span> fixed_bytestobytes</span><span> = </span><span>[ </span></code><ol><li id="type-fixed_bytestobytes.Crc32c" class="def variant constructor anchored"><a href="#type-fixed_bytestobytes.Crc32c" class="anchor"></a><code><span>| </span><span>`Crc32c</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>A type representing <code>bytes -&gt; bytes</code> codecs that produce fixed sized encoded strings.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-variable_bytestobytes"><a href="#type-variable_bytestobytes" class="anchor"></a><code><span><span class="keyword">type</span> variable_bytestobytes</span><span> = </span><span>[ </span></code><ol><li id="type-variable_bytestobytes.Gzip" class="def variant constructor anchored"><a href="#type-variable_bytestobytes.Gzip" class="anchor"></a><code><span>| </span><span>`Gzip <span class="keyword">of</span> <a href="#type-compression_level">compression_level</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>A type representing <code>bytes -&gt; bytes</code> codecs that produce variable sized encoded strings.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-bytestobytes"><a href="#type-bytestobytes" class="anchor"></a><code><span><span class="keyword">type</span> bytestobytes</span><span> = </span><span>[ </span></code><ol><li id="type-bytestobytes.fixed_bytestobytes" class="def variant type anchored"><a href="#type-bytestobytes.fixed_bytestobytes" class="anchor"></a><code><span>| </span><span><a href="#type-fixed_bytestobytes">fixed_bytestobytes</a></span></code></li><li id="type-bytestobytes.variable_bytestobytes" class="def variant type anchored"><a href="#type-bytestobytes.variable_bytestobytes" class="anchor"></a><code><span>| </span><span><a href="#type-variable_bytestobytes">variable_bytestobytes</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of <code>bytes -&gt; bytes</code> codecs.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-endianness"><a href="#type-endianness" class="anchor"></a><code><span><span class="keyword">type</span> endianness</span><span> = </span></code><ol><li id="type-endianness.LE" class="def variant constructor anchored"><a href="#type-endianness.LE" class="anchor"></a><code><span>| </span><span><span class="constructor">LE</span></span></code></li><li id="type-endianness.BE" class="def variant constructor anchored"><a href="#type-endianness.BE" class="anchor"></a><code><span>| </span><span><span class="constructor">BE</span></span></code></li></ol></div><div class="spec-doc"><p>A type representing the configured endianness of an array.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-loc"><a href="#type-loc" class="anchor"></a><code><span><span class="keyword">type</span> loc</span><span> = </span></code><ol><li id="type-loc.Start" class="def variant constructor anchored"><a href="#type-loc.Start" class="anchor"></a><code><span>| </span><span><span class="constructor">Start</span></span></code></li><li id="type-loc.End" class="def variant constructor anchored"><a href="#type-loc.End" class="anchor"></a><code><span>| </span><span><span class="constructor">End</span></span></code></li></ol></div><div class="spec-doc"><p>A type representing the location of a shard's index array in an encoded byte string.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-arraytobytes"><a href="#type-arraytobytes" class="anchor"></a><code><span><span class="keyword">type</span> arraytobytes</span><span> = </span><span>[ </span></code><ol><li id="type-arraytobytes.Bytes" class="def variant constructor anchored"><a href="#type-arraytobytes.Bytes" class="anchor"></a><code><span>| </span><span>`Bytes <span class="keyword">of</span> <a href="#type-endianness">endianness</a></span></code></li><li id="type-arraytobytes.ShardingIndexed" class="def variant constructor anchored"><a href="#type-arraytobytes.ShardingIndexed" class="anchor"></a><code><span>| </span><span>`ShardingIndexed <span class="keyword">of</span> <a href="#type-shard_config">shard_config</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of <code>array -&gt; bytes</code> codecs.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-shard_config"><a href="#type-shard_config" class="anchor"></a><code><span><span class="keyword">and</span> shard_config</span><span> = </span><span>{</span></code><ol><li id="type-shard_config.chunk_shape" class="def record field anchored"><a href="#type-shard_config.chunk_shape" class="anchor"></a><code><span>chunk_shape : <span>int array</span>;</span></code></li><li id="type-shard_config.codecs" class="def record field anchored"><a href="#type-shard_config.codecs" class="anchor"></a><code><span>codecs : <span><span>[ <a href="#type-arraytoarray">arraytoarray</a>
<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-bytestobytes">bytestobytes</a></span> ]</span>
Expand Down

0 comments on commit f306f1e

Please sign in to comment.