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 = ('a, 'b, 'c) Bigarray.Array2.tThe type of two-dimensional big arrays whose elements have OCaml type 'a, representation kind 'b, and memory layout 'c.
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 -> intReturn the first dimension of the given two-dimensional big array.
val dim2 : ('a, 'b, 'c) t -> intReturn the second dimension of the given two-dimensional big array.
Array2.change_layout a layout returns a bigarray with the specified layout, sharing the data with a (and hence having the same dimensions as a). No copying of elements is involved: the new array and the original array share the same storage space. The dimensions are reversed, such that get v [| a; b |] in C layout becomes get v [| b+1; a+1 |] in Fortran layout.
val size_in_bytes : ('a, 'b, 'c) t -> intsize_in_bytes a is the number of elements in a multiplied by a's 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.
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, fortran_layout) t ->
int ->
int ->
('a, 'b, fortran_layout) tExtract 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.
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, fortran_layout) t ->
int ->
('a, 'b, fortran_layout) Array1.tExtract 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.
Copy the first big array to the second big array. See Bigarray.Genarray.blit for more details.
val fill : ('a, 'b, 'c) t -> 'a -> unitFill the given big array with the given value. See Bigarray.Genarray.fill for more details.
Build a two-dimensional big array initialized from the given array of arrays.
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) kind ->
'c layout ->
bool ->
int ->
int ->
('a, 'b, 'c) tMemory mapping of a file as a two-dimensional big array. See Bigarray.Genarray.map_file for more details.
enum 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) tSame as Bigarray.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 -> unitSame as Bigarray.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 arrayBuild a two-dimensional array initialized from the given big array.
In case of doubt, don't use them.
val unsafe_get : ('a, 'b, 'c) t -> int -> int -> 'aLike Bigarray.Array2.get, but bounds checking is not always performed.
val unsafe_set : ('a, 'b, 'c) t -> int -> int -> 'a -> unitLike Bigarray.Array2.set, but bounds checking is not always performed.