package batteries
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb
doc/batteries.unthreaded/BatMultiPMap/index.html
Module BatMultiPMapSource
Polymorphic Multi-Map.
This is a polymorphic multi-map, i.e. an association from 1 to many.
The empty map, using compare as comparison function for both keys and values.
create kcomp vcomp creates a new empty map, using kcomp for key comparison and vcomp for value comparison.
add x y m returns a map containing the same bindings as m, plus a binding of x to y.
find x m returns the current binding of x in m
remove_all x m returns a map containing the same bindings as m, except for x which is unbound in the returned map.
remove k d m returns a map containing the same bindings as m, except for k which is not bound to d anymore in the returned map. If k was not bound to d, nothing is changed. If the operation removes the last binding of k, then k is also removed from the set of keys.
mem x m returns true if m contains at least a binding for x, and false otherwise.
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 :
('b BatSet.PSet.t -> 'c BatSet.PSet.t) ->
(('b -> 'b -> int) -> 'c -> 'c -> int) ->
('a, 'b) t ->
('a, 'c) tmap f vcompgen 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. vcompgen will use the vcomp function provided to m as an argument to generate a new value comparison function.
val mapi :
('a -> 'b BatSet.PSet.t -> 'c BatSet.PSet.t) ->
(('b -> 'b -> int) -> 'c -> 'c -> int) ->
('a, 'b) t ->
('a, 'c) tSame as map, but the function receives as arguments both the key and the associated value for each binding of the map.
fold 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.
Same as fold, but the function receives as arguments both the key and the associated value for each binding of the map.
modify x f m replaces the binding for x with f applied to these values.
val modify_def :
'b BatSet.PSet.t ->
'a ->
('b BatSet.PSet.t -> 'b BatSet.PSet.t) ->
('a, 'b) t ->
('a, 'b) tmodify_def dfl x f m performs as modify x f m but it adds f dfl in m instead of raising Not_found if x was unbound.
val modify_opt :
'a ->
('b BatSet.PSet.t option -> 'b BatSet.PSet.t option) ->
('a, 'b) t ->
('a, 'b) tmodify_opt x f m allows to modify the bindings for k in m or absence thereof.
val of_enum :
?keys:('a -> 'a -> int) ->
?data:('b -> 'b -> int) ->
('a * 'b) BatEnum.t ->
('a, 'b) tcreates a map from an enumeration, using the specified function for key comparison or compare by default.
Infix operators over a BatMultiPMap
Boilerplate code
Printing
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