Module Float.Array
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 ...
))typet`` = floatarray
The type of float arrays with packed representation.
- since 4.08.0
vallength :t->int
Return the length (number of elements) of the given floatarray.
valget :t->``int->float
get a n returns the element number n of floatarray a.
-
raises Invalid_argument
if
nis outside the range 0 to(length a - 1).
valset :t->``int->``float->unit
set a n x modifies floatarray a in place, replacing element number
n with x.
-
raises Invalid_argument
if
nis outside the range 0 to(length a - 1).
valmake : ``int->``float->t
make n x returns a fresh floatarray of length n, initialized with
x.
-
raises Invalid_argument
if
n < 0orn > Sys.max_floatarray_length.
valcreate : ``int->t
create n returns a fresh floatarray of length n, with uninitialized
data.
-
raises Invalid_argument
if
n < 0orn > Sys.max_floatarray_length.
valinit : ``int->``(``int->float)``->t
init n f returns a fresh floatarray of length n, with element number
i initialized to the result of f i. In other terms, init n f
tabulates the results of f applied to the integers 0 to n-1.
-
raises Invalid_argument
if
n < 0orn > Sys.max_floatarray_length.
append v1 v2 returns a fresh floatarray containing the concatenation
of the floatarrays v1 and v2.
-
raises Invalid_argument
if
length v1 + length v2 > Sys.max_floatarray_length.
sub a pos len returns a fresh floatarray of length len, containing
the elements number pos to pos + len - 1 of floatarray a.
-
raises Invalid_argument
if
posandlendo not designate a valid subarray ofa; that is, ifpos < 0, orlen < 0, orpos + len > length a.
copy a returns a copy of a, that is, a fresh floatarray containing
the same elements as a.
valfill :t->``int->``int->``float->unit
fill a pos len x modifies the floatarray a in place, storing x in
elements number pos to pos + len - 1.
-
raises Invalid_argument
if
posandlendo not designate a valid subarray ofa.
blit src src_pos dst dst_pos len copies len elements from floatarray
src, starting at element number src_pos, to floatarray dst,
starting at element number dst_pos. It works correctly even if src
and dst are the same floatarray, and the source and destination chunks
overlap.
-
raises Invalid_argument
if
src_posandlendo not designate a valid subarray ofsrc, or ifdst_posandlendo not designate a valid subarray ofdst.
valto_list :t->``float list
to_list a returns the list of all the elements of a.
valof_list : ``float list``->t
of_list l returns a fresh floatarray containing the elements of l.
-
raises Invalid_argument
if the length of
lis greater thanSys.max_floatarray_length.
Iterators
valiter : ``(``float->unit)``->t->unit
iter f a applies function f in turn to all the elements of a. It
is equivalent to f a.(0); f a.(1); ...; f a.(length a - 1); ().
valiteri : ``(``int->``float->unit)``->t->unit
Same as iter, but the function is applied with the index
of the element as first argument, and the element itself as second
argument.
map f a applies function f to all the elements of a, and builds a
floatarray with the results returned by f.
Same as map, but the function is applied to the index of
the element as first argument, and the element itself as second
argument.
valfold_left : ``('a->``float->'a)``->'a->t->'a
fold_left f x init computes
f (... (f (f x init.(0)) init.(1)) ...) init.(n-1), where n is the
length of the floatarray init.
valfold_right : ``(``float->'a->'a)``->t->'a->'a
fold_right f a init computes
f a.(0) (f a.(1) ( ... (f a.(n-1) init) ...)), where n is the length
of the floatarray a.
Iterators on two arrays
Array.iter2 f a b applies function f to all the elements of a and
b.
-
raises Invalid_argument
if the floatarrays are not the same size.
map2 f a b applies function f to all the elements of a and b,
and builds a floatarray with the results returned by f:
[| f a.(0) b.(0); ...; f a.(length a - 1) b.(length b - 1)|].
-
raises Invalid_argument
if the floatarrays are not the same size.
Array scanning
valfor_all : ``(``float->bool)``->t->bool
for_all f [|a1; ...; an|] checks if all elements of the floatarray
satisfy the predicate f. That is, it returns
(f a1) && (f a2) && ... && (f an).
valexists : ``(``float->bool)``->t->bool
exists f [|a1; ...; an|] checks if at least one element of the
floatarray satisfies the predicate f. That is, it returns
(f a1) || (f a2) || ... || (f an).
valmem : ``float->t->bool
mem a set is true if and only if there is an element of set that is
structurally equal to a, i.e. there is an x in set such that
compare a x = 0.
valmem_ieee : ``float->t->bool
Same as mem, but uses IEEE equality instead of structural
equality.
Sorting
valsort : ``(``float->``float->int)``->t->unit
Sort a floatarray in increasing order according to a comparison
function. The comparison function must return 0 if its arguments compare
as equal, a positive integer if the first is greater, and a negative
integer if the first is smaller (see below for a complete
specification). For example, Stdlib.compare
is a suitable comparison function. After calling sort, the array is
sorted in place in increasing order. sort is guaranteed to run in
constant heap space and (at most) logarithmic stack space.
The current implementation uses Heap Sort. It runs in constant stack space.
Specification of the comparison function: Let a be the floatarray and
cmp the comparison function. The following must be true for all x,
y, z in a :
cmp x y> 0 if and only ifcmp y x< 0- if
cmp x y>= 0 andcmp y z>= 0 thencmp x z>= 0
When sort returns, a contains the same elements as before, reordered
in such a way that for all i and j valid indices of a :
cmp a.(i) a.(j)>= 0 if and only if i >= j
valstable_sort : ``(``float->``float->int)``->t->unit
Same as sort, but the sorting algorithm is stable (i.e.
elements that compare equal are kept in their original order) and not
guaranteed to run in constant heap space.
The current implementation uses Merge Sort. It uses a temporary
floatarray of length n/2, where n is the length of the floatarray.
It is usually faster than the current implementation of
sort.
valfast_sort : ``(``float->``float->int)``->t->unit
Same as sort or stable_sort,
whichever is faster on typical input.
Float arrays and Sequences
Iterate on the floatarray, in increasing order. Modifications of the floatarray during iteration will be reflected in the sequence.
Iterate on the floatarray, in increasing order, yielding indices along elements. Modifications of the floatarray during iteration will be reflected in the sequence.
valmap_to_array : ``(``float->'a)``->t->'aarray
map_to_array f a applies function f to all the elements of a, and
builds an array with the results returned by f:
[| f a.(0); f a.(1); ...; f a.(length a - 1) |].
valmap_from_array : ``('a->float)``->'aarray``->t
map_from_array f a applies function f to all the elements of a,
and builds a floatarray with the results returned by f.
