owl

OCaml Scientific and Engineering Computing
package owl
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library owl
Module Owl_dense_matrix_s
type elt = float
include Owl_dense_matrix_intf.Common with type elt := elt and type mat := mat
Create dense matrices
val empty : int -> int -> mat
val create : int -> int -> elt -> mat
val init : int -> int -> ( int -> elt ) -> mat
val init_2d : int -> int -> ( int -> int -> elt ) -> mat
val zeros : int -> int -> mat
val ones : int -> int -> mat
val eye : int -> mat
val sequential : ?a:elt -> ?step:elt -> int -> int -> mat
val uniform : ?a:elt -> ?b:elt -> int -> int -> mat
val gaussian : ?mu:elt -> ?sigma:elt -> int -> int -> mat
val bernoulli : ?p:float -> int -> int -> mat
val unit_basis : int -> int -> mat
val diagm : ?k:int -> mat -> mat
val triu : ?k:int -> mat -> mat
val tril : ?k:int -> mat -> mat
val symmetric : ?upper:bool -> mat -> mat
val bidiagonal : ?upper:bool -> mat -> mat -> mat
val toeplitz : ?c:mat -> mat -> mat
val hankel : ?r:mat -> mat -> mat
val hadamard : int -> mat
val magic : int -> mat
Dense row vectors and meshgrids
val vector : int -> mat
val vector_zeros : int -> mat
val vector_ones : int -> mat
val vector_uniform : int -> mat
val linspace : elt -> elt -> int -> mat
val logspace : ?base:float -> elt -> elt -> int -> mat
val meshgrid : elt -> elt -> elt -> elt -> int -> int -> mat * mat
val meshup : mat -> mat -> mat * mat
Obtain the basic properties of a matrix
val shape : mat -> int * int
val row_num : mat -> int
val col_num : mat -> int
val numel : mat -> int
val nnz : mat -> int
val density : mat -> float
val size_in_bytes : mat -> int
val same_shape : mat -> mat -> bool
val same_data : mat -> mat -> bool
Manipulate a matrix
val get : mat -> int -> int -> elt
val set : mat -> int -> int -> elt -> unit
val get_index : mat -> int array array -> elt array
val set_index : mat -> int array array -> elt array -> unit
val get_fancy : Owl_types.index list -> mat -> mat
val set_fancy : Owl_types.index list -> mat -> mat -> unit
val get_slice : int list list -> mat -> mat
val set_slice : int list list -> mat -> mat -> unit
val row : mat -> int -> mat
val col : mat -> int -> mat
val rows : mat -> int array -> mat
val cols : mat -> int array -> mat
val resize : ?head:bool -> mat -> int array -> mat
val reshape : mat -> int array -> mat
val flatten : mat -> mat
val reverse : mat -> mat
val flip : ?axis:int -> mat -> mat
val rotate : mat -> int -> mat
val reset : mat -> unit
val fill : mat -> elt -> unit
val copy : mat -> mat
val copy_row_to : mat -> mat -> int -> unit
val copy_col_to : mat -> mat -> int -> unit
val concat_vertical : mat -> mat -> mat
val concat_horizontal : mat -> mat -> mat
val concat_vh : mat array array -> mat
val concatenate : ?axis:int -> mat array -> mat
val split : ?axis:int -> int array -> mat -> mat array
val split_vh : (int * int) array array -> mat -> mat array array
val transpose : mat -> mat
val ctranspose : mat -> mat
val diag : ?k:int -> mat -> mat
val swap_rows : mat -> int -> int -> unit
val swap_cols : mat -> int -> int -> unit
val tile : mat -> int array -> mat
val repeat : mat -> int array -> mat
val pad : ?v:elt -> int list list -> mat -> mat
val dropout : ?rate:float -> mat -> mat
val top : mat -> int -> int array array
val bottom : mat -> int -> int array array
val sort : mat -> mat
Iterate elements, columns, and rows.
val iteri : ( int -> elt -> unit ) -> mat -> unit
val iter : ( elt -> unit ) -> mat -> unit
val mapi : ( int -> elt -> elt ) -> mat -> mat
val map : ( elt -> elt ) -> mat -> mat
val foldi : ?axis:int -> ( int -> elt -> elt -> elt ) -> elt -> mat -> mat
val fold : ?axis:int -> ( elt -> elt -> elt ) -> elt -> mat -> mat
val scani : ?axis:int -> ( int -> elt -> elt -> elt ) -> mat -> mat
val scan : ?axis:int -> ( elt -> elt -> elt ) -> mat -> mat
val filteri : ( int -> elt -> bool ) -> mat -> int array
val filter : ( elt -> bool ) -> mat -> int array
val iteri_2d : ( int -> int -> elt -> unit ) -> mat -> unit
val mapi_2d : ( int -> int -> elt -> elt ) -> mat -> mat
val foldi_2d : ?axis:int -> ( int -> int -> elt -> elt -> elt ) -> elt -> mat -> mat
val scani_2d : ?axis:int -> ( int -> int -> elt -> elt -> elt ) -> mat -> mat
val filteri_2d : ( int -> int -> elt -> bool ) -> mat -> (int * int) array
val iter2i_2d : ( int -> int -> elt -> elt -> unit ) -> mat -> mat -> unit
val map2i_2d : ( int -> int -> elt -> elt -> elt ) -> mat -> mat -> mat
val iter2i : ( int -> elt -> elt -> unit ) -> mat -> mat -> unit
val iter2 : ( elt -> elt -> unit ) -> mat -> mat -> unit
val map2i : ( int -> elt -> elt -> elt ) -> mat -> mat -> mat
val map2 : ( elt -> elt -> elt ) -> mat -> mat -> mat
val iteri_rows : ( int -> mat -> unit ) -> mat -> unit
val iter_rows : ( mat -> unit ) -> mat -> unit
val iter2i_rows : ( int -> mat -> mat -> unit ) -> mat -> mat -> unit
val iter2_rows : ( mat -> mat -> unit ) -> mat -> mat -> unit
val iteri_cols : ( int -> mat -> unit ) -> mat -> unit
val iter_cols : ( mat -> unit ) -> mat -> unit
val filteri_rows : ( int -> mat -> bool ) -> mat -> int array
val filter_rows : ( mat -> bool ) -> mat -> int array
val filteri_cols : ( int -> mat -> bool ) -> mat -> int array
val filter_cols : ( mat -> bool ) -> mat -> int array
val fold_rows : ( 'a -> mat -> 'a ) -> 'a -> mat -> 'a
val fold_cols : ( 'a -> mat -> 'a ) -> 'a -> mat -> 'a
val mapi_rows : ( int -> mat -> 'a ) -> mat -> 'a array
val map_rows : ( mat -> 'a ) -> mat -> 'a array
val mapi_cols : ( int -> mat -> 'a ) -> mat -> 'a array
val map_cols : ( mat -> 'a ) -> mat -> 'a array
val mapi_by_row : int -> ( int -> mat -> mat ) -> mat -> mat
val map_by_row : int -> ( mat -> mat ) -> mat -> mat
val mapi_by_col : int -> ( int -> mat -> mat ) -> mat -> mat
val map_by_col : int -> ( mat -> mat ) -> mat -> mat
val mapi_at_row : ( int -> elt -> elt ) -> mat -> int -> mat
val map_at_row : ( elt -> elt ) -> mat -> int -> mat
val mapi_at_col : ( int -> elt -> elt ) -> mat -> int -> mat
val map_at_col : ( elt -> elt ) -> mat -> int -> mat
Examin elements and compare two matrices
val exists : ( elt -> bool ) -> mat -> bool
val not_exists : ( elt -> bool ) -> mat -> bool
val for_all : ( elt -> bool ) -> mat -> bool
val is_zero : mat -> bool
val is_positive : mat -> bool
val is_negative : mat -> bool
val is_nonpositive : mat -> bool
val is_nonnegative : mat -> bool
val is_normal : mat -> bool
val not_nan : mat -> bool
val not_inf : mat -> bool
val equal : mat -> mat -> bool
val not_equal : mat -> mat -> bool
val greater : mat -> mat -> bool
val less : mat -> mat -> bool
val greater_equal : mat -> mat -> bool
val less_equal : mat -> mat -> bool
val elt_equal : mat -> mat -> mat
val elt_not_equal : mat -> mat -> mat
val elt_less : mat -> mat -> mat
val elt_greater : mat -> mat -> mat
val elt_less_equal : mat -> mat -> mat
val elt_greater_equal : mat -> mat -> mat
val equal_scalar : mat -> elt -> bool
val not_equal_scalar : mat -> elt -> bool
val less_scalar : mat -> elt -> bool
val greater_scalar : mat -> elt -> bool
val less_equal_scalar : mat -> elt -> bool
val greater_equal_scalar : mat -> elt -> bool
val elt_equal_scalar : mat -> elt -> mat
val elt_not_equal_scalar : mat -> elt -> mat
val elt_less_scalar : mat -> elt -> mat
val elt_greater_scalar : mat -> elt -> mat
val elt_less_equal_scalar : mat -> elt -> mat
val elt_greater_equal_scalar : mat -> elt -> mat
val approx_equal : ?eps:float -> mat -> mat -> bool
val approx_equal_scalar : ?eps:float -> mat -> elt -> bool
val approx_elt_equal : ?eps:float -> mat -> mat -> mat
val approx_elt_equal_scalar : ?eps:float -> mat -> elt -> mat
Randomisation functions
val draw_rows : ?replacement:bool -> mat -> int -> mat * int array
val draw_cols : ?replacement:bool -> mat -> int -> mat * int array
val draw_rows2 : ?replacement:bool -> mat -> mat -> int -> mat * mat * int array
val draw_cols2 : ?replacement:bool -> mat -> mat -> int -> mat * mat * int array
val shuffle_rows : mat -> mat
val shuffle_cols : mat -> mat
val shuffle : mat -> mat
Input/Output and helper functions
val to_array : mat -> elt array
val of_array : elt array -> int -> int -> mat
val to_arrays : mat -> elt array array
val of_arrays : elt array array -> mat
val to_rows : mat -> mat array
val of_rows : mat array -> mat
val to_cols : mat -> mat array
val of_cols : mat array -> mat
val print : ?max_row:int -> ?max_col:int -> ?header:bool -> ?fmt:( elt -> string ) -> mat -> unit
val save : out:string -> mat -> unit
val load : string -> mat
val save_txt : ?sep:string -> ?append:bool -> out:string -> mat -> unit
val load_txt : ?sep:string -> string -> mat
val save_npy : out:string -> mat -> unit
val load_npy : string -> mat
Unary mathematical operations
val min : ?axis:int -> mat -> mat
val min' : mat -> elt
val max : ?axis:int -> mat -> mat
val max' : mat -> elt
val minmax : ?axis:int -> mat -> mat * mat
val minmax' : mat -> elt * elt
val min_i : mat -> elt * int array
val max_i : mat -> elt * int array
val minmax_i : mat -> (elt * int array) * (elt * int array)
val trace : mat -> elt
val sum : ?axis:int -> mat -> mat
val sum' : mat -> elt
val prod : ?axis:int -> mat -> mat
val prod' : mat -> elt
val mean : ?axis:int -> mat -> mat
val mean' : mat -> elt
val var' : mat -> elt
val std' : mat -> elt
val sem : ?axis:int -> mat -> mat
val sem' : mat -> elt
val sum_rows : mat -> mat
val sum_cols : mat -> mat
val mean_rows : mat -> mat
val mean_cols : mat -> mat
val abs : mat -> mat
val abs2 : mat -> mat
val conj : mat -> mat
val neg : mat -> mat
val reci : mat -> mat
val reci_tol : ?tol:elt -> mat -> mat
val sqr : mat -> mat
val sqrt : mat -> mat
val cbrt : mat -> mat
val exp : mat -> mat
val exp2 : mat -> mat
val exp10 : mat -> mat
val expm1 : mat -> mat
val log : mat -> mat
val log10 : mat -> mat
val log2 : mat -> mat
val log1p : mat -> mat
val sin : mat -> mat
val cos : mat -> mat
val tan : mat -> mat
val asin : mat -> mat
val acos : mat -> mat
val atan : mat -> mat
val sinh : mat -> mat
val cosh : mat -> mat
val tanh : mat -> mat
val asinh : mat -> mat
val acosh : mat -> mat
val atanh : mat -> mat
val floor : mat -> mat
val ceil : mat -> mat
val round : mat -> mat
val trunc : mat -> mat
val fix : mat -> mat
val modf : mat -> mat * mat
val l1norm : ?axis:int -> mat -> mat
val l1norm' : mat -> elt
val l2norm : ?axis:int -> mat -> mat
val l2norm' : mat -> elt
val l2norm_sqr : ?axis:int -> mat -> mat
val l2norm_sqr' : mat -> elt
val vecnorm : ?axis:int -> ?p:float -> mat -> mat
val vecnorm' : ?p:float -> mat -> elt
val cumsum : ?axis:int -> mat -> mat
val cumprod : ?axis:int -> mat -> mat
val cummin : ?axis:int -> mat -> mat
val cummax : ?axis:int -> mat -> mat
val diff : ?axis:int -> ?n:int -> mat -> mat
val var : ?axis:int -> mat -> mat
val std : ?axis:int -> mat -> mat
val mat2gray : ?amin:elt -> ?amax:elt -> mat -> mat
val lgamma : mat -> mat
val dawsn : mat -> mat
Binary mathematical operations
val add : mat -> mat -> mat
val sub : mat -> mat -> mat
val mul : mat -> mat -> mat
val div : mat -> mat -> mat
val add_scalar : mat -> elt -> mat
val sub_scalar : mat -> elt -> mat
val mul_scalar : mat -> elt -> mat
val div_scalar : mat -> elt -> mat
val scalar_add : elt -> mat -> mat
val scalar_sub : elt -> mat -> mat
val scalar_mul : elt -> mat -> mat
val scalar_div : elt -> mat -> mat
val dot : mat -> mat -> mat
val add_diag : mat -> elt -> mat
val pow : mat -> mat -> mat
val scalar_pow : elt -> mat -> mat
val pow_scalar : mat -> elt -> mat
val min2 : mat -> mat -> mat
val max2 : mat -> mat -> mat
val ssqr' : mat -> elt -> elt
val ssqr_diff' : mat -> mat -> elt
val clip_by_value : ?amin:elt -> ?amax:elt -> mat -> mat
val cov : ?b:mat -> a:mat -> mat
val kron : mat -> mat -> mat
val fma : mat -> mat -> mat -> mat
Fucntions of in-place modification
val create_ : out:mat -> elt -> unit
val uniform_ : ?a:elt -> ?b:elt -> out:mat -> unit
val bernoulli_ : ?p:float -> out:mat -> unit
val zeros_ : out:mat -> unit
val ones_ : out:mat -> unit
val sort_ : mat -> unit
val one_hot_ : out:mat -> int -> mat -> unit
val copy_ : out:mat -> mat -> unit
val reshape_ : out:mat -> mat -> unit
val transpose_ : out:mat -> ?axis:int array -> mat -> unit
val sum_ : out:mat -> axis:int -> mat -> unit
val min_ : out:mat -> axis:int -> mat -> unit
val max_ : out:mat -> axis:int -> mat -> unit
val add_ : ?out:mat -> mat -> mat -> unit
val sub_ : ?out:mat -> mat -> mat -> unit
val mul_ : ?out:mat -> mat -> mat -> unit
val div_ : ?out:mat -> mat -> mat -> unit
val pow_ : ?out:mat -> mat -> mat -> unit
val atan2_ : ?out:mat -> mat -> mat -> unit
val hypot_ : ?out:mat -> mat -> mat -> unit
val fmod_ : ?out:mat -> mat -> mat -> unit
val min2_ : ?out:mat -> mat -> mat -> unit
val max2_ : ?out:mat -> mat -> mat -> unit
val add_scalar_ : ?out:mat -> mat -> elt -> unit
val sub_scalar_ : ?out:mat -> mat -> elt -> unit
val mul_scalar_ : ?out:mat -> mat -> elt -> unit
val div_scalar_ : ?out:mat -> mat -> elt -> unit
val pow_scalar_ : ?out:mat -> mat -> elt -> unit
val atan2_scalar_ : ?out:mat -> mat -> elt -> unit
val fmod_scalar_ : ?out:mat -> mat -> elt -> unit
val scalar_add_ : ?out:mat -> elt -> mat -> unit
val scalar_sub_ : ?out:mat -> elt -> mat -> unit
val scalar_mul_ : ?out:mat -> elt -> mat -> unit
val scalar_div_ : ?out:mat -> elt -> mat -> unit
val scalar_pow_ : ?out:mat -> elt -> mat -> unit
val scalar_atan2_ : ?out:mat -> elt -> mat -> unit
val scalar_fmod_ : ?out:mat -> elt -> mat -> unit
val fma_ : ?out:mat -> mat -> mat -> mat -> unit
val dot_ : ?transa:bool -> ?transb:bool -> ?alpha:elt -> ?beta:elt -> c:mat -> mat -> mat -> unit
val conj_ : ?out:mat -> mat -> unit
val abs_ : ?out:mat -> mat -> unit
val neg_ : ?out:mat -> mat -> unit
val reci_ : ?out:mat -> mat -> unit
val signum_ : ?out:mat -> mat -> unit
val sqr_ : ?out:mat -> mat -> unit
val sqrt_ : ?out:mat -> mat -> unit
val cbrt_ : ?out:mat -> mat -> unit
val exp_ : ?out:mat -> mat -> unit
val exp2_ : ?out:mat -> mat -> unit
val exp10_ : ?out:mat -> mat -> unit
val expm1_ : ?out:mat -> mat -> unit
val log_ : ?out:mat -> mat -> unit
val log2_ : ?out:mat -> mat -> unit
val log10_ : ?out:mat -> mat -> unit
val log1p_ : ?out:mat -> mat -> unit
val sin_ : ?out:mat -> mat -> unit
val cos_ : ?out:mat -> mat -> unit
val tan_ : ?out:mat -> mat -> unit
val asin_ : ?out:mat -> mat -> unit
val acos_ : ?out:mat -> mat -> unit
val atan_ : ?out:mat -> mat -> unit
val sinh_ : ?out:mat -> mat -> unit
val cosh_ : ?out:mat -> mat -> unit
val tanh_ : ?out:mat -> mat -> unit
val asinh_ : ?out:mat -> mat -> unit
val acosh_ : ?out:mat -> mat -> unit
val atanh_ : ?out:mat -> mat -> unit
val floor_ : ?out:mat -> mat -> unit
val ceil_ : ?out:mat -> mat -> unit
val round_ : ?out:mat -> mat -> unit
val trunc_ : ?out:mat -> mat -> unit
val fix_ : ?out:mat -> mat -> unit
val erf_ : ?out:mat -> mat -> unit
val erfc_ : ?out:mat -> mat -> unit
val relu_ : ?out:mat -> mat -> unit
val softplus_ : ?out:mat -> mat -> unit
val softsign_ : ?out:mat -> mat -> unit
val sigmoid_ : ?out:mat -> mat -> unit
val softmax_ : ?out:mat -> ?axis:int -> mat -> unit
val cumsum_ : ?out:mat -> ?axis:int -> mat -> unit
val cumprod_ : ?out:mat -> ?axis:int -> mat -> unit
val cummin_ : ?out:mat -> ?axis:int -> mat -> unit
val cummax_ : ?out:mat -> ?axis:int -> mat -> unit
val dropout_ : ?out:mat -> ?rate:float -> mat -> unit
val elt_equal_ : ?out:mat -> mat -> mat -> unit
val elt_not_equal_ : ?out:mat -> mat -> mat -> unit
val elt_less_ : ?out:mat -> mat -> mat -> unit
val elt_greater_ : ?out:mat -> mat -> mat -> unit
val elt_less_equal_ : ?out:mat -> mat -> mat -> unit
val elt_greater_equal_ : ?out:mat -> mat -> mat -> unit
val elt_equal_scalar_ : ?out:mat -> mat -> elt -> unit
val elt_not_equal_scalar_ : ?out:mat -> mat -> elt -> unit
val elt_less_scalar_ : ?out:mat -> mat -> elt -> unit
val elt_greater_scalar_ : ?out:mat -> mat -> elt -> unit
val elt_less_equal_scalar_ : ?out:mat -> mat -> elt -> unit
val elt_greater_equal_scalar_ : ?out:mat -> mat -> elt -> unit
include Owl_dense_matrix_intf.Real with type elt := elt and type mat := mat
Specific real functions
val semidef : int -> mat
val min_rows : mat -> (elt * int * int) array
val min_cols : mat -> (elt * int * int) array
val max_rows : mat -> (elt * int * int) array
val max_cols : mat -> (elt * int * int) array
val signum : mat -> mat
val erf : mat -> mat
val erfc : mat -> mat
val logistic : mat -> mat
val relu : mat -> mat
val elu : ?alpha:elt -> mat -> mat
val leaky_relu : ?alpha:elt -> mat -> mat
val softplus : mat -> mat
val softsign : mat -> mat
val softmax : ?axis:int -> mat -> mat
val sigmoid : mat -> mat
val log_sum_exp' : mat -> elt
val max_pool : ?padding:Owl_types.padding -> mat -> int array -> int array -> mat
val avg_pool : ?padding:Owl_types.padding -> mat -> int array -> int array -> mat
val atan2 : mat -> mat -> mat
val scalar_atan2 : elt -> mat -> mat
val atan2_scalar : mat -> elt -> mat
val hypot : mat -> mat -> mat
val fmod : mat -> mat -> mat
val fmod_scalar : mat -> elt -> mat
val scalar_fmod : elt -> mat -> mat
val cross_entropy' : mat -> mat -> elt
val clip_by_l2norm : elt -> mat -> mat
val poisson : mu:elt -> int -> int -> mat