Module Prelude.Hashtbl

This is Ocaml's standard Hashtbl with some additional functions.

include module type of struct include Stdlib.Hashtbl end
type (!'a, !'b) t = ('a, 'b) Stdlib__Hashtbl.t
val create : ?random:bool -> int -> ('a, 'b) t
val clear : ('a, 'b) t -> unit
val reset : ('a, 'b) t -> unit
val copy : ('a, 'b) t -> ('a, 'b) t
val add : ('a, 'b) t -> 'a -> 'b -> unit
val find : ('a, 'b) t -> 'a -> 'b
val find_opt : ('a, 'b) t -> 'a -> 'b option
val find_all : ('a, 'b) t -> 'a -> 'b list
val mem : ('a, 'b) t -> 'a -> bool
val remove : ('a, 'b) t -> 'a -> unit
val replace : ('a, 'b) t -> 'a -> 'b -> unit
val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unit
val filter_map_inplace : ('a -> 'b -> 'b option) -> ('a, 'b) t -> unit
val fold : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
val length : ('a, 'b) t -> int
val randomize : unit -> unit
val is_randomized : unit -> bool
val rebuild : ?random:bool -> ('a, 'b) t -> ('a, 'b) t
type statistics = Stdlib__Hashtbl.statistics = {
  1. num_bindings : int;
  2. num_buckets : int;
  3. max_bucket_length : int;
  4. bucket_histogram : int array;
}
val stats : ('a, 'b) t -> statistics
val to_seq : ('a, 'b) t -> ('a * 'b) Stdlib.Seq.t
val to_seq_keys : ('a, 'b) t -> 'a Stdlib.Seq.t
val to_seq_values : ('a, 'b) t -> 'b Stdlib.Seq.t
val add_seq : ('a, 'b) t -> ('a * 'b) Stdlib.Seq.t -> unit
val replace_seq : ('a, 'b) t -> ('a * 'b) Stdlib.Seq.t -> unit
val of_seq : ('a * 'b) Stdlib.Seq.t -> ('a, 'b) t
module type HashedType = sig ... end
module type S = sig ... end
module Make : sig ... end
module type SeededHashedType = sig ... end
module type SeededS = sig ... end
module MakeSeeded : sig ... end
val hash : 'a -> int
val seeded_hash : int -> 'a -> int
val hash_param : int -> int -> 'a -> int
val seeded_hash_param : int -> int -> int -> 'a -> int
val of_list : ('a * 'b) list -> ('a, 'b) Stdlib.Hashtbl.t

(of_list alist) is the hash table that's equivalent to the alist.

val to_list : ('a, 'b) t -> ('a * 'b) list

(to_list ht) is the alist that's equivalent to the hash table.

Invariant:

  • (of_list xs |> to_list |> sort compare) = (sort compare xs)
val adjoin : ('a -> 'b -> 'b) -> 'b -> ('c, 'b) Stdlib__Hashtbl.t -> 'c -> 'a -> unit

(adjoin vadd empty) returns a function (f ht k v) that adjoins v to a collection of values associated with key k in hash table ht.

See Map.Make.adjoin for a discussion and example.

val classify : ('a -> ('a, 'b) Stdlib__Hashtbl.t) -> ('c -> 'b -> 'b) -> 'b -> 'a -> 'c -> unit

(classify f vadd empty) is a classifying adjoiner.

val random : ?size:(unit -> Int.t) -> key:(unit -> 'a) -> value:(unit -> 'b) -> unit -> ('a, 'b) t

(random ?size ~key ~value ()) is a random hash table of size (size ()) (default: < 100), and each binding is given by (key (), value ()).