module PMap: Extlib.PMap
Polymorphic Map.
This is a polymorphic map, similar to standard library Map
module
but in a defunctorized style.
Author(s): Xavier Leroy (Base library), Nicolas Cannasse, Markus Mottl, David Rajchenbach-Teller
type ('a, 'b)
t
val empty : ('a, 'b) t
compare
as key comparison function.val is_empty : ('a, 'b) t -> bool
val create : ('a -> 'a -> int) -> ('a, 'b) t
val add : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) 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.val find : 'a -> ('a, 'b) t -> 'b
find x m
returns the current binding of x
in m
,
or raises Not_found
if no such binding exists.val remove : 'a -> ('a, 'b) t -> ('a, 'b) t
remove x m
returns a map containing the same bindings as
m
, except for x
which is unbound in the returned map.val mem : 'a -> ('a, 'b) t -> bool
mem x m
returns true
if m
contains a binding for x
,
and false
otherwise.val exists : 'a -> ('a, 'b) t -> bool
mem
.val iter : ('a -> 'b -> unit) -> ('a, 'b) 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
.val map : ('a -> 'b) -> ('c, 'a) t -> ('c, 'b) 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.val mapi : ('a -> 'b -> 'c) -> ('a, 'b) t -> ('a, 'c) t
map
, but the function receives as arguments both the
key and the associated value for each binding of the map.val fold : ('a -> 'b -> 'b) -> ('c, 'a) t -> 'b -> 'b
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.val foldi : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
fold
, but the function receives as arguments both the
key and the associated value for each binding of the map.val filter : ('a -> bool) -> ('b, 'a) t -> ('b, 'a) t
filter f m
returns a map where only the values a
of m
such that f a = true
remain. The bindings are passed to f
in increasing order with respect to the ordering over the
type of the keys.val filteri : ('a -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t
filter f m
returns a map where only the (key, value) pairs
key
, a
of m
such that f key a = true
remain. The
bindings are passed to f
in increasing order with respect
to the ordering over the type of the keys.val filter_map : ('a -> 'b -> 'c option) -> ('a, 'b) t -> ('a, 'c) t
filter_map f m
combines the features of filteri
and
map
. It calls calls f key0 a0
, f key1 a1
, f keyn an
where a0..an
are the elements of m
and key0..keyn
the
respective corresponding keys. It returns the map of
pairs keyi
,bi
such as f keyi ai = Some bi
(when f
returns
None
, the corresponding element of m
is discarded).val enum : ('a, 'b) t -> ('a * 'b) Enum.t
val of_enum : ?cmp:('a -> 'a -> int) -> ('a * 'b) Enum.t -> ('a, 'b) t
compare
by default.val t_of_sexp : (Sexplib.Sexp.t -> 'a) ->
(Sexplib.Sexp.t -> 'b) -> Sexplib.Sexp.t -> ('a, 'b) t
val sexp_of_t : ('a -> Sexplib.Sexp.t) ->
('b -> Sexplib.Sexp.t) -> ('a, 'b) t -> Sexplib.Sexp.t
val print : ?first:string ->
?last:string ->
?sep:string ->
('a Extlib.InnerIO.output -> 'b -> unit) ->
('a Extlib.InnerIO.output -> 'c -> unit) ->
'a Extlib.InnerIO.output -> ('b, 'c) t -> unit