diff --git a/zarr/Zarr/ArrayMetadata/index.html b/zarr/Zarr/ArrayMetadata/index.html index 56efefad..464605df 100644 --- a/zarr/Zarr/ArrayMetadata/index.html +++ b/zarr/Zarr/ArrayMetadata/index.html @@ -8,4 +8,4 @@ ('a, 'b) Stdlib.Bigarray.kind -> 'a -> int array -> - (t, [> Zarr__.Metadata.error ]) Stdlib.result

create ~shape kind fv cshp Creates a new array metadata document with shape shape, fill value fv, data type kind and chunk shape cshp. This operation returns an error if chunk shape is invalid.

val encode : t -> string

encode t returns a byte string representing a JSON Zarr array metadata.

val decode : string -> (t, string) Stdlib.result

decode s decodes a bytes string s into a ArrayMetadata.t type, and returns an error if the decoding process fails.

val shape : t -> int array

shape t returns the shape of the zarr array represented by metadata type t.

val ndim : t -> int

ndim t returns the number of dimension in a Zarr array.

val chunk_shape : t -> int array

chunk_shape t returns the shape a chunk in this zarr array.

val is_valid_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> bool

is_valid_kind t kind checks if kind is a valid Bigarray kind that matches the data type of the zarr array represented by this metadata type.

val fillvalue_of_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> 'a

fillvalue_of_kind t kind returns the fill value of uninitialized chunks in this zarr array given kind. Raises Failure if the kind is not compatible with this array's fill value.

val attributes : t -> Yojson.Safe.t

attributes t Returns a Yojson type containing user attributes assigned to the zarr array represented by t.

val dimension_names : t -> string option list

dimension_name t returns a list of dimension names. If none are defined then an empty list is returned.

val codecs : t -> Codecs.Chain.t

codecs t Returns a type representing the chain of codecs applied when decoding/encoding a Zarr array chunk.

val grid_shape : t -> int array -> int array

grip_shape t returns the shape of the Zarr array's regular chunk grid, as defined in the Zarr V3 specification.

val index_coord_pair : t -> int array -> int array * int array

index_coord_pair t coord maps a coordinate of this Zarr array to a pair of chunk index and coordinate within that chunk.

val chunk_indices : t -> int array -> int array list

chunk_indices t shp returns a list of all chunk indices that would be contained in a zarr array of shape shp given the regular grid defined in array metadata t.

val chunk_key : t -> int array -> string

chunk_key t idx returns a key encoding of a the chunk index idx.

val update_attributes : t -> Yojson.Safe.t -> t

update_attributes t json returns a new metadata type with an updated attribute field containing contents in json

val update_shape : t -> int array -> t

update_shape t new_shp returns a new metadata type containing shape new_shp.

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

a = b returns true if a b are equal array metadata documents and false otherwise.

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

of_yojson json converts a Yojson.Safe.t object into a ArrayMetadata.t and returns an error message upon failure.

val to_yojson : t -> Yojson.Safe.t

to_yojson t serializes an array metadata type into a Yojson.Safe.t object.

+ (t, [> Zarr__.Metadata.error ]) Stdlib.result

create ~shape kind fv cshp Creates a new array metadata document with shape shape, fill value fv, data type kind and chunk shape cshp. This operation returns an error if chunk shape is invalid.

val encode : t -> string

encode t returns a byte string representing a JSON Zarr array metadata.

val decode : string -> (t, string) Stdlib.result

decode s decodes a bytes string s into a ArrayMetadata.t type, and returns an error if the decoding process fails.

val shape : t -> int array

shape t returns the shape of the zarr array represented by metadata type t.

val chunk_shape : t -> int array

chunk_shape t returns the shape a chunk in this zarr array.

val is_valid_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> bool

is_valid_kind t kind checks if kind is a valid Bigarray kind that matches the data type of the zarr array represented by this metadata type.

val fillvalue_of_kind : t -> ('a, 'b) Stdlib.Bigarray.kind -> 'a

fillvalue_of_kind t kind returns the fill value of uninitialized chunks in this zarr array given kind. Raises Failure if the kind is not compatible with this array's fill value.

val attributes : t -> Yojson.Safe.t

attributes t Returns a Yojson type containing user attributes assigned to the zarr array represented by t.

val dimension_names : t -> string option list

dimension_name t returns a list of dimension names. If none are defined then an empty list is returned.

val codecs : t -> Codecs.Chain.t

codecs t Returns a type representing the chain of codecs applied when decoding/encoding a Zarr array chunk.

val index_coord_pair : t -> int array -> int array * int array

index_coord_pair t coord maps a coordinate of this Zarr array to a pair of chunk index and coordinate within that chunk.

val chunk_indices : t -> int array -> int array list

chunk_indices t shp returns a list of all chunk indices that would be contained in a zarr array of shape shp given the regular grid defined in array metadata t.

val chunk_key : t -> int array -> string

chunk_key t idx returns a key encoding of a the chunk index idx.

val update_attributes : t -> Yojson.Safe.t -> t

update_attributes t json returns a new metadata type with an updated attribute field containing contents in json

val update_shape : t -> int array -> t

update_shape t new_shp returns a new metadata type containing shape new_shp.

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

a = b returns true if a b are equal array metadata documents and false otherwise.

diff --git a/zarr/Zarr/GroupMetadata/index.html b/zarr/Zarr/GroupMetadata/index.html index b9eae42e..aa6c7ec2 100644 --- a/zarr/Zarr/GroupMetadata/index.html +++ b/zarr/Zarr/GroupMetadata/index.html @@ -1,2 +1,2 @@ -GroupMetadata (zarr.Zarr.GroupMetadata)

Module Zarr.GroupMetadata

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

type t

A type representing a parsed group metadata document.

val default : t

Return a group metadata type with default values for all fields.

val encode : t -> string

encode t returns a byte string representing a JSON Zarr group metadata.

val decode : string -> (t, string) Stdlib.result

decode s decodes a bytes string s into a t type, and returns an error if the decoding process fails.

val update_attributes : t -> Yojson.Safe.t -> t

update_attributes t json returns a new metadata type with an updated attribute field containing contents in json.

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

of_yojson json converts a Yojson.Safe.t object into a GroupMetadata.t and returns an error message upon failure.

val to_yojson : t -> Yojson.Safe.t

to_yojson t serializes a group metadata type into a Yojson.Safe.t object.

val show : t -> string

show t pretty-prints the contents of the group metadata type t.

val attributes : t -> Yojson.Safe.t

attributes t Returns a Yojson type containing user attributes assigned to the zarr group represented by t.

+GroupMetadata (zarr.Zarr.GroupMetadata)

Module Zarr.GroupMetadata

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

type t

A type representing a parsed group metadata document.

val default : t

Return a group metadata type with default values for all fields.

val encode : t -> string

encode t returns a byte string representing a JSON Zarr group metadata.

val decode : string -> (t, string) Stdlib.result

decode s decodes a bytes string s into a t type, and returns an error if the decoding process fails.

val update_attributes : t -> Yojson.Safe.t -> t

update_attributes t json returns a new metadata type with an updated attribute field containing contents in json.

val show : t -> string

show t pretty-prints the contents of the group metadata type t.

val attributes : t -> Yojson.Safe.t

attributes t Returns a Yojson type containing user attributes assigned to the zarr group represented by t.