package arrayjit

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

Module Arrayjit.NdarraySource

N-dimensional arrays: a precision-handling wrapper for Bigarray.Genarray and its utilities.

*** Handling of precisions ***

Sourcetype ('ocaml, 'elt_t) bigarray = ('ocaml, 'elt_t, Bigarray.c_layout) A.t
Sourceval sexp_of_bigarray : ('a, 'b) bigarray -> Base.Sexp.t
Sourceval sexp_of_address_of : 'a -> Base.Sexp.t
Sourceval sexp_of_byte_nd : byte_nd -> Base.Sexp.t
Sourceval sexp_of_half_nd : half_nd -> Base.Sexp.t
Sourceval sexp_of_single_nd : single_nd -> Base.Sexp.t
Sourceval sexp_of_double_nd : double_nd -> Base.Sexp.t
Sourcetype t =
  1. | Byte_nd of byte_nd
  2. | Half_nd of half_nd
  3. | Single_nd of single_nd
  4. | Double_nd of double_nd
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval as_array : ('ocaml, 'elt_t) Ops.precision -> ('ocaml, 'elt_t) bigarray -> t
Sourceval precision_to_bigarray_kind : ('ocaml, 'elt_t) Ops.precision -> ('ocaml, 'elt_t) Bigarray.kind
Sourceval precision_string : t -> string
Sourceval is_double_prec_t : t -> bool
Sourceval get_prec : t -> Ops.prec
Sourcetype 'r map_with_prec = {
  1. f : 'ocaml 'elt_t. ('ocaml, 'elt_t) Ops.precision -> ('ocaml, 'elt_t) bigarray -> 'r;
}
Sourceval map_with_prec : 'a map_with_prec -> t -> 'a
Sourceval create_bigarray_of_prec : ('ocaml, 'elt_t) Ops.precision -> int array -> ('ocaml, 'elt_t) bigarray
Sourceval init_bigarray_of_prec : ('ocaml, 'elt_t) Ops.precision -> int array -> f:(Base.int Base.array -> 'ocaml) -> ('ocaml, 'elt_t) bigarray
Sourceval indices_to_offset : dims:int Base.Array.t -> idcs:int Base.Array.t -> int
Sourceval create_bigarray : ('ocaml, 'elt_t) Ops.precision -> dims:int Base.Array.t -> Ops.init_op -> ('ocaml, 'elt_t) bigarray
Sourceval create_array : Ops.prec -> dims:int Base.Array.t -> Ops.init_op -> t
Sourceval empty_array : Ops.prec -> t

*** Accessing ***

Sourcetype 'r map_as_bigarray = {
  1. f : 'ocaml 'elt_t. ('ocaml, 'elt_t) bigarray -> 'r;
}
Sourceval map : 'a map_as_bigarray -> t -> 'a
Sourcetype 'r map2_as_bigarray = {
  1. f2 : 'ocaml 'elt_t. ('ocaml, 'elt_t) bigarray -> ('ocaml, 'elt_t) bigarray -> 'r;
}
Sourceval map2 : 'a map2_as_bigarray -> t -> t -> 'a
Sourceval dims : t -> int array
Sourceval get_voidptr : t -> unit Ctypes_static.ptr
Sourceval get_as_float : t -> int array -> Base.Float.t
Sourceval set_from_float : t -> int array -> Base.float -> unit
Sourceval fill_from_float : t -> Base.float -> unit
Sourceval set_bigarray : ('a, 'b, 'c) A.t -> f:(int Base.Array.t -> 'a) -> unit
Sourceval reset_bigarray : Ops.init_op -> ('o, 'b) Ops.precision -> ('o, 'b) bigarray -> unit
Sourceval reset : Ops.init_op -> t -> unit
Sourceval fold_bigarray : ('a, 'b, 'c) A.t -> init:'d -> f:('d -> int Base.Array.t -> 'a -> 'd) -> 'd
Sourceval fold_as_float : init:'a -> f:('a -> int Base.Array.t -> Base.float -> 'a) -> t -> 'a
Sourceval size_in_bytes : t -> int
Sourceval retrieve_2d_points : ?from_axis:int -> xdim:int -> ydim:int -> t -> (Base.Float.t * Base.Float.t) Base.Array.t
Sourceval retrieve_1d_points : ?from_axis:int -> xdim:int -> t -> Base.Float.t Base.Array.t
Sourceval retrieve_flat_values : t -> Base.Float.t Base.Array.t

*** Printing ***

Sourceval int_dims_to_string : ?with_axis_numbers:bool -> Base.Int.t Base.Array.t -> Base.String.t

Dimensions to string, "x"-separated, e.g. 1x2x3 for batch dims 1, input dims 3, output dims 2. Outputs "-" for empty dimensions.

Sourceval concise_float : prec:int -> float -> Base.String.t
Sourceval render_array : ?brief:Base.bool -> ?prefix:Base.String.t -> ?entries_per_axis:int -> ?labels:Base.String.t Base.Array.t -> indices:int Base.Array.t -> t -> PrintBox.t

Prints 0-based indices entries out of arr, where a number between -5 and -1 in an axis means to print out the axis, and a non-negative number means to print out only the indexed dimension of the axis. Prints up to entries_per_axis or entries_per_axis+1 entries per axis, possibly with ellipsis in the middle. labels provides the axis labels for all axes (use "" or "_" for no label). The last label corresponds to axis -1 etc. The printed out axes are arranged as:

  • -1: a horizontal segment in an inner rectangle (i.e. column numbers of the inner rectangle),
  • -2: a sequence of segments in a line of text (i.e. column numbers of an outer rectangle),
  • -3: a vertical segment in an inner rectangle (i.e. row numbers of the inner rectangle),
  • -4: a vertical sequence of segments (i.e. column numbers of an outer rectangle),
  • -5: a sequence of screens of text (i.e. stack numbers of outer rectangles).
Sourceval pp_array : Format.formatter -> ?prefix:Base.String.t -> ?entries_per_axis:int -> ?labels:Base.String.t Base.Array.t -> indices:int Base.Array.t -> t -> unit
Sourceval pp_array_inline : Format.formatter -> num_batch_axes:int -> num_output_axes:int -> num_input_axes:int -> ?axes_spec:string -> t -> unit

Prints the whole array in an inline syntax.

Sourceval save : file_name:string -> t -> unit
Sourceval restore : file_name:string -> t -> unit
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