Module Bigarray.Array3
Contents
Instructions: Use this module in your project
In the IDE (CLion, Visual Studio Code, Xcode, etc.) you use for your DkSDK project:
Add the following to your project's
dependencies/CMakeLists.txt:DkSDKProject_DeclareAvailable(ocaml CONSTRAINT "= 4.14.0" FINDLIBS str unix runtime_events threads dynlink) DkSDKProject_MakeAvailable(ocaml)Add the
Findlib::ocamllibrary to any desired targets insrc/*/CMakeLists.txt:target_link_libraries(YourPackage_YourLibraryName # ... existing libraries, if any ... Findlib::ocaml)Click your IDE's
Buildbutton
Not using DkSDK?
FIRST, do one or all of the following:
Run:
opam install ocaml.4.14.0Edit your
dune-projectand add:(package (name YourExistingPackage) (depends ; ... existing dependenices ... (ocaml (>= 4.14.0))))Then run:
dune build *.opam # if this fails, run: dune buildEdit your
<package>.opamfile and add:depends: [ # ... existing dependencies ... "ocaml" {>= "4.14.0"} ]Then run:
opam install . --deps-only
FINALLY, add the library to any desired (library)and/or (executable) targets in your **/dune files:
(library
(name YourLibrary)
; ... existing library options ...
(libraries
; ... existing libraries ...
))
(executable
(name YourExecutable)
; ... existing executable options ...
(libraries
; ... existing libraries ...
))type``(!'a, !'b, !'c) t
The type of three-dimensional Bigarrays whose elements have OCaml type
'a, representation kind 'b, and memory layout 'c.
Array3.create kind layout dim1 dim2 dim3 returns a new Bigarray of
three dimensions, whose size is dim1 in the first dimension, dim2 in
the second dimension, and dim3 in the third. kind and layout
determine the array element kind and the array layout as described for
Bigarray.Genarray.create.
valinit : ``('a,'b)``kind->'clayout->``int->``int->``int->``(``int->``int->``int->'a)``->``('a,'b,'c)``t
Array3.init kind layout dim1 dim2 dim3 f returns a new Bigarray b of
three dimensions, whose size is dim1 in the first dimension, dim2 in
the second dimension, and dim3 in the third. kind and layout
determine the array element kind and the array layout as described for
Bigarray.Genarray.create.
Each element Array3.get b i j k of the array is initialized to the
result of f i j k.
In other words, Array3.init kind layout dim1 dim2 dim3 f tabulates the
results of f applied to the indices of a new Bigarray whose layout is
described by kind, layout, dim1, dim2 and dim3.
- since 4.12.0
valdim1 : ``('a,'b,'c)``t->int
Return the first dimension of the given three-dimensional Bigarray.
valdim2 : ``('a,'b,'c)``t->int
Return the second dimension of the given three-dimensional Bigarray.
valdim3 : ``('a,'b,'c)``t->int
Return the third dimension of the given three-dimensional Bigarray.
Array3.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; c |] in C layout becomes
get v [| c+1; b+1; a+1 |] in Fortran layout.
- since 4.06.0
valsize_in_bytes : ``('a,'b,'c)``t->int
size_in_bytes a is the number of elements in a multiplied by a's
kind_size_in_bytes.
- since 4.03.0
valget : ``('a,'b,'c)``t->``int->``int->``int->'a
Array3.get a x y z, also written a.{x,y,z}, returns the element of
a at coordinates (x, y, z). x, y and z must be within the
bounds of a, as described for
Bigarray.Genarray.get;
otherwise, Invalid_argument is raised.
valset : ``('a,'b,'c)``t->``int->``int->``int->'a->unit
Array3.set a x y v, or alternatively a.{x,y,z} <- v, stores the
value v at coordinates (x, y, z) in a. x, y and z must
be within the bounds of a, as described for
Bigarray.Genarray.set;
otherwise, Invalid_argument is raised.
Extract a three-dimensional sub-array of the given three-dimensional
Bigarray by restricting the first dimension. See
Bigarray.Genarray.sub_left
for more details. Array3.sub_left applies only to arrays with C
layout.
valsub_right : ``('a,'b,fortran_layout)``t->``int->``int->``('a,'b,fortran_layout)``t
Extract a three-dimensional sub-array of the given three-dimensional
Bigarray by restricting the second dimension. See
Bigarray.Genarray.sub_right
for more details. Array3.sub_right applies only to arrays with Fortran
layout.
Extract a one-dimensional slice of the given three-dimensional Bigarray
by fixing the first two coordinates. The integer parameters are the
coordinates of the slice to extract. See
Bigarray.Genarray.slice_left
for more details. Array3.slice_left_1 applies only to arrays with C
layout.
valslice_right_1 : ``('a,'b,fortran_layout)``t->``int->``int->``('a,'b,fortran_layout)``Array1.t
Extract a one-dimensional slice of the given three-dimensional Bigarray
by fixing the last two coordinates. The integer parameters are the
coordinates of the slice to extract. See
Bigarray.Genarray.slice_right
for more details. Array3.slice_right_1 applies only to arrays with
Fortran layout.
Extract a two-dimensional slice of the given three-dimensional Bigarray
by fixing the first coordinate. The integer parameter is the first
coordinate of the slice to extract. See
Bigarray.Genarray.slice_left
for more details. Array3.slice_left_2 applies only to arrays with C
layout.
valslice_right_2 : ``('a,'b,fortran_layout)``t->``int->``('a,'b,fortran_layout)``Array2.t
Extract a two-dimensional slice of the given three-dimensional Bigarray
by fixing the last coordinate. The integer parameter is the coordinate
of the slice to extract. See
Bigarray.Genarray.slice_right
for more details. Array3.slice_right_2 applies only to arrays with
Fortran layout.
Copy the first Bigarray to the second Bigarray. See
Bigarray.Genarray.blit for
more details.
valfill : ``('a,'b,'c)``t->'a->unit
Fill the given Bigarray with the given value. See
Bigarray.Genarray.fill for
more details.
Build a three-dimensional Bigarray initialized from the given array of arrays of arrays.
valunsafe_get : ``('a,'b,'c)``t->``int->``int->``int->'a
Like Bigarray.Array3.get, but bounds checking is not
always performed.
valunsafe_set : ``('a,'b,'c)``t->``int->``int->``int->'a->unit
Like Bigarray.Array3.set, but bounds checking is not
always performed.
