From 39ed4d9a73fbfd8dbb9463795e3e25a3c1f4f5e1 Mon Sep 17 00:00:00 2001 From: zoj613 Date: Thu, 11 Jul 2024 17:36:49 +0000 Subject: [PATCH] deploy: 1a8a5bd70df1b7cf9222bcc40e03564410e5786b --- zarr/Zarr/Codecs/Chain/index.html | 6 +++--- zarr/Zarr/Codecs/index.html | 2 +- zarr/Zarr/index.html | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/zarr/Zarr/Codecs/Chain/index.html b/zarr/Zarr/Codecs/Chain/index.html index 16b14ca..1bf3ebc 100644 --- a/zarr/Zarr/Codecs/Chain/index.html +++ b/zarr/Zarr/Codecs/Chain/index.html @@ -1,9 +1,9 @@ -Chain (zarr.Zarr.Codecs.Chain)

Module Codecs.Chain

type t
val create : +Chain (zarr.Zarr.Codecs.Chain)

Module Codecs.Chain

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

type t

A type representing a valid chain of codecs for decoding/encoding a Zarr array chunk.

val create : ('a, 'b) Zarr__.Util.array_repr -> codec_chain -> - (t, [> error ]) Stdlib.result
val default : t
val compute_encoded_size : int -> t -> int
val encode : t -> ('a, 'b) Ndarray.t -> (string, [> error ]) Stdlib.result
val decode : + (t, [> error ]) Stdlib.result

create r c returns a type representing a chain of codecs defined by chain c and decoded array representation type r.

val default : t

default returns the default codec chain that contains only the required codecs as defined in the Zarr Version 3 specification.

val compute_encoded_size : int -> t -> int

compute_encoded_size init t returns the size (in bytes) of the encoded byte string given the size init of its decoded representation.

val encode : t -> ('a, 'b) Ndarray.t -> (string, [> error ]) Stdlib.result

encode t x computes the encoded byte string representation of array chunk x. Returns an error upon failure.

val decode : t -> ('a, 'b) Zarr__.Util.array_repr -> string -> - (('a, 'b) Ndarray.t, [> error ]) Stdlib.result
val (=) : t -> t -> bool
val of_yojson : Yojson.Safe.t -> (t, string) Stdlib.result
val to_yojson : t -> Yojson.Safe.t
val pp : Stdlib.Format.formatter -> t -> unit
val show : t -> string
+ (('a, 'b) Ndarray.t, [> error ]) Stdlib.result

decode t repr x decodes the byte string x using codec chain t and decoded representation type repr. Returns an error upon failure.

val (=) : t -> t -> bool

x = y returns true if chain x is equal to chain y, and false otherwise.

val of_yojson : Yojson.Safe.t -> (t, string) Stdlib.result

of_yojson x returns a code chain of type t from its json object representation.

val to_yojson : t -> Yojson.Safe.t

to_yojson x returns a json object representation of codec chain x.

diff --git a/zarr/Zarr/Codecs/index.html b/zarr/Zarr/Codecs/index.html index 0c26d9c..65a29c8 100644 --- a/zarr/Zarr/Codecs/index.html +++ b/zarr/Zarr/Codecs/index.html @@ -1,2 +1,2 @@ -Codecs (zarr.Zarr.Codecs)

Module Zarr.Codecs

module Ndarray = Owl.Dense.Ndarray.Generic
type arraytoarray = [
  1. | `Transpose of int array
]
type compression_level =
  1. | L0
  2. | L1
  3. | L2
  4. | L3
  5. | L4
  6. | L5
  7. | L6
  8. | L7
  9. | L8
  10. | L9
type fixed_bytestobytes = [
  1. | `Crc32c
]
type variable_bytestobytes = [
  1. | `Gzip of compression_level
]
type bytestobytes = [
  1. | fixed_bytestobytes
  2. | variable_bytestobytes
]
type endianness =
  1. | Little
  2. | Big
type loc =
  1. | Start
  2. | End
type arraytobytes = [
  1. | `Bytes of endianness
  2. | `ShardingIndexed of sharding_config
]
and sharding_config = {
  1. chunk_shape : int array;
  2. codecs : bytestobytes shard_chain;
  3. index_codecs : fixed_bytestobytes shard_chain;
  4. index_location : loc;
}
and 'a shard_chain = {
  1. a2a : arraytoarray list;
  2. a2b : arraytobytes;
  3. b2b : 'a list;
}
type codec_chain = {
  1. a2a : arraytoarray list;
  2. a2b : arraytobytes;
  3. b2b : bytestobytes list;
}
type error = [
  1. | Zarr__.Extensions.error
  2. | Zarr__.Array_to_array.error
  3. | Zarr__.Bytes_to_bytes.error
  4. | `Sharding of int array * int array * string
]
module Chain : sig ... end
+Codecs (zarr.Zarr.Codecs)

Module Zarr.Codecs

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.

module Ndarray = Owl.Dense.Ndarray.Generic
type arraytoarray = [
  1. | `Transpose of int array
]

The type of array -> array codecs.

type compression_level =
  1. | L0
  2. | L1
  3. | L2
  4. | L3
  5. | L4
  6. | L5
  7. | L6
  8. | L7
  9. | L8
  10. | L9

A type representing valid Gzip codec compression levels.

type fixed_bytestobytes = [
  1. | `Crc32c
]

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

type variable_bytestobytes = [
  1. | `Gzip of compression_level
]

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

type bytestobytes = [
  1. | fixed_bytestobytes
  2. | variable_bytestobytes
]

The type of bytes -> bytes codecs.

type endianness =
  1. | Little
  2. | Big

A type representing the configured endianness of an array.

type loc =
  1. | Start
  2. | End

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

type arraytobytes = [
  1. | `Bytes of endianness
  2. | `ShardingIndexed of sharding_config
]

The type of array -> bytes codecs.

and sharding_config = {
  1. chunk_shape : int array;
  2. codecs : bytestobytes shard_chain;
  3. index_codecs : fixed_bytestobytes shard_chain;
  4. index_location : loc;
}

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

and 'a shard_chain = {
  1. a2a : arraytoarray list;
  2. a2b : arraytobytes;
  3. b2b : 'a list;
}

A type representing the chain of codecs used to encode/decode a shard's bytes and its index array.

type codec_chain = {
  1. a2a : arraytoarray list;
  2. a2b : arraytobytes;
  3. b2b : bytestobytes list;
}

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

type error = [
  1. | `Extension of string
  2. | `Gzip of Ezgzip.error
  3. | `Transpose_order of int array * string
  4. | `Sharding of int array * int array * string
]

The type of errors returned upon failure when an calling a function on a Chain type.

module Chain : sig ... end

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

diff --git a/zarr/Zarr/index.html b/zarr/Zarr/index.html index 7743dbf..a74ab86 100644 --- a/zarr/Zarr/index.html +++ b/zarr/Zarr/index.html @@ -1,2 +1,2 @@ -Zarr (zarr.Zarr)

Module Zarr

type ('a, 'b) array_repr
module Node : sig ... end

This module provides functionality for manipulating Zarr nodes.

module Indexing : sig ... end

A module housing functions for creating and manipulating indices and slices for working with Zarr arrays.

module ArrayMetadata : sig ... end

A module which contains functionality to work with a parsed JSON Zarr array metadata document.

module GroupMetadata : sig ... end

A module which contains functionality to work with a parsed JSON Zarr group metadata document.

module Storage : sig ... end
module Codecs : sig ... end
+Zarr (zarr.Zarr)

Module Zarr

type ('a, 'b) array_repr
module Node : sig ... end

This module provides functionality for manipulating Zarr nodes.

module Indexing : sig ... end

A module housing functions for creating and manipulating indices and slices for working with Zarr arrays.

module ArrayMetadata : sig ... end

A module which contains functionality to work with a parsed JSON Zarr array metadata document.

module GroupMetadata : sig ... end

A module which contains functionality to work with a parsed JSON Zarr group metadata document.

module Storage : sig ... end
module Codecs : sig ... end

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.