zarr 0.1.0 · OCaml Package

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.

exception Array_to_bytes_invariant

raised when a codec chain contains more than 1 array->bytes codec.

exception Invalid_transpose_order

raised when a codec chain contains a Transpose codec with an incorrect order.

exception Invalid_sharding_chunk_shape

raise when a codec chain contains a shardingindexed codec with an incorrect inner chunk shape.

exception Invalid_codec_ordering

raised when a codec chain has incorrect ordering of codecs. i.e if the ordering is not arraytoarray list -> 1 arraytobytes -> bytestobytes list.

type arraytoarray = [

| `Transpose of int array

]

The type of array -> array codecs.

type compression_level =

| L0
| L1
| L2
| L3
| L4
| L5
| L6
| L7
| L8
| L9

A type representing valid Gzip codec compression levels.

type fixed_bytestobytes = [

| `Crc32c

]

A type representing bytes -> bytes codecs that produce fixed sized encoded strings.

type variable_bytestobytes = [

| `Gzip of compression_level

]

A type representing bytes -> bytes codecs that produce variable sized encoded strings.

type bytestobytes = [

| fixed_bytestobytes
| variable_bytestobytes

]

The type of bytes -> bytes codecs.

type endianness =

| LE
| BE

A type representing the configured endianness of an array.

type loc =

| Start
| End

A type representing the location of a shard's index array in an encoded byte string.

type fixed_arraytobytes = [

| `Bytes of endianness

]

The type of array -> bytes codecs that produce fixed sized encoded string.

type variable_array_tobytes = [

| `ShardingIndexed of shard_config

]

The type of array -> bytes codecs that produce variable sized encoded string.

and shard_config = {

chunk_shape : int array;
codecs : [ arraytoarray | fixed_arraytobytes | `ShardingIndexed of shard_config | bytestobytes ] list;
index_codecs : [ arraytoarray | fixed_arraytobytes | fixed_bytestobytes ] list;
index_location : loc;

}

A type representing the Sharding indexed codec's configuration parameters.

type array_tobytes = [

| fixed_arraytobytes
| variable_array_tobytes

]

The type of array -> bytes codecs.

type codec_chain = [ arraytoarray | array_tobytes | bytestobytes ] list

A type used to build a user-defined chain of codecs when creating a Zarr array.

type 'a array_repr = {

kind : 'a Ndarray.dtype;
shape : int array;

}

The type summarizing the decoded/encoded representation of a Zarr array or chunk.

module Chain : sig ... end

A module containing functions to encode/decode an array chunk using a predefined set of codecs.

module Make (Io : Types.IO) : sig ... end

package zarr