include module type of BatMap with module PMap := BatMap.PMapmodule type S = sig ... endAssociation tables over ordered types.
Functor building an implementation of the map structure given a totally ordered type.
*
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 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 Make.
val empty : ('a, 'b) tThe empty map, using compare as key comparison function.
val is_empty : ('a, 'b) t -> boolReturns true if the map is empty.
val singleton : 'a -> 'b -> ('a, 'b) tCreates a new map with a single binding.
val cardinal : ('a, 'b) t -> intReturn the number of bindings of a map.
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.
update 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.
val find_opt : 'a -> ('a, 'b) t -> 'b optionfind_opt x m returns Some b where b is the current binding * of x in m, or None if no such binding exists.
val find_default : 'b -> 'a -> ('a, 'b) t -> 'bfind_default d x m returns the current binding of x in m, or the default value d if no such binding exists.
remove x m returns a map containing the same bindings as m, except for x which is unbound in the returned map. The returned map compares equal to the passed one if x was already unbound.
remove_exn x m behaves like remove x m except that it raises an exception if x is unbound in m.
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.
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.
Same as map, 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 -> 'cSame as fold, 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).
filterv 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.
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.
filter_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 (keyi, bi) pairs such as f keyi ai = Some bi (when f returns None, the corresponding element of m is discarded).
split 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 * 'aReturns the binding with the smallest key.
Returns the binding with the smallest key along with the rest of the map.
val max_binding : ('key, 'a) t -> 'key * 'aReturns the binding with the largest key.
Returns the binding with the largest key along with the rest of the map.
Creates an enumeration for this map, enumerating (key, value) pairs with the keys in increasing order.
Creates an enumeration for this map, enumerating (key, value) pairs with the keys in decreasing order.
val for_all : ('a -> 'b -> bool) -> ('a, 'b) t -> boolTests whether all (key, value) pairs satisfy a predicate function.
val exists : ('a -> 'b -> bool) -> ('a, 'b) t -> boolTests whether some (key, value) pair satisfies a predicate function.
partition 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.
add_carry k v m adds the binding (k, v) to m, returning the new map and optionally the previous value bound to k.
modify 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.
modify_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).
modify_opt k f m allow to modify the binding for k in m or absence thereof.
extract k m removes the current binding of k from m, returning the value k was bound to and the updated m.
pop m returns a binding from m and m without that binding.
union 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.
diff 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.
intersect 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.
Construct a comparison or equality function for maps based on a value comparison or equality function. Uses the key comparison function to compare keys
module Exceptionless : sig ... endExceptionless versions of functions
module Infix : sig ... endInfix operators over a BatPMap
val (-->) : ('a, 'b) t -> 'a -> 'bMap find and insert from Infix
val bindings : ('key, 'a) t -> ('key * 'a) listReturn the list of all bindings of the given map. The returned list is sorted in increasing key order.
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 ->
unitinclude module type of struct include Exceptionless endval find : 'a -> ('a, 'b) t -> 'b optionval choose : ('a, 'b) t -> ('a * 'b) optionval any : ('a, 'b) t -> ('a * 'b) optionmodule PMap : sig ... end