Batteries user guide : BatBigarray

`sig
type float32_elt = Bigarray.float32_elt
type float64_elt = Bigarray.float64_elt
type complex32_elt = Bigarray.complex32_elt
type complex64_elt = Bigarray.complex64_elt
type int8_signed_elt = Bigarray.int8_signed_elt
type int8_unsigned_elt = Bigarray.int8_unsigned_elt
type int16_signed_elt = Bigarray.int16_signed_elt
type int16_unsigned_elt = Bigarray.int16_unsigned_elt
type int_elt = Bigarray.int_elt
type int32_elt = Bigarray.int32_elt
type int64_elt = Bigarray.int64_elt
type nativeint_elt = Bigarray.nativeint_elt
type ('a, 'b) kind = ('a, 'b) Bigarray.kind
val float32 : (float, BatBigarray.float32_elt) BatBigarray.kind
val float64 : (float, BatBigarray.float64_elt) BatBigarray.kind
val complex32 : (Complex.t, BatBigarray.complex32_elt) BatBigarray.kind
val complex64 : (Complex.t, BatBigarray.complex64_elt) BatBigarray.kind
val int8_signed : (int, BatBigarray.int8_signed_elt) BatBigarray.kind
val int8_unsigned : (int, BatBigarray.int8_unsigned_elt) BatBigarray.kind
val int16_signed : (int, BatBigarray.int16_signed_elt) BatBigarray.kind
val int16_unsigned : (int, BatBigarray.int16_unsigned_elt) BatBigarray.kind
val int : (int, BatBigarray.int_elt) BatBigarray.kind
val int32 : (int32, BatBigarray.int32_elt) BatBigarray.kind
val int64 : (int64, BatBigarray.int64_elt) BatBigarray.kind
val nativeint : (nativeint, BatBigarray.nativeint_elt) BatBigarray.kind
val char : (char, BatBigarray.int8_unsigned_elt) BatBigarray.kind
type c_layout = Bigarray.c_layout
type fortran_layout = Bigarray.fortran_layout
type 'a layout = 'a Bigarray.layout
val c_layout : BatBigarray.c_layout BatBigarray.layout
val fortran_layout : BatBigarray.fortran_layout BatBigarray.layout
module Genarray :
sig
type ('a, 'b, 'c) t = ('a, 'b, 'c) Bigarray.Genarray.t
external create :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
int array -> ('a, 'b, 'c) BatBigarray.Genarray.t = "caml_ba_create"
external num_dims : ('a, 'b, 'c) BatBigarray.Genarray.t -> int
= "caml_ba_num_dims"
val dims : ('a, 'b, 'c) BatBigarray.Genarray.t -> int array
external nth_dim : ('a, 'b, 'c) BatBigarray.Genarray.t -> int -> int
= "caml_ba_dim"
external kind :
('a, 'b, 'c) BatBigarray.Genarray.t -> ('a, 'b) BatBigarray.kind
= "caml_ba_kind"
external layout :
('a, 'b, 'c) BatBigarray.Genarray.t -> 'c BatBigarray.layout
= "caml_ba_layout"
external get : ('a, 'b, 'c) BatBigarray.Genarray.t -> int array -> 'a
= "caml_ba_get_generic"
external set :
('a, 'b, 'c) BatBigarray.Genarray.t -> int array -> 'a -> unit
= "caml_ba_set_generic"
external sub_left :
('a, 'b, BatBigarray.c_layout) BatBigarray.Genarray.t ->
int -> int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Genarray.t
= "caml_ba_sub"
external sub_right :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Genarray.t ->
int ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Genarray.t
= "caml_ba_sub"
external slice_left :
('a, 'b, BatBigarray.c_layout) BatBigarray.Genarray.t ->
int array -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Genarray.t
= "caml_ba_slice"
external slice_right :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Genarray.t ->
int array ->
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Genarray.t
= "caml_ba_slice"
external blit :
('a, 'b, 'c) BatBigarray.Genarray.t ->
('a, 'b, 'c) BatBigarray.Genarray.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) BatBigarray.Genarray.t -> 'a -> unit
= "caml_ba_fill"
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
bool -> int array -> ('a, 'b, 'c) BatBigarray.Genarray.t
val iter : ('a -> unit) -> ('a, 'b, 'c) BatBigarray.Genarray.t -> unit
val iteri :
((int, [ `Read ]) BatArray.Cap.t -> 'a -> unit) ->
('a, 'b, 'c) BatBigarray.Genarray.t -> unit
val modify : ('a -> 'a) -> ('a, 'b, 'c) BatBigarray.Genarray.t -> unit
val modifyi :
((int, [ `Read ]) BatArray.Cap.t -> 'a -> 'a) ->
('a, 'b, 'c) BatBigarray.Genarray.t -> unit
val enum : ('a, 'b, 'c) BatBigarray.Genarray.t -> 'a BatEnum.t
val map :
('a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Genarray.t ->
('b, 'c, 'e) BatBigarray.Genarray.t
val mapi :
((int, [ `Read ]) BatArray.Cap.t -> 'a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Genarray.t ->
('b, 'c, 'e) BatBigarray.Genarray.t
end
module Array1 :
sig
type ('a, 'b, 'c) t = ('a, 'b, 'c) Bigarray.Array1.t
val create :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout -> int -> ('a, 'b, 'c) BatBigarray.Array1.t
val dim : ('a, 'b, 'c) BatBigarray.Array1.t -> int
external kind :
('a, 'b, 'c) BatBigarray.Array1.t -> ('a, 'b) BatBigarray.kind
= "caml_ba_kind"
external layout :
('a, 'b, 'c) BatBigarray.Array1.t -> 'c BatBigarray.layout
= "caml_ba_layout"
external get : ('a, 'b, 'c) BatBigarray.Array1.t -> int -> 'a
= "%caml_ba_ref_1"
external set : ('a, 'b, 'c) BatBigarray.Array1.t -> int -> 'a -> unit
= "%caml_ba_set_1"
external sub :
('a, 'b, 'c) BatBigarray.Array1.t ->
int -> int -> ('a, 'b, 'c) BatBigarray.Array1.t = "caml_ba_sub"
external blit :
('a, 'b, 'c) BatBigarray.Array1.t ->
('a, 'b, 'c) BatBigarray.Array1.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) BatBigarray.Array1.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
'a array -> ('a, 'b, 'c) BatBigarray.Array1.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
bool -> int -> ('a, 'b, 'c) BatBigarray.Array1.t
val enum : ('a, 'b, 'c) BatBigarray.Array1.t -> 'a BatEnum.t
val of_enum :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
'a BatEnum.t -> ('a, 'b, 'c) BatBigarray.Array1.t
val map :
('a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Array1.t ->
('b, 'c, 'e) BatBigarray.Array1.t
val mapi :
(int -> 'a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Array1.t ->
('b, 'c, 'e) BatBigarray.Array1.t
val modify : ('a -> 'a) -> ('a, 'b, 'c) BatBigarray.Array1.t -> unit
val modifyi :
(int -> 'a -> 'a) -> ('a, 'b, 'c) BatBigarray.Array1.t -> unit
val to_array : ('a, 'b, 'c) BatBigarray.Array1.t -> 'a array
external unsafe_get : ('a, 'b, 'c) BatBigarray.Array1.t -> int -> 'a
= "%caml_ba_unsafe_ref_1"
external unsafe_set :
('a, 'b, 'c) BatBigarray.Array1.t -> int -> 'a -> unit
= "%caml_ba_unsafe_set_1"
end
module Array2 :
sig
type ('a, 'b, 'c) t = ('a, 'b, 'c) Bigarray.Array2.t
val create :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
int -> int -> ('a, 'b, 'c) BatBigarray.Array2.t
val dim1 : ('a, 'b, 'c) BatBigarray.Array2.t -> int
val dim2 : ('a, 'b, 'c) BatBigarray.Array2.t -> int
external kind :
('a, 'b, 'c) BatBigarray.Array2.t -> ('a, 'b) BatBigarray.kind
= "caml_ba_kind"
external layout :
('a, 'b, 'c) BatBigarray.Array2.t -> 'c BatBigarray.layout
= "caml_ba_layout"
external get : ('a, 'b, 'c) BatBigarray.Array2.t -> int -> int -> 'a
= "%caml_ba_ref_2"
external set :
('a, 'b, 'c) BatBigarray.Array2.t -> int -> int -> 'a -> unit
= "%caml_ba_set_2"
external sub_left :
('a, 'b, BatBigarray.c_layout) BatBigarray.Array2.t ->
int -> int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Array2.t
= "caml_ba_sub"
external sub_right :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array2.t ->
int ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array2.t
= "caml_ba_sub"
val slice_left :
('a, 'b, BatBigarray.c_layout) BatBigarray.Array2.t ->
int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Array1.t
val slice_right :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array2.t ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array1.t
external blit :
('a, 'b, 'c) BatBigarray.Array2.t ->
('a, 'b, 'c) BatBigarray.Array2.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) BatBigarray.Array2.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
'a array array -> ('a, 'b, 'c) BatBigarray.Array2.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
bool -> int -> int -> ('a, 'b, 'c) BatBigarray.Array2.t
val enum : ('a, 'b, 'c) BatBigarray.Array2.t -> 'a BatEnum.t
val map :
('a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Array2.t ->
('b, 'c, 'e) BatBigarray.Array2.t
val mapij :
(int -> int -> 'a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Array2.t ->
('b, 'c, 'e) BatBigarray.Array2.t
val modify : ('a -> 'a) -> ('a, 'b, 'c) BatBigarray.Array2.t -> unit
val modifyij :
(int -> int -> 'a -> 'a) -> ('a, 'b, 'c) BatBigarray.Array2.t -> unit
val to_array : ('a, 'b, 'c) BatBigarray.Array2.t -> 'a array array
external unsafe_get :
('a, 'b, 'c) BatBigarray.Array2.t -> int -> int -> 'a
= "%caml_ba_unsafe_ref_2"
external unsafe_set :
('a, 'b, 'c) BatBigarray.Array2.t -> int -> int -> 'a -> unit
= "%caml_ba_unsafe_set_2"
end
module Array3 :
sig
type ('a, 'b, 'c) t = ('a, 'b, 'c) Bigarray.Array3.t
val create :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
int -> int -> int -> ('a, 'b, 'c) BatBigarray.Array3.t
val dim1 : ('a, 'b, 'c) BatBigarray.Array3.t -> int
val dim2 : ('a, 'b, 'c) BatBigarray.Array3.t -> int
val dim3 : ('a, 'b, 'c) BatBigarray.Array3.t -> int
external kind :
('a, 'b, 'c) BatBigarray.Array3.t -> ('a, 'b) BatBigarray.kind
= "caml_ba_kind"
external layout :
('a, 'b, 'c) BatBigarray.Array3.t -> 'c BatBigarray.layout
= "caml_ba_layout"
external get :
('a, 'b, 'c) BatBigarray.Array3.t -> int -> int -> int -> 'a
= "%caml_ba_ref_3"
external set :
('a, 'b, 'c) BatBigarray.Array3.t -> int -> int -> int -> 'a -> unit
= "%caml_ba_set_3"
external sub_left :
('a, 'b, BatBigarray.c_layout) BatBigarray.Array3.t ->
int -> int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Array3.t
= "caml_ba_sub"
external sub_right :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array3.t ->
int ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array3.t
= "caml_ba_sub"
val slice_left_1 :
('a, 'b, BatBigarray.c_layout) BatBigarray.Array3.t ->
int -> int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Array1.t
val slice_right_1 :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array3.t ->
int ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array1.t
val slice_left_2 :
('a, 'b, BatBigarray.c_layout) BatBigarray.Array3.t ->
int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Array2.t
val slice_right_2 :
('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array3.t ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array2.t
external blit :
('a, 'b, 'c) BatBigarray.Array3.t ->
('a, 'b, 'c) BatBigarray.Array3.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) BatBigarray.Array3.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
'a array array array -> ('a, 'b, 'c) BatBigarray.Array3.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
bool -> int -> int -> int -> ('a, 'b, 'c) BatBigarray.Array3.t
val enum : ('a, 'b, 'c) BatBigarray.Array3.t -> 'a BatEnum.t
val map :
('a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Array3.t ->
('b, 'c, 'e) BatBigarray.Array3.t
val mapijk :
(int -> int -> int -> 'a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) BatBigarray.Array3.t ->
('b, 'c, 'e) BatBigarray.Array3.t
val modify : ('a -> 'a) -> ('a, 'b, 'c) BatBigarray.Array3.t -> unit
val modifyijk :
(int -> int -> int -> 'a -> 'a) ->
('a, 'b, 'c) BatBigarray.Array3.t -> unit
val to_array :
('a, 'b, 'c) BatBigarray.Array3.t -> 'a array array array
external unsafe_get :
('a, 'b, 'c) BatBigarray.Array3.t -> int -> int -> int -> 'a
= "%caml_ba_unsafe_ref_3"
external unsafe_set :
('a, 'b, 'c) BatBigarray.Array3.t -> int -> int -> int -> 'a -> unit
= "%caml_ba_unsafe_set_3"
end
external genarray_of_array1 :
('a, 'b, 'c) BatBigarray.Array1.t -> ('a, 'b, 'c) BatBigarray.Genarray.t
= "%identity"
external genarray_of_array2 :
('a, 'b, 'c) BatBigarray.Array2.t -> ('a, 'b, 'c) BatBigarray.Genarray.t
= "%identity"
external genarray_of_array3 :
('a, 'b, 'c) BatBigarray.Array3.t -> ('a, 'b, 'c) BatBigarray.Genarray.t
= "%identity"
val array1_of_genarray :
('a, 'b, 'c) BatBigarray.Genarray.t -> ('a, 'b, 'c) BatBigarray.Array1.t
val array2_of_genarray :
('a, 'b, 'c) BatBigarray.Genarray.t -> ('a, 'b, 'c) BatBigarray.Array2.t
val array3_of_genarray :
('a, 'b, 'c) BatBigarray.Genarray.t -> ('a, 'b, 'c) BatBigarray.Array3.t
val reshape :
('a, 'b, 'c) BatBigarray.Genarray.t ->
int array -> ('a, 'b, 'c) BatBigarray.Genarray.t
val reshape_1 :
('a, 'b, 'c) BatBigarray.Genarray.t ->
int -> ('a, 'b, 'c) BatBigarray.Array1.t
val reshape_2 :
('a, 'b, 'c) BatBigarray.Genarray.t ->
int -> int -> ('a, 'b, 'c) BatBigarray.Array2.t
val reshape_3 :
('a, 'b, 'c) BatBigarray.Genarray.t ->
int -> int -> int -> ('a, 'b, 'c) BatBigarray.Array3.t
end`