Library
Module
Module type
Parameter
Class
Class type
String maps.
include Stdlib.Map.S with type key := string
val empty : 'a t
val is_empty : 'a t -> bool
val mem : string -> 'a t -> bool
val singleton : string -> 'a -> 'a t
val iter : (string -> 'a -> unit) -> 'a t -> unit
val fold : (string -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (string -> 'a -> bool) -> 'a t -> bool
val exists : (string -> 'a -> bool) -> 'a t -> bool
val cardinal : 'a t -> int
val bindings : 'a t -> (string * 'a) list
val min_binding_opt : 'a t -> (string * 'a) option
val max_binding_opt : 'a t -> (string * 'a) option
val choose_opt : 'a t -> (string * 'a) option
val find_opt : string -> 'a t -> 'a option
val find_first : (string -> bool) -> 'a t -> string * 'a
val find_first_opt : (string -> bool) -> 'a t -> (string * 'a) option
val find_last : (string -> bool) -> 'a t -> string * 'a
val find_last_opt : (string -> bool) -> 'a t -> (string * 'a) option
val to_seq : 'a t -> (string * 'a) Stdlib.Seq.t
val to_seq_from : string -> 'a t -> (string * 'a) Stdlib.Seq.t
val of_seq : (string * 'a) Stdlib.Seq.t -> 'a t
val min_binding : 'a t -> (string * 'a) option
Exception safe Map.S.min_binding
.
val get_min_binding : 'a t -> string * 'a
get_min_binding
is like min_binding
but
val max_binding : 'a t -> (string * 'a) option
Exception safe Map.S.max_binding
.
val get_max_binding : 'a t -> string * 'a
get_max_binding
is like max_binding
but
val choose : 'a t -> (string * 'a) option
Exception safe Map.S.choose
.
val find : string -> 'a t -> 'a option
Exception safe Map.S.find
.
val get : string -> 'a t -> 'a
get k m
is like Map.S.find
but raises Invalid_argument
if k
is not bound in m
.
val of_list : (string * 'a) list -> 'a t
of_list bs
is List.fold_left (fun m (k, v) -> add k v m) empty
bs
.
val of_stdlib_map : 'a Stdlib.Map.Make(Stdlib.String).t -> 'a t
of_stdlib_map m
is a map from the stdlib-compatible map m
.
val to_stdlib_map : 'a t -> 'a Stdlib.Map.Make(Stdlib.String).t
to_stdlib_map m
is the stdlib-compatible map equivalent to m
.
val pp :
?sep:(Stdlib.Format.formatter -> unit -> unit) ->
(Stdlib.Format.formatter -> (string * 'a) -> unit) ->
Stdlib.Format.formatter ->
'a t ->
unit
pp ~sep pp_binding ppf m
formats the bindings of m
on ppf
. Each binding is formatted with pp_binding
and bindings are separated by sep
(defaults to Format.pp_print_cut
). If the map is empty leaves ppf
untouched.
val dump :
(Stdlib.Format.formatter -> 'a -> unit) ->
Stdlib.Format.formatter ->
'a t ->
unit
dump pp_v ppf m
prints an unspecified representation of m
on ppf
using pp_v
to print the map codomain elements.
val dump_string_map : Stdlib.Format.formatter -> string t -> unit
dump_string_map ppf m
prints an unspecified representation of the string map m
on ppf
.