jon.recoil.org

Module C.Map

include Flambda2_algorithms.Container_types_intf.Map with type key = C.t with module Set = C.Set
type key = C.t
module Set = C.Set
type !+'a t
val empty : 'a C.Map.t
val is_empty : 'a C.Map.t -> bool
val mem : C.Map.key -> 'a C.Map.t -> bool
val add : C.Map.key -> 'a -> 'a C.Map.t -> 'a C.Map.t
val update : C.Map.key -> ('a option -> 'a option) -> 'a C.Map.t -> 'a C.Map.t
val singleton : C.Map.key -> 'a -> 'a C.Map.t
val remove : C.Map.key -> 'a C.Map.t -> 'a C.Map.t
val merge : (C.Map.key -> 'a option -> 'b option -> 'c option) -> 'a C.Map.t -> 'b C.Map.t -> 'c C.Map.t
val union : (C.Map.key -> 'a -> 'a -> 'a option) -> 'a C.Map.t -> 'a C.Map.t -> 'a C.Map.t
val union_sharing : (C.Map.key -> 'a -> 'a -> 'a option) -> 'a C.Map.t -> 'a C.Map.t -> 'a C.Map.t

union_sharing f m1 m2 is a version of union f m1 m2 that maximizes sharing of the result with m1.

val union_shared : (C.Map.key -> 'a -> 'a -> 'a option) -> 'a C.Map.t -> 'a C.Map.t -> 'a C.Map.t

union_shared f m1 m2 is a version of union_sharing f m1 m2 that also exploits sharing of m1 and m2 to avoid calling f when possible, assuming that f x x = Some x for all xs.

val update_many : (C.Map.key -> 'a option -> 'b -> 'a option) -> 'a C.Map.t -> 'b C.Map.t -> 'a C.Map.t
val compare : ('a -> 'a -> int) -> 'a C.Map.t -> 'a C.Map.t -> int
val equal : ('a -> 'a -> bool) -> 'a C.Map.t -> 'a C.Map.t -> bool
val iter : (C.Map.key -> 'a -> unit) -> 'a C.Map.t -> unit
val fold : (C.Map.key -> 'a -> 'b -> 'b) -> 'a C.Map.t -> 'b -> 'b
val for_all : (C.Map.key -> 'a -> bool) -> 'a C.Map.t -> bool
val exists : (C.Map.key -> 'a -> bool) -> 'a C.Map.t -> bool
val filter : (C.Map.key -> 'a -> bool) -> 'a C.Map.t -> 'a C.Map.t
val filter_map : (C.Map.key -> 'a -> 'b option) -> 'a C.Map.t -> 'b C.Map.t
val filter_map_sharing : (C.Map.key -> 'a -> 'a option) -> 'a C.Map.t -> 'a C.Map.t
val partition : (C.Map.key -> 'a -> bool) -> 'a C.Map.t -> 'a C.Map.t * 'a C.Map.t
val cardinal : 'a C.Map.t -> int
val bindings : 'a C.Map.t -> (C.Map.key * 'a) list
val min_binding : 'a C.Map.t -> C.Map.key * 'a
val min_binding_opt : 'a C.Map.t -> (C.Map.key * 'a) option
val max_binding : 'a C.Map.t -> C.Map.key * 'a
val max_binding_opt : 'a C.Map.t -> (C.Map.key * 'a) option
val choose : 'a C.Map.t -> C.Map.key * 'a
val choose_opt : 'a C.Map.t -> (C.Map.key * 'a) option
val split : C.Map.key -> 'a C.Map.t -> 'a C.Map.t * 'a option * 'a C.Map.t
val find : C.Map.key -> 'a C.Map.t -> 'a
val find_opt : C.Map.key -> 'a C.Map.t -> 'a option
val map : ('a -> 'b) -> 'a C.Map.t -> 'b C.Map.t
val mapi : (C.Map.key -> 'a -> 'b) -> 'a C.Map.t -> 'b C.Map.t
val to_seq : 'a C.Map.t -> (C.Map.key * 'a) Stdlib.Seq.t
val print_debug : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a C.Map.t -> unit
val of_list : (C.Map.key * 'a) list -> 'a C.Map.t
val disjoint_union : ?eq:('a -> 'a -> bool) -> ?print:(Stdlib.Format.formatter -> 'a -> unit) -> 'a C.Map.t -> 'a C.Map.t -> 'a C.Map.t
val map_keys : (C.Map.key -> C.Map.key) -> 'a C.Map.t -> 'a C.Map.t
val keys : 'a C.Map.t -> Set.t
val data : 'a C.Map.t -> 'a list
val of_set : (C.Map.key -> 'a) -> Set.t -> 'a C.Map.t
val print : (Stdlib.Format.formatter -> 'a -> unit) -> Stdlib.Format.formatter -> 'a C.Map.t -> unit
val diff_domains : 'a C.Map.t -> 'b C.Map.t -> 'a C.Map.t
val inter : (C.Map.key -> 'a -> 'b -> 'c) -> 'a C.Map.t -> 'b C.Map.t -> 'c C.Map.t
val diff : (C.Map.key -> 'a -> 'b -> 'a option) -> 'a C.Map.t -> 'b C.Map.t -> 'a C.Map.t

diff f m1 m2 computes a map whose keys are a subset of the keys of m1. When a binding is defined in both m1 and m2, the function f is used to combine them. Bindings that are only present in m1 are preserved. This is a special case of merge: diff f m1 m2 is equivalent to merge f' m1 m2, where

  • f' _key None _ = None
  • f' _key (Some v) None = Some v
  • f' key (Some v1) (Some v2) = f key v1 v2
val diff_sharing : (C.Map.key -> 'a -> 'b -> 'a option) -> 'a C.Map.t -> 'b C.Map.t -> 'a C.Map.t

diff_sharing f m1 m2 is a version of diff f m1 m2 that maximizes sharing of the result with m1.

val diff_shared : (C.Map.key -> 'a -> 'a -> 'a option) -> 'a C.Map.t -> 'a C.Map.t -> 'a C.Map.t

diff_shared f m1 m2 is a version of diff_sharing f m1 m2 that further exploits sharing of m1 and m2 to avoid calling f when possible, assuming that f x x always returns None.

val inter_domain_is_non_empty : 'a C.Map.t -> 'a C.Map.t -> bool
val get_singleton : 'a C.Map.t -> (C.Map.key * 'a) option
val replace : C.Map.key -> ('a -> 'a) -> 'a C.Map.t -> 'a C.Map.t
val map_sharing : ('a -> 'a) -> 'a C.Map.t -> 'a C.Map.t
type 'a iterator

An 'a iterator iterates over the values in a 'a t map in increasing order.

val iterator : 'a C.Map.t -> 'a C.Map.iterator

iterator t returns an iterator for all the bindings in t, initially positioned on min_binding t.

val current : 'a C.Map.iterator -> (C.Map.key * 'a) option

current iterator returns the key-value pair at the current position, or None if the iterator is exhausted.

val advance : 'a C.Map.iterator -> 'a C.Map.iterator

advance iterator position the iterator on the next key.

val seek : 'a C.Map.iterator -> C.Map.key -> 'a C.Map.iterator

seek iterator key positions the iterator on the next key higher or equal to the provided key.

Note: does nothing if key is less than or equal to the current key.