package owl

  1. Overview
  2. Docs
package owl
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Owl_sparse_ndarray_genericSource

Sparse N-dimensional array module

Type definition
Sourcetype ('a, 'b) kind = ('a, 'b) Bigarray.kind

Type of ``kind``.

Sourcetype ('a, 'b) t

Abstract type of sparse ndarray.

Create sparse ndarray
Sourceval zeros : ('a, 'b) kind -> int array -> ('a, 'b) t

TODO

Sourceval binary : ?density:float -> ('a, 'b) kind -> int array -> ('a, 'b) t

TODO

Sourceval uniform : ?scale:float -> ?density:float -> ('a, 'b) kind -> int array -> ('a, 'b) t

TODO

Obtain basic properties
Sourceval shape : ('a, 'b) t -> int array

TODO

Sourceval num_dims : ('a, 'b) t -> int

TODO

Sourceval nth_dim : ('a, 'b) t -> int -> int

TODO

Sourceval numel : ('a, 'b) t -> int

TODO

Sourceval nnz : ('a, 'b) t -> int

TODO

Sourceval density : ('a, 'b) t -> float

TODO

Sourceval same_shape : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Sourceval kind : ('a, 'b) t -> ('a, 'b) kind

TODO

Manipulate a N-dimensional array
Sourceval get : ('a, 'b) t -> int array -> 'a

TODO

Sourceval set : ('a, 'b) t -> int array -> 'a -> unit

TODO

Sourceval slice : int option array -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval copy : ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval flatten : ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval reshape : ('a, 'b) t -> int array -> ('a, 'b) t

TODO

Sourceval transpose : ?axis:int array -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval swap : int -> int -> ('a, 'b) t -> ('a, 'b) t

TODO

Iterate array elements
Sourceval iteri : ?axis:int option array -> (int array -> 'a -> unit) -> ('a, 'b) t -> unit

TODO

Sourceval iter : ?axis:int option array -> ('a -> unit) -> ('a, 'b) t -> unit

TODO

Sourceval mapi : ?axis:int option array -> (int array -> 'a -> 'a) -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval map : ?axis:int option array -> ('a -> 'a) -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval filteri : ?axis:int option array -> (int array -> 'a -> bool) -> ('a, 'b) t -> int array array

TODO

Sourceval filter : ?axis:int option array -> ('a -> bool) -> ('a, 'b) t -> int array array

TODO

Sourceval foldi : ?axis:int option array -> (int array -> 'c -> 'a -> 'c) -> 'c -> ('a, 'b) t -> 'c

TODO

Sourceval fold : ?axis:int option array -> ('c -> 'a -> 'c) -> 'c -> ('a, 'b) t -> 'c

TODO

Sourceval iteri_nz : ?axis:int option array -> (int array -> 'a -> unit) -> ('a, 'b) t -> unit

TODO

Sourceval iter_nz : ?axis:int option array -> ('a -> unit) -> ('a, 'b) t -> unit

TODO

Sourceval mapi_nz : ?axis:int option array -> (int array -> 'a -> 'a) -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval map_nz : ?axis:int option array -> ('a -> 'a) -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval filteri_nz : ?axis:int option array -> (int array -> 'a -> bool) -> ('a, 'b) t -> int array array

TODO

Sourceval filter_nz : ?axis:int option array -> ('a -> bool) -> ('a, 'b) t -> int array array

TODO

Sourceval foldi_nz : ?axis:int option array -> (int array -> 'c -> 'a -> 'c) -> 'c -> ('a, 'b) t -> 'c

TODO

Sourceval fold_nz : ?axis:int option array -> ('c -> 'a -> 'c) -> 'c -> ('a, 'b) t -> 'c

TODO

Examine array elements or compare two arrays
Sourceval exists : ('a -> bool) -> ('a, 'b) t -> bool

TODO

Sourceval not_exists : ('a -> bool) -> ('a, 'b) t -> bool

TODO

Sourceval for_all : ('a -> bool) -> ('a, 'b) t -> bool

TODO

Sourceval is_zero : ('a, 'b) t -> bool

TODO

Sourceval is_positive : ('a, 'b) t -> bool

TODO

Sourceval is_negative : ('a, 'b) t -> bool

TODO

Sourceval is_nonpositive : ('a, 'b) t -> bool

TODO

Sourceval is_nonnegative : ('a, 'b) t -> bool

TODO

Sourceval equal : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Sourceval not_equal : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Sourceval greater : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Sourceval less : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Sourceval greater_equal : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Sourceval less_equal : ('a, 'b) t -> ('a, 'b) t -> bool

TODO

Input/Output and helper functions
Sourceval to_array : ('a, 'b) t -> (int array * 'a) array

TODO

Sourceval of_array : ('a, 'b) kind -> int array -> (int array * 'a) array -> ('a, 'b) t

TODO

Sourceval print : ('a, 'b) t -> unit

TODO

Sourceval pp_spnda : ('a, 'b) t -> unit

TODO

Sourceval save : ('a, 'b) t -> string -> unit

TODO

Sourceval load : ('a, 'b) kind -> string -> ('a, 'b) t

TODO

Unary mathematical operations
Sourceval min : ('a, 'b) t -> 'a

TODO

Sourceval max : ('a, 'b) t -> 'a

TODO

Sourceval minmax : ('a, 'b) t -> 'a * 'a

TODO

Sourceval abs : ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval neg : ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval sum : ('a, 'b) t -> 'a

TODO

Sourceval mean : ('a, 'b) t -> 'a

TODO

Binary mathematical operations
Sourceval add : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval sub : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval mul : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval div : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval add_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

TODO

Sourceval sub_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

TODO

Sourceval mul_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

TODO

Sourceval div_scalar : ('a, 'b) t -> 'a -> ('a, 'b) t

TODO

Sourceval scalar_add : 'a -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval scalar_sub : 'a -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval scalar_mul : 'a -> ('a, 'b) t -> ('a, 'b) t

TODO

Sourceval scalar_div : 'a -> ('a, 'b) t -> ('a, 'b) t

TODO

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct