Batteries user guide : Extlib.PMap

`sig
module type S =
sig
type key
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val cardinal : 'a t -> int
val add : key -> 'a -> 'a t -> 'a t
val find : key -> 'a t -> 'a
val remove : key -> 'a t -> 'a t
val modify : key -> ('a -> 'a) -> 'a t -> 'a t
val modify_def : 'a -> key -> ('a -> 'a) -> 'a t -> 'a t
val modify_opt : key -> ('a option -> 'a option) -> 'a t -> 'a t
val extract : key -> 'a t -> 'a * 'a t
val pop : 'a t -> (key * 'a) * 'a t
val mem : key -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val filterv : ('a -> bool) -> 'a t -> 'a t
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val filter_map : (key -> 'a -> 'b option) -> 'a t -> 'b t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val keys : 'a t -> key BatEnum.t
val values : 'a t -> 'a BatEnum.t
val min_binding : 'a t -> key * 'a
val max_binding : 'a t -> key * 'a
val choose : 'a t -> key * 'a
val split : key -> 'a t -> 'a t * 'a option * 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val singleton : key -> 'a -> 'a t
val bindings : 'a t -> (key * 'a) list
val enum : 'a t -> (key * 'a) BatEnum.t
val backwards : 'a t -> (key * 'a) BatEnum.t
val of_enum : (key * 'a) BatEnum.t -> 'a t
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val print :
?first:string ->
?last:string ->
?sep:string ->
?kvsep:string ->
('a BatInnerIO.output -> key -> unit) ->
('a BatInnerIO.output -> 'c -> unit) ->
'a BatInnerIO.output -> 'c t -> unit
module Exceptionless : sig val find : key -> 'a t -> 'a option end
module Infix :
sig
val ( --> ) : 'a t -> key -> 'a
val ( <-- ) : 'a t -> key * 'a -> 'a t
end
module Labels :
sig
val add : key:key -> data:'a -> 'a t -> 'a t
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key:key -> data:'a -> 'b) -> 'a t -> 'b t
val filterv : f:('a -> bool) -> 'a t -> 'a t
val filter : f:(key -> 'a -> bool) -> 'a t -> 'a t
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val compare : cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) -> 'a t -> 'a t -> bool
end
end
module Make :
functor (Ord : BatInterfaces.OrderedType) ->
sig
type key = Ord.t
type 'a t = 'a BatMap.Make(Ord).t
val empty : 'a t
val is_empty : 'a t -> bool
val cardinal : 'a t -> int
val add : key -> 'a -> 'a t -> 'a t
val find : key -> 'a t -> 'a
val remove : key -> 'a t -> 'a t
val modify : key -> ('a -> 'a) -> 'a t -> 'a t
val modify_def : 'a -> key -> ('a -> 'a) -> 'a t -> 'a t
val modify_opt : key -> ('a option -> 'a option) -> 'a t -> 'a t
val extract : key -> 'a t -> 'a * 'a t
val pop : 'a t -> (key * 'a) * 'a t
val mem : key -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val filterv : ('a -> bool) -> 'a t -> 'a t
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val filter_map : (key -> 'a -> 'b option) -> 'a t -> 'b t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val keys : 'a t -> key BatEnum.t
val values : 'a t -> 'a BatEnum.t
val min_binding : 'a t -> key * 'a
val max_binding : 'a t -> key * 'a
val choose : 'a t -> key * 'a
val split : key -> 'a t -> 'a t * 'a option * 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val singleton : key -> 'a -> 'a t
val bindings : 'a t -> (key * 'a) list
val enum : 'a t -> (key * 'a) BatEnum.t
val backwards : 'a t -> (key * 'a) BatEnum.t
val of_enum : (key * 'a) BatEnum.t -> 'a t
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val print :
?first:string ->
?last:string ->
?sep:string ->
?kvsep:string ->
('a BatInnerIO.output -> key -> unit) ->
('a BatInnerIO.output -> 'c -> unit) ->
'a BatInnerIO.output -> 'c t -> unit
module Exceptionless : sig val find : key -> 'a t -> 'a option end
module Infix :
sig
val ( --> ) : 'a t -> key -> 'a
val ( <-- ) : 'a t -> key * 'a -> 'a t
end
module Labels :
sig
val add : key:key -> data:'a -> 'a t -> 'a t
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key:key -> data:'a -> 'b) -> 'a t -> 'b t
val filterv : f:('a -> bool) -> 'a t -> 'a t
val filter : f:(key -> 'a -> bool) -> 'a t -> 'a t
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val compare : cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) -> 'a t -> 'a t -> bool
end
end
type ('a, 'b) t = ('a, 'b) BatMap.t
val empty : ('a, 'b) t
val is_empty : ('a, 'b) t -> bool
val singleton : 'a -> 'b -> ('a, 'b) t
val cardinal : ('a, 'b) t -> int
val add : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) t
val find : 'a -> ('a, 'b) t -> 'b
val remove : 'a -> ('a, 'b) t -> ('a, 'b) t
val mem : 'a -> ('a, 'b) t -> bool
val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unit
val map : ('b -> 'c) -> ('a, 'b) t -> ('a, 'c) t
val mapi : ('a -> 'b -> 'c) -> ('a, 'b) t -> ('a, 'c) t
val fold : ('b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
val foldi : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
val filterv : ('a -> bool) -> ('key, 'a) t -> ('key, 'a) t
val filter : ('key -> 'a -> bool) -> ('key, 'a) t -> ('key, 'a) t
val filter_map : ('key -> 'a -> 'b option) -> ('key, 'a) t -> ('key, 'b) t
val choose : ('key, 'a) t -> 'key * 'a
val split : 'key -> ('key, 'a) t -> ('key, 'a) t * 'a option * ('key, 'a) t
val min_binding : ('key, 'a) t -> 'key * 'a
val max_binding : ('key, 'a) t -> 'key * 'a
val enum : ('a, 'b) t -> ('a * 'b) BatEnum.t
val backwards : ('a, 'b) t -> ('a * 'b) BatEnum.t
val keys : ('a, 'b) t -> 'a BatEnum.t
val values : ('a, 'b) t -> 'b BatEnum.t
val of_enum : ('a * 'b) BatEnum.t -> ('a, 'b) t
val for_all : ('a -> 'b -> bool) -> ('a, 'b) t -> bool
val exists : ('a -> 'b -> bool) -> ('a, 'b) t -> bool
val partition : ('a -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t * ('a, 'b) t
val add_carry : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) t * 'b option
val modify : 'a -> ('b -> 'b) -> ('a, 'b) t -> ('a, 'b) t
val modify_def : 'b -> 'a -> ('b -> 'b) -> ('a, 'b) t -> ('a, 'b) t
val modify_opt : 'a -> ('b option -> 'b option) -> ('a, 'b) t -> ('a, 'b) t
val extract : 'a -> ('a, 'b) t -> 'b * ('a, 'b) t
val pop : ('a, 'b) t -> ('a * 'b) * ('a, 'b) t
val union : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t
val diff : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t
val intersect : ('b -> 'c -> 'd) -> ('a, 'b) t -> ('a, 'c) t -> ('a, 'd) t
val merge :
('key -> 'a option -> 'b option -> 'c option) ->
('key, 'a) t -> ('key, 'b) t -> ('key, 'c) t
val compare : ('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int
val equal : ('b -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool
module Exceptionless : sig val find : 'a -> ('a, 'b) t -> 'b option end
module Infix :
sig
val ( --> ) : ('a, 'b) t -> 'a -> 'b
val ( <-- ) : ('a, 'b) t -> 'a * 'b -> ('a, 'b) t
end
val ( --> ) : ('a, 'b) t -> 'a -> 'b
val ( <-- ) : ('a, 'b) t -> 'a * 'b -> ('a, 'b) t
val bindings : ('key, 'a) t -> ('key * 'a) list
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 type OrderedType = BatInterfaces.OrderedType
module PMap :
sig
type ('a, 'b) t = ('a, 'b) BatMap.PMap.t
val empty : ('a, 'b) t
val is_empty : ('a, 'b) t -> bool
val create : ('a -> 'a -> int) -> ('a, 'b) t
val singleton : ?cmp:('a -> 'a -> int) -> 'a -> 'b -> ('a, 'b) t
val cardinal : ('a, 'b) t -> int
val add : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) t
val find : 'a -> ('a, 'b) t -> 'b
val remove : 'a -> ('a, 'b) t -> ('a, 'b) t
val mem : 'a -> ('a, 'b) t -> bool
val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unit
val map : ('b -> 'c) -> ('a, 'b) t -> ('a, 'c) t
val mapi : ('a -> 'b -> 'c) -> ('a, 'b) t -> ('a, 'c) t
val fold : ('b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
val foldi : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
val filterv : ('a -> bool) -> ('key, 'a) t -> ('key, 'a) t
val filter : ('key -> 'a -> bool) -> ('key, 'a) t -> ('key, 'a) t
val filter_map :
('key -> 'a -> 'b option) -> ('key, 'a) t -> ('key, 'b) t
val choose : ('key, 'a) t -> 'key * 'a
val split :
'key -> ('key, 'a) t -> ('key, 'a) t * 'a option * ('key, 'a) t
val min_binding : ('key, 'a) t -> 'key * 'a
val max_binding : ('key, 'a) t -> 'key * 'a
val enum : ('a, 'b) t -> ('a * 'b) BatEnum.t
val backwards : ('a, 'b) t -> ('a * 'b) BatEnum.t
val keys : ('a, 'b) t -> 'a BatEnum.t
val values : ('a, 'b) t -> 'b BatEnum.t
val of_enum :
?cmp:('a -> 'a -> int) -> ('a * 'b) BatEnum.t -> ('a, 'b) t
val for_all : ('a -> 'b -> bool) -> ('a, 'b) t -> bool
val exists : ('a -> 'b -> bool) -> ('a, 'b) t -> bool
val partition :
('a -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t * ('a, 'b) t
val add_carry : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) t * 'b option
val modify : 'a -> ('b -> 'b) -> ('a, 'b) t -> ('a, 'b) t
val modify_def : 'b -> 'a -> ('b -> 'b) -> ('a, 'b) t -> ('a, 'b) t
val modify_opt :
'a -> ('b option -> 'b option) -> ('a, 'b) t -> ('a, 'b) t
val extract : 'a -> ('a, 'b) t -> 'b * ('a, 'b) t
val pop : ('a, 'b) t -> ('a * 'b) * ('a, 'b) t
val union : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t
val diff : ('a, 'b) t -> ('a, 'b) t -> ('a, 'b) t
val intersect :
('b -> 'c -> 'd) -> ('a, 'b) t -> ('a, 'c) t -> ('a, 'd) t
val merge :
('key -> 'a option -> 'b option -> 'c option) ->
('key, 'a) t -> ('key, 'b) t -> ('key, 'c) t
val merge_unsafe :
('key -> 'a option -> 'b option -> 'c option) ->
('key, 'a) t -> ('key, 'b) t -> ('key, 'c) t
val compare : ('b -> 'b -> int) -> ('a, 'b) t -> ('a, 'b) t -> int
val equal : ('b -> 'b -> bool) -> ('a, 'b) t -> ('a, 'b) t -> bool
module Exceptionless : sig val find : 'a -> ('a, 'b) t -> 'b option end
module Infix :
sig
val ( --> ) : ('a, 'b) t -> 'a -> 'b
val ( <-- ) : ('a, 'b) t -> 'a * 'b -> ('a, 'b) t
end
val ( --> ) : ('a, 'b) t -> 'a -> 'b
val ( <-- ) : ('a, 'b) t -> 'a * 'b -> ('a, 'b) t
val bindings : ('key, 'a) t -> ('key * 'a) list
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
val get_cmp : ('a, 'b) t -> 'a -> 'a -> int
end
end`