package ocaml-base-compiler

  1. Overview
  2. Docs
Official release 4.14.4

Install 

dune-project
 Dependency

ocaml.org Edit opam file Versions (30)

Authors

  1. Xavier Leroy

Maintainers

  1. David Allsopp
  2. F
    Florian Angeletti <florian.angeletti@inria.fr>

Sources

ocaml_4.14.4.tar.gz
sha256=71415c000ebfce604defafaa584ab5ed10ad81ff180897db4e6fea8dac6e4b0d

doc/stdlib/Stdlib/Ephemeron/K1/Make/index.html

Module K1.MakeSource

Functor building an implementation of a weak hash table

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.

Parameters

Signature

Sourcetype key = H.t
Sourcetype !'a t
Sourceval create : int -> 'a t
Sourceval clear : 'a t -> unit
Sourceval reset : 'a t -> unit
Sourceval copy : 'a t -> 'a t
Sourceval add : 'a t -> key -> 'a -> unit
Sourceval remove : 'a t -> key -> unit
Sourceval find : 'a t -> key -> 'a
Sourceval find_opt : 'a t -> key -> 'a option
Sourceval find_all : 'a t -> key -> 'a list
Sourceval replace : 'a t -> key -> 'a -> unit
Sourceval mem : 'a t -> key -> bool
Sourceval iter : (key -> 'a -> unit) -> 'a t -> unit
  • alert old_ephemeron_api This function won't be available in 5.0
Sourceval filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
  • alert old_ephemeron_api This function won't be available in 5.0
Sourceval fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
  • alert old_ephemeron_api This function won't be available in 5.0
Sourceval length : 'a t -> int
Sourceval stats : 'a t -> Hashtbl.statistics
Sourceval to_seq : 'a t -> (key * 'a) Seq.t
  • alert old_ephemeron_api This function won't be available in 5.0
Sourceval to_seq_keys : _ t -> key Seq.t
  • alert old_ephemeron_api This function won't be available in 5.0
Sourceval to_seq_values : 'a t -> 'a Seq.t
  • alert old_ephemeron_api This function won't be available in 5.0
Sourceval add_seq : 'a t -> (key * 'a) Seq.t -> unit
Sourceval replace_seq : 'a t -> (key * 'a) Seq.t -> unit
Sourceval of_seq : (key * 'a) Seq.t -> 'a t
Sourceval clean : 'a t -> unit

remove all dead bindings. Done automatically during automatic resizing.

Sourceval stats_alive : 'a t -> Hashtbl.statistics

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