module Array2:sig..end
Array2 structure provides operations
similar to those of Bigarray.Genarray, but specialized to the
case of two-dimensional arrays.type('a, 'b, 'c)t =('a, 'b, 'c) Bigarray.Array2.t
'a, representation kind 'b, and memory layout 'c.val create : ('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout -> int -> int -> ('a, 'b, 'c) tArray2.create kind layout dim1 dim2 returns a new bigarray of
two dimension, whose size is dim1 in the first dimension
and dim2 in the second dimension. kind and layout
determine the array element kind and the array layout
as described for Bigarray.Genarray.create.val dim1 : ('a, 'b, 'c) t -> intval dim2 : ('a, 'b, 'c) t -> intval kind : ('a, 'b, 'c) t -> ('a, 'b) BatBigarray.kindval layout : ('a, 'b, 'c) t -> 'c BatBigarray.layoutval size_in_bytes : ('a, 'b, 'c) t -> intsize_in_bytes a is the number of elements in a multiplied
by a's BatBigarray.kind_size_in_bytes.val get : ('a, 'b, 'c) t -> int -> int -> 'aArray2.get a x y, also written a.{x,y},
returns the element of a at coordinates (x, y).
x and y must be within the bounds
of a, as described for Bigarray.Genarray.get;Invalid_argument otherwise.val set : ('a, 'b, 'c) t -> int -> int -> 'a -> unitArray2.set a x y v, or alternatively a.{x,y} <- v,
stores the value v at coordinates (x, y) in a.
x and y must be within the bounds of a,
as described for Bigarray.Genarray.set;Invalid_argument otherwise.val sub_left : ('a, 'b, BatBigarray.c_layout) t ->
int -> int -> ('a, 'b, BatBigarray.c_layout) tBigarray.Genarray.sub_left for more details.
Array2.sub_left applies only to arrays with C layout.val sub_right : ('a, 'b, BatBigarray.fortran_layout) t ->
int -> int -> ('a, 'b, BatBigarray.fortran_layout) tBigarray.Genarray.sub_right for more details.
Array2.sub_right applies only to arrays with Fortran layout.val slice_left : ('a, 'b, BatBigarray.c_layout) t ->
int -> ('a, 'b, BatBigarray.c_layout) BatBigarray.Array1.tBigarray.Genarray.slice_left for more details.
Array2.slice_left applies only to arrays with C layout.val slice_right : ('a, 'b, BatBigarray.fortran_layout) t ->
int -> ('a, 'b, BatBigarray.fortran_layout) BatBigarray.Array1.tBigarray.Genarray.slice_right
for more details. Array2.slice_right applies only to arrays
with Fortran layout.val blit : ('a, 'b, 'c) t ->
('a, 'b, 'c) t -> unitBigarray.Genarray.blit for more details.val fill : ('a, 'b, 'c) t -> 'a -> unitBigarray.Genarray.fill for more details.val of_array : ('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout -> 'a array array -> ('a, 'b, 'c) tval map_file : Unix.file_descr ->
?pos:int64 ->
('a, 'b) BatBigarray.kind ->
'c BatBigarray.layout ->
bool -> int -> int -> ('a, 'b, 'c) tBigarray.Genarray.map_file for more details.val enum : ('a, 'b, 'c) t -> 'a BatEnum.tenum e returns an enumeration on the elements of e.
The order of enumeration is unspecified.val map : ('a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) t -> ('b, 'c, 'e) tArray2.map f a applies function f to all the elements of a,
and builds a Bigarray.Array2.t with the results returned by f.val mapij : (int -> int -> 'a -> 'b) ->
('b, 'c) Bigarray.kind ->
('a, 'd, 'e) t -> ('b, 'c, 'e) tBigarray.Array2.map, but the
function is applied to the index of the element as the first two
arguments, and the element itself as the third argument.val modify : ('a -> 'a) -> ('a, 'b, 'c) t -> unitmodify f a changes each element x in a to f x
in-place.val modifyij : (int -> int -> 'a -> 'a) -> ('a, 'b, 'c) t -> unitBigarray.Array2.modify, but the function is applied
to the index of the element as the first two arguments, and the
element itself as the third argument.val to_array : ('a, 'b, 'c) t -> 'a array array
In case of doubt, don't use them.
val unsafe_get : ('a, 'b, 'c) t -> int -> int -> 'aBigarray.Array2.get, but bounds checking is not always
performed.val unsafe_set : ('a, 'b, 'c) t -> int -> int -> 'a -> unitBigarray.Array2.set, but bounds checking is not always
performed.