module Array2: sig .. end
Two-dimensional arrays. The
Array2 structure provides operations
similar to those of
Bigarray.Genarray, but specialized to the
case of two-dimensional arrays.
type ('a, 'b, 'c) t
The type of two-dimensional big arrays whose elements have
OCaml type 'a, representation kind 'b, and memory layout 'c.
val create : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> int -> ('a, 'b, 'c) t
Array2.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 -> int
Return the first dimension of the given two-dimensional big array.
val dim2 : ('a, 'b, 'c) t -> int
Return the second dimension of the given two-dimensional big array.
val kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kind
Return the kind of the given big array.
val layout : ('a, 'b, 'c) t -> 'c Bigarray.layout
Return the layout of the given big array.
val get : ('a, 'b, 'c) t -> int -> int -> 'a
Array2.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;
otherwise,
Invalid_argument is raised.
val set : ('a, 'b, 'c) t -> int -> int -> 'a -> unit
Array2.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;
otherwise,
Invalid_argument is raised.
val sub_left : ('a, 'b, Bigarray.c_layout) t ->
int -> int -> ('a, 'b, Bigarray.c_layout) t
Extract a two-dimensional sub-array of the given two-dimensional
big array by restricting the first dimension.
See
Bigarray.Genarray.sub_left for more details.
Array2.sub_left applies only to arrays with C layout.
val sub_right : ('a, 'b, Bigarray.fortran_layout) t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) t
Extract a two-dimensional sub-array of the given two-dimensional
big array by restricting the second dimension.
See
Bigarray.Genarray.sub_right for more details.
Array2.sub_right applies only to arrays with Fortran layout.
val slice_left : ('a, 'b, Bigarray.c_layout) t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t
Extract a row (one-dimensional slice) of the given two-dimensional
big array. The integer parameter is the index of the row to
extract. See
Bigarray.Genarray.slice_left for more details.
Array2.slice_left applies only to arrays with C layout.
val slice_right : ('a, 'b, Bigarray.fortran_layout) t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.t
Extract a column (one-dimensional slice) of the given
two-dimensional big array. The integer parameter is the
index of the column to extract. See
Bigarray.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 -> unit
val fill : ('a, 'b, 'c) t -> 'a -> unit
val of_array : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array array -> ('a, 'b, 'c) t
Build a two-dimensional big array initialized from the
given array of arrays.
val map_file : Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> bool -> int -> int -> ('a, 'b, 'c) t
val unsafe_get : ('a, 'b, 'c) t -> int -> int -> 'a
val unsafe_set : ('a, 'b, 'c) t -> int -> int -> 'a -> unit