Module Ref.Map
Module reference maps.
include Stdlib.Map.S with type Map.key = t
type key
= t
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val update : key -> ('a option -> 'a option) -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge : (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val to_seq : 'a t -> (key * 'a) Stdlib.Seq.t
val to_seq_from : key -> 'a t -> (key * 'a) Stdlib.Seq.t
val add_seq : (key * 'a) Stdlib.Seq.t -> 'a t -> 'a t
val of_seq : (key * 'a) Stdlib.Seq.t -> 'a t
val of_list : (key * 'a) list -> 'a t
of_list bs
isList.fold_left (fun m (k, v) -> add k v m) empty bs
.
Additional adds
val add_to_list : key -> 'a -> 'a list t -> 'a list t
add k v m
ism
withk
mapping tol
such thatl
isv :: find k m
ifk
was bound inm
and[v]
otherwise.
val add_to_set : (module B00_std.Stdlib_set.S with type elt = 'a and type t = 'set) -> key -> 'a -> 'set t -> 'set t
add (module S) k v m
ism
withk
mapping tos
such thats
isS.add v (find k m)
ifk
was bound inm
andS.singleton [v]
otherwise.
Formatting
val pp : ?sep:unit B00_std.Fmt.t -> (key * 'a) B00_std.Fmt.t -> 'a t B00_std.Fmt.t
pp ~sep pp_binding ppf m
formats the bindings ofm
onppf
. Each binding is formatted withpp_binding
and bindings are separated bysep
(defaults toFormat
.pp_print_cut). If the map is empty leavesppf
untouched.
val dump : 'a B00_std.Fmt.t -> 'a t B00_std.Fmt.t
dump pp_v ppf m
prints an unspecified representation ofm
onppf
usingpp_v
to print the map codomain elements.