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!
module Map: sig .. end
This module implements applicative association tables, also known as finite maps or dictionaries, given a total ordering function over the keys. All operations over maps are purely applicative (no side-effects). The implementation uses balanced binary trees, and therefore searching and insertion take time logarithmic in the size of the map.
module IntPairs = struct type t = int * int let compare (x0,y0) (x1,y1) = match Pervasives.compare x0 x1 with 0 -> Pervasives.compare y0 y1 | c -> c end module PairsMap = Map.Make(IntPairs) let m = PairsMap.(empty |> add (0,1) "hello" |> add (1,0) "world")
This creates a new module
PairsMap, with a new type
of maps from
int * int to
'a. In this example,
values so its type is
module type OrderedType = sig .. end
module type S = sig .. end
module Make: (Ord: OrderedType) => S with type key = Ord.t;