Module type Ephemeron.S

The output signature of the functor K1.Make and K2.Make. These hash tables are weak in the keys. If all the keys of a binding are alive the binding is kept, but if one of the keys of the binding is dead then the binding is removed.

include Stdlib.Hashtbl.S
type key
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
since
4.00.0
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
since
4.05.0
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
since
4.03.0
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Stdlib.Hashtbl.statistics
since
4.00.0
val to_seq : 'a t -> (key * 'a) Stdlib.Seq.t
since
4.07
val to_seq_keys : _ t -> key Stdlib.Seq.t
since
4.07
val to_seq_values : 'a t -> 'a Stdlib.Seq.t
since
4.07
val add_seq : 'a t -> (key * 'a) Stdlib.Seq.t -> unit
since
4.07
val replace_seq : 'a t -> (key * 'a) Stdlib.Seq.t -> unit
since
4.07
val of_seq : (key * 'a) Stdlib.Seq.t -> 'a t
since
4.07
val clean : 'a t -> unit

remove all dead bindings. Done automatically during automatic resizing.

val stats_alive : 'a t -> Stdlib.Hashtbl.statistics

same as Hashtbl.SeededS.stats but only count the alive bindings