Index of values

_check_transpose_axis a d checks whether a is a legiti('a, 'b) te transpose index.

abs x returns a new matrix where each element has the absolute value of that in the original matrix x.

abs x returns the absolute value of all elements in x in a new ndarray.

abs x returns the absolute value of all elements in x in a new matrix.

abs2 x returns the square of absolute value of all elements in x in a new ndarray.

abs2 x returns the square of absolute value of all elements in x in a new ndarray.

abs2_c2s x is similar to abs2 but takes complex32 as input.

abs2_c2s x is similar to abs2 but takes complex32 as input.

abs2_z2d x is similar to abs2 but takes complex64 as input.

abs2_z2d x is similar to abs2 but takes complex64 as input.

abs_c2s x is similar to abs but takes complex32 as input.

abs_c2s x is similar to abs but takes complex32 as input.

abs_z2d x is similar to abs but takes complex64 as input.

abs_z2d x is similar to abs but takes complex64 as input.

acos x computes the arc cosine of the elements in x and returns the result in a new ndarray.

acos x computes the arc cosine of the elements in x and returns the result in a new matrix.

acosh x computes the hyperbolic arc cosine of the elements in x and returns the result in a new ndarray.

acosh x computes the hyperbolic arc cosine of the elements in x and returns the result in a new matrix.

add x y adds two matrices x and y.

add x y adds all the elements in x and y elementwise, and returns the result in a new ndarray.

add x y adds all the elements in x and y elementwise, and returns the result in a new matrix.

add_scalar x a adds a scalar value a to all the elements in x, and returns the result in a new ndarray.

add_scalar x a adds a scalar value a to all the elements in x, and returns the result in a new matrix.

approx_elt_equal ~eps x y compares the element-wise equality of x and y, then returns another binary (i.e., 0 and 1) ndarray/matrix wherein 1 indicates that two corresponding elements a from x and b from y are considered as approximately equal, namely abs (a - b) < eps.

approx_elt_equal ~eps x y compares the element-wise equality of x and y, then returns another binary (i.e., 0 and 1) ndarray/matrix wherein 1 indicates that two corresponding elements a from x and b from y are considered as approximately equal, namely abs (a - b) < eps.

approx_elt_equal_scalar ~eps x a compares all the elements of x to a scalar value a, then returns another binary (i.e., 0 and 1) ndarray/matrix wherein 1 indicates that the element b from x is considered as approximately equal to a, namely abs (a - b) < eps.

approx_elt_equal_scalar ~eps x a compares all the elements of x to a scalar value a, then returns another binary (i.e., 0 and 1) ndarray/matrix wherein 1 indicates that the element b from x is considered as approximately equal to a, namely abs (a - b) < eps.

approx_equal ~eps x y returns true if x and y are approximately equal, i.e., for any two elements a from x and b from y, we have abs (a - b) < eps.

approx_equal ~eps x y returns true if x and y are approximately equal, i.e., for any two elements a from x and b from y, we have abs (a - b) < eps.

approx_equal_scalar ~eps x a returns true all the elements in x are approximately equal to a, i.e., abs (x - a) < eps.

approx_equal_scalar ~eps x a returns true all the elements in x are approximately equal to a, i.e., abs (x - a) < eps.

asin x computes the arc sine of the elements in x and returns the result in a new ndarray.

asin x computes the arc sine of the elements in x and returns the result in a new matrix.

asinh x computes the hyperbolic arc sine of the elements in x and returns the result in a new ndarray.

asinh x computes the hyperbolic arc sine of the elements in x and returns the result in a new matrix.

atan x computes the arc tangent of the elements in x and returns the result in a new ndarray.

atan x computes the arc tangent of the elements in x and returns the result in a new matrix.

atan2 x y computes atan2(a, b) of all the elements in x and y elementwise, and returns the result in a new ndarray.

atan2 x y computes atan2(a, b) of all the elements in x and y elementwise, and returns the result in a new matrix.

scalar_atan2 x a

scalar_atan2 x a

atanh x computes the hyperbolic arc tangent of the elements in x and returns the result in a new ndarray.

atanh x computes the hyperbolic arc tangent of the elements in x and returns the result in a new matrix.

average x returns the average value of all the elements in x.

average x returns the average value of all the elements in x.

average_cols x returns the average value of all column vectors in x.

average_cols x returns the average value of all column vectors in x.

average_rows x returns the average value of all row vectors in x.

average_rows x returns the average value of all row vectors in x.

[]

[]

[]

[]

[]

bernoulli k ~p:0.3 [|2;3;4|]

bernoulli k ~p:0.3 m n

bidiagonal upper dv ev creates a bidiagonal matrix using dv and ev.

binary m n creates an m by n random matrix where 10% ~ 15% elements are 1.

bivariate_gaussian x y sigma_x sigma_y rho returns the probability density p(x,y) at (x,y) for a bivariate Gaussian distribution with standard deviations sigma_x, sigma_y and correlation coefficient rho.

bivariate_gaussian sigma_x sigma_y rho returns a pair of correlated gaussian variates, with mean zero, correlation coefficient rho -1, 1 and standard deviations sigma_x and sigma_y in the x and y directions.

[]

[]

cast_c2z x casts x from complex32 to complex64.

cast_c2z x casts x from complex32 to complex64.

cast_d2c x casts x from float64 to complex32.

cast_d2c x casts x from float64 to complex32.

cast_d2s x casts x from float64 to float32.

cast_d2s x casts x from float64 to float32.

cast_d2z x casts x from float64 to complex64.

cast_d2z x casts x from float64 to complex64.

cast_s2c x casts x from float32 to complex32.

cast_s2c x casts x from float32 to complex32.

cast_s2d x casts x from float32 to float64.

cast_s2d x casts x from float32 to float64.

cast_s2z x casts x from float32 to complex64.

cast_s2z x casts x from float32 to complex64.

cast_z2c x casts x from complex64 to complex32.

cast_z2c x casts x from complex64 to complex32.

cbrt x computes the cubic root of the elements in x and returns the result in a new ndarray.

cbrt x computes the cubic root of the elements in x and returns the result in a new matrix.

ceil x computes the ceiling of the elements in x and returns the result in a new ndarray.

ceil x computes the ceiling of the elements in x and returns the result in a new matrix.

choose x n draw n samples from x without replecement.

clip_by_l2norm t x clips the x according to the threshold set by t.

clip_by_l2norm t x clips the x according to the threshold set by t.

clone x makes an exact copy of matrix x.

clone x makes a copy of x.

clone x returns a copy of matrix x.

col x j returns the column j of x.

col x j returns the column j of x.

col_num x returns the number of columns in matrix x.

col_num x returns the number of columns in matrix x.

col_num_nz x returns the number of non-zero columns in matrix x.

Similar to rows, cols x a returns the columns (specified in array a) of x in a new sparse matrix.

Similar to rows, cols x a returns the columns (specified in array a) of x in a new dense matrix.

combination n k return the number of combination of n things taken k at a time.

combination_float n k return the number of combination of n things taken k at a time.

combination_iterator n k returns an iterator so that you can iterate all the possible combinations of taking k elements from a set of n of elements.

concat_horizontal x y concats two matrices x and y horizontally, therefore their row numbers must be the same.

concat_vertical x y concats two matrices x and y vertically, therefore their column numbers must be the same.

concatenate ~axis:2 x concatenates an array of ndarrays along the third dimension.

concatenate ~axis:1 x concatenates an array of matrices along the second dimension.

conj x returns the conjugate of the complex x.

conj x computes the conjugate of the elements in x and returns the result in a new matrix.

[]

[]

[]

[]

[]

[]

[]

copy src dst copies the data from ndarray src to dst.

copy_col_to v x j copies an 1 by n column vector v to the jth column in an m by n matrix x.

copy_row_to v x i copies an 1 by n row vector v to the ith row in an m by n matrix x.

copy_to x y copies the elements of x to y.

cos x computes the cosine of the elements in x and returns the result in a new ndarray.

cos x computes the cosine of the elements in x and returns the result in a new matrix.

cosh x computes the hyperbolic cosine of the elements in x and returns the result in a new ndarray.

cosh x computes the hyperbolic cosine of the elements in x and returns the result in a new matrix.

create Bigarray.Float64 [|3;4;5|] 2. creates a three-diemensional array of type Bigarray.Float64.

create m n a creates an m by n matrix and all the elements of x are initialised with the value a.

cross_entropy x y calculates the cross entropy between x and y using base e.

cross_entropy x y calculates the cross entropy between x and y using base e.

ctranspose x performs conjugate transpose of a complex matrix x.

cumprod ~axis x : similar to cumsum but performs cumulative product of the elements along the given ~axis.

cumprod ~axis x, refer to the documentation in Owl_dense_ndarray_generic.

cumsum ~axis x : performs cumulative sum of the elements along the given axis ~axis.

cumsum ~axis x, refer to the documentation in Owl_dense_ndarray_generic.

density x returns the density of non-zero element.

density x returns the percentage of non-zero elements in x.

density x returns the percentage of non-zero elements in x.

det x computes the determinant of a matrix x from its LU decomposition.

diag x returns the diagonal elements of x.

diag k x returns the kth diagonal elements of x.

diagm k v creates a diagonal matrix using the elements in v as diagonal values.

diff f x returns the numrical derivative of a function f : float -> float at point x.

diff f x returns the exat derivative of a function f : scalar -> scalar at point x.

diff' f x is similar to diff but also returns the function value f x.

similar to diff, but return (f x, diff f x).

diff2 f x returns second-order derivative of f : float -> float at x.

diff2' f x is similar to diff2 but also returns the function value f x.

div x y performs an element-wise division, so both x and y must have the same dimensions.

div x y divides all the elements in x and y elementwise, and returns the result in a new ndarray.

div x y divides all the elements in x and y elementwise, and returns the result in a new matrix.

div_scalar x a divides every element in x by a constant factor a.

div_scalar x a divides a scalar value a to all the elements in x, and returns the result in a new ndarray.

div_scalar x a divides a scalar value a to all the elements in x, and returns the result in a new matrix.

dot x y calculates the dot product of an m by n matrix x and another n by p matrix y.

dot x y returns the dot product of matrix x and y.

draw_cols x m draws m cols randomly from x.

draw_cols x m draws m cols randomly from x.

draw_col2 x y c is similar to draw_cols but applies to two matrices.

draw_rows x m draws m rows randomly from x.

draw_rows x m draws m rows randomly from x.

draw_rows2 x y c is similar to draw_rows but applies to two matrices.

dropout ~rate:0.3 x drops out 30% of the elements in x, in other words, by setting their values to zeros.

dropout ~rate:0.3 x drops out 30% of the elements in x, in other words, by setting their values to zeros.

ecdf x returns (x',f) which are the empirical cumulative distribution function f of x at points x'.

elt_equal x y performs element-wise = comparison of x and y.

elt_equal x y performs element-wise = comparison of x and y.

elt_equal_scalar x a performs element-wise = comparison of x and a.

elt_equal_scalar x a performs element-wise = comparison of x and a.

elt_greater x y performs element-wise > comparison of x and y.

elt_greater x y performs element-wise > comparison of x and y.

elt_greater_equal x y performs element-wise >= comparison of x and y.

elt_greater_equal x y performs element-wise >= comparison of x and y.

elt_greater_equal_scalar x a performs element-wise >= comparison of x and a.

elt_greater_equal_scalar x a performs element-wise >= comparison of x and a.

elt_greater_scalar x a performs element-wise > comparison of x and a.

elt_greater_scalar x a performs element-wise > comparison of x and a.

elt_less x y performs element-wise < comparison of x and y.

elt_less x y performs element-wise < comparison of x and y.

elt_less_equal x y performs element-wise <= comparison of x and y.

elt_less_equal x y performs element-wise <= comparison of x and y.

elt_less_equal_scalar x a performs element-wise <= comparison of x and a.

elt_less_equal_scalar x a performs element-wise <= comparison of x and a.

elt_less_scalar x a performs element-wise < comparison of x and a.

elt_less_scalar x a performs element-wise < comparison of x and a.

elt_not_equal x y performs element-wise != comparison of x and y.

elt_not_equal x y performs element-wise != comparison of x and y.

elt_not_equal_scalar x a performs element-wise != comparison of x and a.

elt_not_equal_scalar x a performs element-wise != comparison of x and a.

elu alpha x computes the exponential linear unit function x >= 0. ? x : (alpha * (exp(x) - 1)) of the elements in x and returns the result in a new ndarray.

refer to Owl_dense_ndarray_generic.elu

empty Bigarray.Float64 [|3;4;5|] creates a three diemensional array of type Bigarray.Float64.

empty m n creates an m by n matrix without initialising the values of elements in x.

equal x y returns true if two matrices x and y are equal.

equal x y returns true if two ('a, 'b) trices x and y are equal.

equal x y returns true if two matrices x and y are equal.

equal_scalar x a checks if all the elements in x are equal to a.

equal_scalar x a checks if all the elements in x are equal to a.

erf x computes the error function of the elements in x and returns the result in a new ndarray.

erf x computes the error function of the elements in x and returns the result in a new matrix.

erfc x computes the complementary error function of the elements in x and returns the result in a new ndarray.

erfc x computes the complementary error function of the elements in x and returns the result in a new matrix.

exists f x checks all the elements in x using f.

exists f x checks all the elements in x using f.

exists f x checks all the elements in x using f.

exists_nz f x is similar to exists but only checks non-zero elements.

exp x computes the exponential of the elements in x and returns the result in a new ndarray.

exp x computes the exponential of the elements in x and returns the result in a new matrix.

exp10 x computes the base-10 exponential of the elements in x and returns the result in a new ndarray.

exp2 x computes the base-10 exponential of the elements in x and returns the result in a new matrix.

exp2 x computes the base-2 exponential of the elements in x and returns the result in a new ndarray.

exp2 x computes the base-2 exponential of the elements in x and returns the result in a new matrix.

expand x d reshapes x by increasing its rank from num_dims x to d.

expm1 x computes exp x -. 1. of the elements in x and returns the result in a new ndarray.

expm1 x computes exp x -. 1. of the elements in x and returns the result in a new matrix.

Exponential regression: exponential x y fits the measurements x and the observations y into a exponential model: y = a * exp^(-lambda * x) + b .

exponential x mu returns the probability density at x

exponential mu return a random value that follows exponential distribution.

eye m creates an m by m identity matrix.

eye m creates an m by m identity matrix.

fft x performs an FFT operation on matrix x.

fft2 x performns a two-dimensional FFT on a real matrix x.

fft2_complex x is similar to fft2 x but is performed on complex matrices.

fft_complex x is similar to fft x but is performed on complex matrices.

fftshift x shifts the zero frequency component in the middle.

fill x a assigns the value a to the elements in x.

fill x a fills the x with value a.

Similar to filteri, but the coordinates of the elements are not passed to the function f : float -> bool.

Similar to filteri, but the indices of the elements are not passed to f.

Similar to filteri, but the coordinates of the elements are not passed to the function f : float -> bool.

Similar to filteri_cols except that the column indices are not passed to f.

filter_nz f x is similar to filteri_nz except that the coordinates of matrix elements are not passed to f.

Similar to filteri_rows except that the row indices are not passed to f.

filteri f x uses f : int -> int -> float -> bool to filter out certain elements in x.

filteri ~axis f x uses f to filter out certain elements in a slice defined by ~axis.

filteri f x uses f : int -> int -> float -> bool to filter out certain elements in x.

filteri_cols f x uses function f : int -> mat -> bool to check each column in x, then returns an int array containing the indices of those columns which satisfy the function f.

filteri_nz f x is similar to filter f x but only applies f to non-zero elements in x.

filteri_rows f x uses function f : int -> mat -> bool to check each row in x, then returns an int array containing the indices of those rows which satisfy the function f.