Quick StartTryGuideAPICommunityBlogGitHub

Standard Library

Below is the API for the OCaml standard library. It's directly copied over from the OCaml Manual, formatted to the Reason syntax and styled accordingly. The API docs are work-in-progress; we'll be polishing these gradually!

If you're targeting JavaScript, the API docs for BuckleScript includes all of below, plus JS-specific APIs.

sig

  type ('a, 'b, 'c) t
  external create :
    ('a, 'b) Bigarray.kind ->
    'c Bigarray.layout -> int array -> ('a, 'b, 'c) Bigarray.Genarray.t
    = "caml_ba_create"
  external num_dims : ('a, 'b, 'c) Bigarray.Genarray.t -> int
    = "caml_ba_num_dims"
  val dims : ('a, 'b, 'c) Bigarray.Genarray.t -> int array
  external nth_dim : ('a, 'b, 'c) Bigarray.Genarray.t -> int -> int
    = "caml_ba_dim"
  external kind : ('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b) Bigarray.kind
    = "caml_ba_kind"
  external layout : ('a, 'b, 'c) Bigarray.Genarray.t -> 'c Bigarray.layout
    = "caml_ba_layout"
  external get : ('a, 'b, 'c) Bigarray.Genarray.t -> int array -> 'a
    = "caml_ba_get_generic"
  external set : ('a, 'b, 'c) Bigarray.Genarray.t -> int array -> 'a -> unit
    = "caml_ba_set_generic"
  external sub_left :
    ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t ->
    int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t
    = "caml_ba_sub"
  external sub_right :
    ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t ->
    int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t
    = "caml_ba_sub"
  external slice_left :
    ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t ->
    int array -> ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t
    = "caml_ba_slice"
  external slice_right :
    ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t ->
    int array -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t
    = "caml_ba_slice"
  external blit :
    ('a, 'b, 'c) Bigarray.Genarray.t ->
    ('a, 'b, 'c) Bigarray.Genarray.t -> unit = "caml_ba_blit"
  external fill : ('a, 'b, 'c) Bigarray.Genarray.t -> 'a -> unit
    = "caml_ba_fill"
  val map_file :
    Unix.file_descr ->
    ?pos:int64 ->
    ('a, 'b) Bigarray.kind ->
    'c Bigarray.layout ->
    bool -> int array -> ('a, 'b, 'c) Bigarray.Genarray.t
end