package containers

  1. Overview
  2. Docs
package containers
Legend:
Library
Module
Module type
Parameter
Class
Class type
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_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 get : 'a t -> key -> 'a option

Safe version of Hashtbl.find

val keys : 'a t -> key sequence

Iterate on keys (similar order as Hashtbl.iter)

val values : 'a t -> 'a sequence

Iterate on values in the table

val keys_list : ('a, 'b) Hashtbl.t -> 'a list

keys t is the list of keys in t.

  • since 0.8
val values_list : ('a, 'b) Hashtbl.t -> 'b list

values t is the list of values in t.

  • since 0.8
val map_list : (key -> 'a -> 'b) -> 'a t -> 'b list

Map on a hashtable's items, collect into a list

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

Iterate on values in the table

val of_seq : (key * 'a) sequence -> 'a t

From the given bindings, added in order

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

List of bindings (order unspecified)

val of_list : (key * 'a) list -> 'a t

From the given list of bindings, added in order

val update : 'a t -> f:(key -> 'a option -> 'a option) -> k:key -> unit

update tbl ~f ~k updates key k by calling f k (Some v) if k was mapped to v, or f k None otherwise; if the call returns None then k is removed/stays removed, if the call returns Some v' then the binding k -> v' is inserted using Hashtbl.replace

  • since 0.14
val print : key printer -> 'a printer -> 'a t printer

Printer for tables

  • since 0.13
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct