module type S : sig ... end
Types | |
key |
The type of the map keys. Abstract |
'a t |
The type of maps from type key to type 'a .Abstract |
Simple values | |
empty |
'b t The empty map. |
Functions |
add
: key:key -> data:'c -> 'c t -> 'c t |
add x y m
returns a map containing the same bindings as
m
, plus a binding of x
to y
. If x
was already bound
in m
, its previous binding disappears.
find
: key -> 'd t -> 'd |
find x m
returns the current binding of x
in m
,
or raises Not_found
if no such binding exists.
remove
: key -> 'e t -> 'e t |
remove x m
returns a map containing the same bindings as
m
, except for x
which is unbound in the returned map.
mem
: key -> 'f t -> bool |
mem x m
returns true
if m
contains a binding for x
,
and false
otherwise.
iter
: f:(key:key -> data:'g -> unit) -> 'g t -> unit |
iter f m
applies f
to all bindings in map m
.
f
receives the key as first argument, and the associated value
as second argument. The order in which the bindings are passed to
f
is unspecified. Only current bindings are presented to f
:
bindings hidden by more recent bindings are not passed to f
.
map
: f:('h -> 'i) -> 'h t -> 'i t |
map f m
returns a map with same domain as m
, where the
associated value a
of all bindings of m
has been
replaced by the result of the application of f
to a
.
The order in which the associated values are passed to f
is unspecified.
mapi
: f:(key -> 'j -> 'k) -> 'j t -> 'k t |
map
, but the function receives as arguments both the
key and the associated value for each binding of the map.
fold
: f:(key:key -> data:'l -> 'm -> 'm) -> 'l t -> init:'m -> 'm |
fold f m a
computes (f kN dN ... (f k1 d1 a)...)
,
where k1 ... kN
are the keys of all bindings in m
,
and d1 ... dN
are the associated data.
The order in which the bindings are presented to f
is
unspecified.