package ocaml-base-compiler

You can search for identifiers within the package.

in-package search v0.2.0

Official release 4.07.1

Install

Dune Dependency

ocaml.org Edit opam file Versions (66)

Authors

Maintainers

David Allsopp

Sources

4.07.1.tar.gz

sha256=83683ddad54bd23773591a9f757e702fa5cfa2ea1b124d8fe75a73729e592bfe

md5=352fe8d46cb238a26aa10c38bad6ecb6

doc/stdlib/Stdlib/Ephemeron/module-type-S/index.html

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.

Propose the same interface as usual hash table. However since the bindings are weak, even if mem h k is true, a subsequent find h k may raise Not_found because the garbage collector can run between the two.

Moreover, the table shouldn't be modified during a call to iter. Use filter_map_inplace in this case.

include 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 -> Hashtbl.statistics

since 4.00.0

val to_seq : 'a t -> (key * 'a) Seq.t

since 4.07

val to_seq_keys : _ t -> key Seq.t

since 4.07

val to_seq_values : 'a t -> 'a Seq.t

since 4.07

val add_seq : 'a t -> (key * 'a) Seq.t -> unit

since 4.07

val replace_seq : 'a t -> (key * 'a) Seq.t -> unit

since 4.07

val of_seq : (key * 'a) 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 -> Hashtbl.statistics

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