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
  val create :
    ('a, 'b) Bigarray.kind ->
    'c Bigarray.layout -> int -> ('a, 'b, 'c) Bigarray.Array1.t
  external dim : ('a, 'b, 'c) Bigarray.Array1.t -> int = "%caml_ba_dim_1"
  external kind : ('a, 'b, 'c) Bigarray.Array1.t -> ('a, 'b) Bigarray.kind
    = "caml_ba_kind"
  external layout : ('a, 'b, 'c) Bigarray.Array1.t -> 'c Bigarray.layout
    = "caml_ba_layout"
  external get : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a
    = "%caml_ba_ref_1"
  external set : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a -> unit
    = "%caml_ba_set_1"
  external sub :
    ('a, 'b, 'c) Bigarray.Array1.t ->
    int -> int -> ('a, 'b, 'c) Bigarray.Array1.t = "caml_ba_sub"
  external blit :
    ('a, 'b, 'c) Bigarray.Array1.t -> ('a, 'b, 'c) Bigarray.Array1.t -> unit
    = "caml_ba_blit"
  external fill : ('a, 'b, 'c) Bigarray.Array1.t -> 'a -> unit
    = "caml_ba_fill"
  val of_array :
    ('a, 'b) Bigarray.kind ->
    'c Bigarray.layout -> 'a array -> ('a, 'b, 'c) Bigarray.Array1.t
  val map_file :
    Unix.file_descr ->
    ?pos:int64 ->
    ('a, 'b) Bigarray.kind ->
    'c Bigarray.layout -> bool -> int -> ('a, 'b, 'c) Bigarray.Array1.t
  external unsafe_get : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a
    = "%caml_ba_unsafe_ref_1"
  external unsafe_set : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a -> unit
    = "%caml_ba_unsafe_set_1"
end