module PMap: BatMapmodule type S =sig..end
module Make:
The functions below present the manipulation of polymorphic maps, as were provided by the Extlib PMap module.
They are similar in functionality to the functorized BatMap.Make
module, but only uses the Pervasives.compare function to compare
elements. If you need to compare using a custom comparison
function, it is recommended to use the functorized maps provided
by BatMap.Make.
type ('a, 'b) t
val empty : ('a, 'b) tcompare as key comparison function.val is_empty : ('a, 'b) t -> boolval singleton : 'a -> 'b -> ('a, 'b) tval cardinal : ('a, 'b) t -> intval add : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) tadd 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 update : 'a -> 'a -> 'b -> ('a, 'b) t -> ('a, 'b) tupdate k1 k2 v2 m replace the previous binding of k1 in m by
k2 associated to v2.
This is equivalent to add k2 v2 (remove k1) m, but more efficient
in the case where k1 and k2 have the same key ordering.Not_found if k1 is not bound in m.val find : 'a -> ('a, 'b) t -> 'bfind 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) tremove 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 -> boolmem x m returns true if m contains a binding for x,
and false otherwise.val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unititer 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 : ('b -> 'c) -> ('a, 'b) t -> ('a, 'c) tmap 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) tmap, but the function receives as arguments both the
key and the associated value for each binding of the map.val fold : ('b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'cfold f m a computes (f kN dN ... (f k1 d1 (f k0 d0 a))...),
where k0,k1..kN are the keys of all bindings in m,
and d0,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 -> 'cfold, but the function receives as arguments both the
key and the associated value for each binding of the map.val at_rank_exn : int -> ('key, 'a) t -> 'key * 'aat_rank_exn i m returns the (key,value) pair
whose key is at rank i in m,
that is the i-th element in increasing order of the keys
(the 0-th element being the smallest key in m with its
associated value).Not_found if m = empty.Invalid_argument error_message if i < 0 || i >= cardinal mval filterv : ('a -> bool) -> ('key, 'a) t -> ('key, 'a) tfilterv 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 filter : ('key -> 'a -> bool) -> ('key, 'a) t -> ('key, 'a) tfilter 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 : ('key -> 'a -> 'b option) -> ('key, 'a) t -> ('key, 'b) tfilter_map f m combines the features of filter 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 choose : ('key, 'a) t -> 'key * 'aNot_found if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val split : 'key ->
('key, 'a) t -> ('key, 'a) t * 'a option * ('key, 'a) tsplit x m returns a triple (l, data, r), where
l is the map with all the bindings of m whose key
is strictly less than x;
r is the map with all the bindings of m whose key
is strictly greater than x;
data is None if m contains no binding for x,
or Some v if m binds v to x.val min_binding : ('key, 'a) t -> 'key * 'aval pop_min_binding : ('key, 'a) t -> ('key * 'a) * ('key, 'a) tval max_binding : ('key, 'a) t -> 'key * 'aval pop_max_binding : ('key, 'a) t -> ('key * 'a) * ('key, 'a) tval enum : ('a, 'b) t -> ('a * 'b) BatEnum.tval backwards : ('a, 'b) t -> ('a * 'b) BatEnum.tval keys : ('a, 'b) t -> 'a BatEnum.tval values : ('a, 'b) t -> 'b BatEnum.tval of_enum : ('a * 'b) BatEnum.t -> ('a, 'b) tval for_all : ('a -> 'b -> bool) -> ('a, 'b) t -> boolval exists : ('a -> 'b -> bool) -> ('a, 'b) t -> boolval partition : ('a -> 'b -> bool) ->
('a, 'b) t -> ('a, 'b) t * ('a, 'b) tpartition p m returns a pair of maps (m1, m2), where m1
contains all the bindings of s that satisfy the predicate
p, and m2 is the map with all the bindings of s that do
not satisfy p.val add_carry : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) t * 'b optionadd_carry k v m adds the binding (k,v) to m, returning the new map and optionally the previous value bound to k.val modify : 'a -> ('b -> 'b) -> ('a, 'b) t -> ('a, 'b) tmodify k f m replaces the previous binding for k with f
applied to that value. If k is unbound in m or Not_found is
raised during the search, Not_found is raised.Not_found if k is unbound in m (or f raises Not_found)val modify_def : 'b -> 'a -> ('b -> 'b) -> ('a, 'b) t -> ('a, 'b) tmodify_def v0 k f m replaces the previous binding for k
with f applied to that value. If k is unbound in m or
Not_found is raised during the search, f v0 is
inserted (as if the value found were v0).val modify_opt : 'a -> ('b option -> 'b option) -> ('a, 'b) t -> ('a, 'b) tmodify_opt k f m allow to modify the binding for k in m
or absence thereof.val extract : 'a -> ('a, 'b) t -> 'b * ('a, 'b) textract k m removes the current binding of k from m,
returning the value k was bound to and the updated m.val pop : ('a, 'b) t -> ('a * 'b) * ('a, 'b) tpop m returns a binding from m and m without that
binding.val union : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) tunion m1 m2 merges two maps, using the comparison function of
m1. In case of conflicted bindings, m2's bindings override
m1's. Equivalent to foldi add m2 m1.
The resulting map uses the comparison function of m1.val diff : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) tdiff m1 m2 removes all bindings of keys found in m2 from m1,
using the comparison function of m1. Equivalent to
foldi (fun k _v m -> remove k m) m2 m1
The resulting map uses the comparison function of m1.val intersect : ('b -> 'c -> 'd) ->
('a, 'b) t -> ('a, 'c) t -> ('a, 'd) tintersect merge_f m1 m2 returns a map with bindings only for
keys bound in both m1 and m2, and with k bound to merge_f
v1 v2, where v1 and v2 are k's bindings in m1 and m2.
The resulting map uses the comparison function of m1.val merge : ('key -> 'a option -> 'b option -> 'c option) ->
('key, 'a) t -> ('key, 'b) t -> ('key, 'c) tmerge f m1 m2 computes a map whose keys is a subset of keys of m1
and of m2. The presence of each such binding, and the corresponding
value, is determined with the function f.
The resulting map uses the comparison function of m1.val compare : ('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int
val equal : ('b -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t -> boolmodule Exceptionless:sig..end
module Infix:sig..end
BatPMap
val (-->) : ('a, 'b) t -> 'a -> 'bval (<--) : ('a, 'b) t -> 'a * 'b -> ('a, 'b) t
val bindings : ('key, 'a) t -> ('key * 'a) list
Added for compatibility with stdlib 3.12
val print : ?first:string ->
?last:string ->
?sep:string ->
?kvsep:string ->
('a BatInnerIO.output -> 'b -> unit) ->
('a BatInnerIO.output -> 'c -> unit) ->
'a BatInnerIO.output -> ('b, 'c) t -> unit
module PMap:sig..end