package arrayjit

You can search for identifiers within the package.

in-package search v0.2.0

package arrayjit

arrayjit
- Arrayjit
  - Assignments
  - Backends
    
    Backend
    
    Cuda_backend
    
    Gccjit_backend
    
    Gccjit_device
    
    Multicore_backend
    
    Backend
    
    No_device_backend
  - Cuda_backend
  - Gccjit_backend
    
    Variants_of_mem_properties
  - Indexing
    
    CompareSymbol
    
    Symbol
    
    Variants_of_axis_index
    
    Variants_of_symbol
  - Low_level
    
    Scope_id
    
    Variants_of_visits
  - Ndarray
  - Ops
  - Rand
    
    Lib
    
    Random
    
    Random_for_tests
  - Tnode
    
    Registry
  - Utils
    
    Debug_runtime
    
    Lazy
    
    Set_O
arrayjit.ppx_arrayjit
- Ppx_arrayjit
  - Ppx_helper

Legend:
Library
Module
Module type
Parameter
Class
Class type

include No_device_backend

type code

type context

type nonrec routine = context routine

val name : Base.string

val initialize : Base.unit -> Base.unit

val is_initialized : Base.unit -> Base.bool

val finalize : context -> Base.unit

Finalizes (just) the context.

val sexp_of_code : code -> Base.Sexp.t

val sexp_of_context : context -> Base.Sexp.t

val sexp_of_routine : routine -> Base.Sexp.t

val maybe_jit : 
  shared:Base.bool ->
  ?name:Base.string ->
  Indexing.unit_bindings ->
  Assignments.t ->
  code

val maybe_jit_batch : 
  shared:Base.bool ->
  ?names:Base.string Base.array ->
  Indexing.unit_bindings ->
  Assignments.t Base.array ->
  code Base.array

Unlike the ~shared parameter, maybe_jit_batch vs. maybe_jit is purely about improving the compile time (does not affect execution).

val jit_code : context -> code -> routine

val jit : 
  context ->
  ?name:Base.string ->
  Indexing.unit_bindings ->
  Assignments.t ->
  routine

val unsafe_cleanup : ?unsafe_shutdown:Base.bool -> Base.unit -> Base.unit

Cleans up all work on a backend. If ~unsafe_shutdown:true, releases resources, potentially making the backend unusable.

val from_host : context -> Tnode.t -> Base.bool

If the array is both hosted and in-context, copies from host to context and returns true.

val to_host : context -> Tnode.t -> Base.bool

If the array is both hosted and in-context, copies from context to host and returns true.

val merge : 
  ?name_prefix:Base.string ->
  Tnode.t ->
  accum:Ops.binop ->
  src:context ->
  code Base.option

Merges the array from the source context into the destination context: dst =: dst accum src. If the array is hosted, its state on host is undefined after this operation. (A backend may choose to use the host array as a buffer, if that is beneficial.) name_prefix is prepended to the jitted function's name. Returns None if the array is not in the context.

val merge_batch : 
  ?name_prefixes:Base.string Base.array ->
  occupancy:(Tnode.t -> src_n:Base.int -> src:context -> Utils.requirement) ->
  Tnode.t Base.list ->
  accum:Ops.binop ->
  srcs:context Base.array ->
  (Tnode.t, code Base.option Base.array) Base.Hashtbl.t

merge_batch vs. merge is purely about improving the compile time (does not affect execution).

type device

val init : device -> context

val await : device -> Base.unit

val sexp_of_device : device -> Base.Sexp.t

val num_devices : Base.unit -> Base.int

val get_device : ordinal:Base.int -> device

val get_ctx_device : context -> device

val to_ordinal : device -> Base.int

val get_all_devices : Base.unit -> device Base.array