Array
ALIGN_AS
align_as(Integer i, Charstring t) -> Integer
STABLE
Align the offset i to the next multiple of type t.
ALIGN_TO
align_to(Integer i, Integer a) -> Integer
STABLE
Align the offset i to the next power-of-2 a.
ARANGE
arange(Integer u) -> Array of I64 -r
STABLE
Array of integers from 1 up to and including u
arange(Integer l, Integer u, Integer s) -> Array of I64 -r
STABLE
Array of integers from and including l up to and possibly including u
with step `s`
arange(Integer l, Integer u) -> Array of I64 -r
STABLE
Array of integers from and including l up to and including u
ARRAY
array(Charstring fmt, Array a) -> Array
STABLE
Make a copy of array a with format fmt
array(Charstring fmt, Vector data) -> Array
STABLE
Create array with format fmt having elements and shape determined by
vector `data`. An array with rank > 1 will be created when `data` is a
nested vector structure
array(Charstring fmt, Vector of Integer sh, Vector of Number data) -> Array
STABLE
Create array with format fmt, shape sh, and elements in data
array(Vector data) -> Array
STABLE
Create array with elements, format, and shape determined by
nested vectors in `data`, An array with rank > 1 will be created when
`data` is a nested vector structure
array(Charstring fmt, Vector of Integer shape, Array a) -> Array
STABLE
Make copy of array a with format fmt and shape sh
array(Charstring fmt, Vector of Integer shape, Number n) -> Array r
STABLE
Create array with format fmt, shape sh, and all elements set to n
ARRAYOF
arrayof(Charstring s) -> Array of I32 a
STABLE
No description.
ARRAY_REWRITER_FID
array_rewriter_fid(Array a, Integer fid)
STABLE
No description.
ARRAY_REWRITER_MEM
array_rewriter_mem(Array a, Memory m)
STABLE
No description.
ARRAY_REWRITER_SHAPE
array_rewriter_shape(Array a, Vector of Integer shape)
STABLE
No description.
ARRAY_VECTOR
array_vector(Array a) -> Vector
STABLE
Convert array a into a vector. A nested vector structure is created if
`rank(a)>1`
ASSERT_ARRAY_SHAPE
assert_array_shape(Array a, Vector of Integer shape)
STABLE
No description.
AS_ARRAY
as_array(Memory mem, Charstring format, Vector shape) -> Array
STABLE
Map array with format and shape to memory area mem
as_array(Array a, Charstring t) -> Array
STABLE
Access the Array a as if it had element type t.
as_array(Memory m, Charstring t) -> Array
STABLE
Access Memory m as if it were an Array of t.
as_array(Array a, Charstring typ, Integer p) -> Array
STABLE
Access Array a as an Array of typ starting at element p.
as_array(Memory m, Charstring typ, Integer p) -> Array
STABLE
Access Memory m as an Array of typ starting at element p.
AS_ELEMENT_TYPE
as_element_type(Array a, Number n) -> Number
STABLE
Cast type of object o to be that of elements in array a
AVG
avg(Array a) -> Real
STABLE
The average value of the elements in array a
CHARSTRINGOF
charstringof(Array of I32 a) -> Charstring s
STABLE
No description.
COPY_ARRAY
copy_array(Array src) -> Array dst2
STABLE
No description.
copy_array(Array a, Charstring typ, Integer p) -> Array
STABLE
Create copy of a as an Array of typ starting at byte offset p.
This is needed when the data is not aligned to its element type size.
copy_array(Memory m, Charstring typ, Integer p) -> Array
STABLE
Create copy of Memory m as an Array of typ starting at byte offset p.
This is needed when the data is not aligned to its element type size.
DATA
data(Array a) -> Memory
STABLE
The contents of array a represented as a Memory object
DIM
dim(Array a) -> Integer
STABLE
The total number of elements in array a
DIV
div(Array a, Real x) -> Array of F64 r
STABLE
Divide the elements in array a with x
div(Array of F32 a, Real x) -> Array of F32 r
STABLE
Divide the elements in array a with x
div(Real lambda, Array a) -> Array of F64 r
STABLE
Compute lambda/e for all elements e in array a
DOT
dot(Array of F32 x, Array of F32 y) -> Real
STABLE
No description.
dot(Array of F64 x, Array of F64 y) -> Real
STABLE
No description.
dot(Array of I32 x, Array of I32 y) -> Integer
STABLE
No description.
dot(Array of I64 x, Array of I64 y) -> Integer
STABLE
No description.
dot(Array u, Array v) -> Number r
STABLE
The dot product of the elements in arrays u and v
ELEMDIV
elemdiv(Array of F32 a, Array of F32 b) -> Array of F32
STABLE
No description.
elemdiv(Array a, Array b) -> Array of F64
STABLE
Divide of elements in array a with elements in array b one by one
elemdiv(Array of F64 a, Array of F64 b) -> Array of F64
STABLE
No description.
ELEMENT_SIZE
element_size(Array a) -> Integer
STABLE
The number of bytes to represent an element in array a
element_size(Charstring t) -> Integer
STABLE
Get the size in bytes of element type t.
ELEMTIMES
elemtimes(Array of F64 a, Array of F64 b) -> Array of F64
STABLE
No description.
elemtimes(Array a, Array b) -> Array
STABLE
Multiply elements in array a and b one by one
ELEMTIMES2
elemtimes2(Array of F32 a, Array of F32 b) -> Array of F32
STABLE
No description.
EUCLID
euclid(Vector a, Array b) -> Real
STABLE
No description.
euclid(Array a, Vector b) -> Real
STABLE
No description.
EXP
exp(Array a) -> Array r
STABLE
Compute for all elements in array a
EXTRACT_RECT
extract_rect(Array a, Integer top, Integer left, Vector of Integer dimensions) -> Array
STABLE
No description.
extract_rect(Array a, Integer top, Integer left, Integer h, Integer w) -> Array out
STABLE
No description.
FLATTEN
flatten(Array a) -> Array
STABLE
Make 1D array of elements in array a
FORMAT
format(Array a) -> Charstring
STABLE
The data format of elements in array a as string, e.g., "U8" or "F32"
IN
in(Array a) -> Bag of Number
STABLE
The bag of elements in array a
IRFFT
irfft(Array of F64 a) -> Array of F64
STABLE
The inverse real fast Fourier transform (FFT) of array a
LENGTH
length(Array a, Integer d) -> Integer
STABLE
The length of dimension d in array a
LOAD_ARRAY
load_array(Charstring file) -> Array
STABLE
No description.
MAP_INTO_ARRAY
map_into_array(Array src, Integer aidx, Integer size) -> Array sub2
STABLE
No description.
map_into_array(Array src, Integer aidx, Vector of Integer shape, Integer c) -> Array sub2
STABLE
No description.
map_into_array(Array src, Integer aidx, Vector of Integer shape) -> Array sub2
STABLE
No description.
MATMUL
matmul(Array a, Array b) -> Array
STABLE
Matrix multiplication converting a and b to single precision
arrays of real numbers if necessary
matmul(Array of F32 a, Array of F32 b) -> Array of F32 out
STABLE
Matrix multiplication of 2D arrays a and b
MEAN
mean(Array a) -> Real
DEPRECATED
No description.
This was deprecated in version 6.0.0.
Use avg(a) instead
MEMORY_REWRITER_SIZE
memory_rewriter_size(Memory m, Integer size)
STABLE
No description.
MINUS
minus(Number lambda, Array a) -> Array r
STABLE
Compute lambda-e from all elements e in array a
minus(Array a, Number lambda) -> Array r
STABLE
Subtract lambda from all elements in array a
minus(Array of F32 a, Array of F32 b) -> Array of F32
STABLE
No description.
minus(Array of I32 a, Array of I32 b) -> Array of I32
STABLE
No description.
minus(Array of F64 a, Array of F64 b) -> Array of F64
STABLE
No description.
minus(Array a, Array b) -> Array
STABLE
Subtract elements in array b from elements in array a one by one
minus(Array of I64 a, Array of I64 b) -> Array of I64
STABLE
No description.
NEW_ARRAY
new_array(Charstring format, Vector of Integer shape) -> Array
STABLE
Create array.
Parameters:
format - The data format (e.g., "U8" or "F32")
shape - The shape of the array (e.g., for arrays representing
RGB images the shape is [h,w,3])
new_array(Charstring fmt, Integer dim) -> Array
STABLE
Create new 1D array with dim elements of format fmt
NEW_ARRAY_FROM_TEMPLATE
new_array_from_template(Array a) -> Array
STABLE
No description.
new_array_from_template(Charstring format, Array a) -> Array
STABLE
No description.
PLUS
plus(Number lambda, Array a) -> Array
STABLE
Add lambda to all elements in array a
plus(Array a, Number lambda) -> Array r
STABLE
Add lambda to all elements in array a
plus(Array of F64 a, Array of F64 b) -> Array of F64
STABLE
No description.
plus(Array of F32 a, Array of F32 b) -> Array of F32
STABLE
No description.
plus(Array of I64 a, Array of I64 b) -> Array of I64
STABLE
No description.
plus(Array of I32 a, Array of I32 b) -> Array of I32
STABLE
No description.
plus(Array a, Array b) -> Array
STABLE
Add elements in array a and b one by one
RANK
rank(Array a) -> Integer
STABLE
The number of dimensions in array a
REDUCE
reduce(Array a, Function f) -> Number
STABLE
The reduced value of array a by reductor function f with first
element in `a` as start value
RESHAPE
reshape(Array a, Vector shape) -> Array
STABLE
Change shape of array a to shape. The total number of elements must
match the new shape
RFFT
rfft(Array of F64 a) -> Array of F64 r
STABLE
The real fast Fourier transform (FFT) of array a
ROUNDTO
roundto(Array a, Integer d) -> Array of F64 r
STABLE
Round elements of array a to d decimals
ROW_REDUCE
row_reduce(Array a, Function fn, Array initial) -> Object agg
STABLE
No description.
row_reduce(Array a, Function fn, Array initial, Object a1, Object a2) -> Object agg
STABLE
No description.
row_reduce(Array a, Function fn, Array initial, Object a1) -> Object agg
STABLE
No description.
row_reduce(Array a, Function fn, Array initial, Object a1, Object a2, Object a3) -> Object agg
STABLE
No description.
ROW_REDUCE_WITH_INDEX
row_reduce_with_index(Array a, Function fn, Array initial) -> Object agg
STABLE
No description.
row_reduce_with_index(Array a, Function fn, Array initial, Object a1, Object a2) -> Object agg
STABLE
No description.
row_reduce_with_index(Array a, Function fn, Array initial, Object a1) -> Object agg
STABLE
No description.
row_reduce_with_index(Array a, Function fn, Array initial, Object a1, Object a2, Object a3) -> Object agg
STABLE
No description.
SAVE_ARRAY
save_array(Array a, Charstring file) -> Charstring
STABLE
No description.
SETF
setf(Array a, Integer i, Number v)
STABLE
Set element i in array a to v
SHAPE
shape(Array a) -> Vector of Integer
STABLE
The shape of array a as a vector, e.g., [h,w,c]
SIGNIF
signif(Array a, Integer d) -> Array of F64 r
STABLE
Round elements of array a to d significant digits
SLICE
slice(Integer start, Integer len) -> Array of I64 -r
STABLE
Array of integers from 1 up to and including u
SQRT
sqrt(Array of F32 x) -> Array of F32
STABLE
No description.
sqrt(Array of F64 x) -> Array of F64
STABLE
No description.
sqrt(Array of I32 x) -> Array of F32
STABLE
No description.
sqrt(Array of I64 x) -> Array of F32
STABLE
No description.
sqrt(Array a) -> Array
STABLE
The square roots of the elements in array a
SQUARE
square(Array of F64 x) -> Array of F64
STABLE
No description.
square(Array of I64 x) -> Array of I64
STABLE
No description.
square(Array of F32 x) -> Array of F32
STABLE
No description.
square(Array a) -> Array
STABLE
The power of two of the elements in array a
square(Array of I32 x) -> Array of I32
STABLE
No description.
STDEV
stdev(Array a) -> Real
STABLE
The standard deviation of the elements in array a
SUM
sum(Array of F32 x) -> Real
STABLE
No description.
sum(Array of I32 x) -> Integer
STABLE
No description.
sum(Array of F64 x) -> Real
STABLE
No description.
sum(Array a) -> Number
STABLE
The sum of the elements in array a
TIMES
times(Array a, Number lambda) -> Array r
STABLE
Multiply all elements in array a with lambsa
times(Number lambda, Array a) -> Array
STABLE
Multiply all elements in array a with lambda
UMINUS
uminus(Array a) -> Array
STABLE
Negate the elements in array a
VREF
vref(Array a, Integer i) -> Number
STABLE
Same as a[i]
VVREF
vvref(Array a, Vector of Integer i) -> Number
STABLE
Bounds checked generic multi-dimensional array element access
WHENNULL
whennull(Array a, Number default) -> Array
STABLE
Replace all null values in array a with default
WHENZERO
whenzero(Array a, Number default) -> Array r
STABLE
Replace all zeros in array a with default