Module type CCHashtbl.S
include Stdlib.Hashtbl.S
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
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
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
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Stdlib.Hashtbl.statistics
val to_seq : 'a t -> (key * 'a) Stdlib.Seq.t
val to_seq_keys : 'a t -> key Stdlib.Seq.t
val to_seq_values : 'a t -> 'a Stdlib.Seq.t
val add_seq : 'a t -> (key * 'a) Stdlib.Seq.t -> unit
val replace_seq : 'a t -> (key * 'a) Stdlib.Seq.t -> unit
val of_seq : (key * 'a) Stdlib.Seq.t -> 'a t
val get_or : 'a t -> key -> default:'a -> 'a
get_or tbl k ~default
returns the value associated tok
if present, and returnsdefault
otherwise (ifk
doesn't belong intbl
).- since
- 0.16
val add_list : 'a list t -> key -> 'a -> unit
add_list tbl x y
addsy
to the listx
is bound to. Ifx
is not bound, it becomes bound toy
.- since
- 0.16
val incr : ?by:int -> int t -> key -> unit
incr ?by tbl x
increments or initializes the counter associated withx
. Ifget tbl x = None
, then after update,get tbl x = Some 1
; otherwise, ifget tbl x = Some n
, nowget tbl x = Some (n+1)
.- parameter by
if specified, the int value is incremented by
by
rather than 1.
- since
- 0.16
val decr : ?by:int -> int t -> key -> unit
Like
incr
but subtract 1 (or the value ofby
). If the value reaches 0, the key is removed from the table. This does nothing if the key is not already present in the table.- since
- 0.16
val keys_list : _ t -> key list
keys_list t
is the list of keys int
. If the key is in the Hashtable multiple times, all occurrences will be returned.- since
- 0.8
val values_list : 'a t -> 'a list
values_list t
is the list of values int
.- since
- 0.8
val add_seq : 'a t -> (key * 'a) sequence -> unit
Add the corresponding pairs to the table, using
Hashtbl
.add.- since
- 0.16
val add_seq_count : int t -> key sequence -> unit
add_seq_count tbl seq
increments the count of each element ofseq
by callingincr
. This is useful for counting how many times each element ofseq
occurs.- since
- 0.16
val of_seq_count : key sequence -> int t
Like
add_seq_count
, but allocates a new table and returns it.- since
- 0.16
val of_list : (key * 'a) list -> 'a t
Build a table from the given list of bindings
k_i -> v_i
, added in order usingadd
. If a key occurs several times, it will be added several times, and the visible binding will be the last one.
val update : 'a t -> f:(key -> 'a option -> 'a option) -> k:key -> unit
update tbl ~f ~k
updates keyk
by callingf k (Some v)
ifk
was mapped tov
, orf k None
otherwise; if the call returnsNone
thenk
is removed/stays removed, if the call returnsSome v'
then the bindingk -> v'
is inserted usingHashtbl
.replace.- since
- 0.14