Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
include Core.Hashtbl_intf.S_plain
with type ('a, 'b) hashtbl = ('a, 'b) Core.Hashtbl.t
with type key = t
type key = t
type ('a, 'b) hashtbl = ('a, 'b) Core.Hashtbl.t
include Ppx_compare_lib.Equal.S1 with type 'b t := 'b t
val sexp_of_t : ('b -> Sexplib0.Sexp.t) -> 'b t -> Sexplib0.Sexp.t
type ('a, 'b) t_ = 'b t
type 'a key_ = key
val hashable : key Base.Hashable.t
include Base.Invariant.S1 with type 'b t := 'b t
val invariant : ('a -> unit) -> 'a t -> unit
val create :
('a key_, 'b, unit -> ('a, 'b) t_)
Core.Hashtbl_intf.create_options_without_hashable
val of_alist :
('a key_,
'b,
('a key_ * 'b) list ->
[ `Duplicate_key of 'a key_ | `Ok of ('a, 'b) t_ ])
Core.Hashtbl_intf.create_options_without_hashable
val of_alist_report_all_dups :
('a key_,
'b,
('a key_ * 'b) list ->
[ `Duplicate_keys of 'a key_ list | `Ok of ('a, 'b) t_ ])
Core.Hashtbl_intf.create_options_without_hashable
val of_alist_or_error :
('a key_, 'b, ('a key_ * 'b) list -> ('a, 'b) t_ Base.Or_error.t)
Core.Hashtbl_intf.create_options_without_hashable
val of_alist_exn :
('a key_, 'b, ('a key_ * 'b) list -> ('a, 'b) t_)
Core.Hashtbl_intf.create_options_without_hashable
val of_alist_multi :
('a key_, 'b list, ('a key_ * 'b) list -> ('a, 'b list) t_)
Core.Hashtbl_intf.create_options_without_hashable
val create_mapped :
('a key_,
'b,
get_key:('r -> 'a key_) ->
get_data:('r -> 'b) ->
'r list ->
[ `Duplicate_keys of 'a key_ list | `Ok of ('a, 'b) t_ ])
Core.Hashtbl_intf.create_options_without_hashable
val create_with_key :
('a key_,
'r,
get_key:('r -> 'a key_) ->
'r list ->
[ `Duplicate_keys of 'a key_ list | `Ok of ('a, 'r) t_ ])
Core.Hashtbl_intf.create_options_without_hashable
val create_with_key_or_error :
('a key_,
'r,
get_key:('r -> 'a key_) ->
'r list ->
('a, 'r) t_ Base.Or_error.t)
Core.Hashtbl_intf.create_options_without_hashable
val create_with_key_exn :
('a key_, 'r, get_key:('r -> 'a key_) -> 'r list -> ('a, 'r) t_)
Core.Hashtbl_intf.create_options_without_hashable
val group :
('a key_,
'b,
get_key:('r -> 'a key_) ->
get_data:('r -> 'b) ->
combine:('b -> 'b -> 'b) ->
'r list ->
('a, 'b) t_)
Core.Hashtbl_intf.create_options_without_hashable
include Core.Hashtbl_intf.Accessors
with type ('a, 'b) t := ('a, 'b) t_
with type 'a key := 'a key_
include Base.Hashtbl.Accessors
with type ('a, 'b) t := ('a, 'b) t_
with type 'a key := 'a key_
val sexp_of_key : ('a, _) t_ -> 'a key_ -> Base.Sexp.t
val clear : (_, _) t_ -> unit
Attempting to modify (set
, remove
, etc.) the hashtable during iteration (fold
, iter
, iter_keys
, iteri
) will raise an exception.
val iter : (_, 'b) t_ -> f:('b -> unit) -> unit
Iterates over both keys and values.
Example:
let h = Hashtbl.of_alist_exn (module Int) [(1, 4); (5, 6)] in Hashtbl.iteri h ~f:(fun ~key ~data -> print_endline (Printf.sprintf "%d-%d" key data));; 1-4 5-6 - : unit = ()
val exists : (_, 'b) t_ -> f:('b -> bool) -> bool
val for_all : (_, 'b) t_ -> f:('b -> bool) -> bool
val count : (_, 'b) t_ -> f:('b -> bool) -> int
val length : (_, _) t_ -> int
val is_empty : (_, _) t_ -> bool
add
and add_exn
leave the table unchanged if the key was already present.
change t key ~f
changes t
's value for key
to be f (find t key)
.
update t key ~f
is change t key ~f:(fun o -> Some (f o))
.
update_and_return t key ~f
is update
, but returns the result of f o
.
map t f
returns a new table with values replaced by the result of applying f
to the current values.
Example:
let h = Hashtbl.of_alist_exn (module Int) [(1, 4); (5, 6)] in let h' = Hashtbl.map h ~f:(fun x -> x * 2) in Hashtbl.to_alist h';; - : (int * int) list = [(5, 12); (1, 8)]
Like map
, but the function f
takes both key and data as arguments.
Returns a new table by filtering the given table's values by f
: the keys for which f
applied to the current value returns Some
are kept, and those for which it returns None
are discarded.
Example:
let h = Hashtbl.of_alist_exn (module Int) [(1, 4); (5, 6)] in Hashtbl.filter_map h ~f:(fun x -> if x > 5 then Some x else None) |> Hashtbl.to_alist;; - : (int * int) list = [(5, 6)]
Like filter_map
, but the function f
takes both key and data as arguments.
val partition_map :
('a, 'b) t_ ->
f:('b -> ('c, 'd) Base.Either.t) ->
('a, 'c) t_ * ('a, 'd) t_
Returns new tables with bound values partitioned by f
applied to the bound values.
val partition_mapi :
('a, 'b) t_ ->
f:(key:'a key_ -> data:'b -> ('c, 'd) Base.Either.t) ->
('a, 'c) t_ * ('a, 'd) t_
Like partition_map
, but the function f
takes both key and data as arguments.
Returns a pair of tables (t1, t2)
, where t1
contains all the elements of the initial table which satisfy the predicate f
, and t2
contains the rest.
Like partition_tf
, but the function f
takes both key and data as arguments.
find_or_add t k ~default
returns the data associated with key k
if it is in the table t
, and otherwise assigns k
the value returned by default ()
.
Like find_or_add
but default
takes the key as an argument.
find t k
returns Some
(the current binding) of k
in t
, or None
if no such binding exists.
find_exn t k
returns the current binding of k
in t
, or raises Caml.Not_found
or Not_found_s
if no such binding exists.
val find_and_call :
('a, 'b) t_ ->
'a key_ ->
if_found:('b -> 'c) ->
if_not_found:('a key_ -> 'c) ->
'c
find_and_call t k ~if_found ~if_not_found
is equivalent to:
match find t k with Some v -> if_found v | None -> if_not_found k
except that it doesn't allocate the option.
val find_and_call1 :
('a, 'b) t_ ->
'a key_ ->
a:'d ->
if_found:('b -> 'd -> 'c) ->
if_not_found:('a key_ -> 'd -> 'c) ->
'c
Just like find_and_call
, but takes an extra argument which is passed to if_found
and if_not_found
, so that the client code can avoid allocating closures or using refs to pass this additional information. This function is only useful in code which tries to minimize heap allocation.
find_and_remove t k
returns Some (the current binding) of k in t and removes it, or None is no such binding exists.
val merge :
('k, 'a) t_ ->
('k, 'b) t_ ->
f:
(key:'k key_ ->
[ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] ->
'c option) ->
('k, 'c) t_
Merges two hashtables.
The result of merge f h1 h2
has as keys the set of all k
in the union of the sets of keys of h1
and h2
for which d(k)
is not None, where:
d(k) =
f ~key:k (`Left d1)
if k
in h1
maps to d1, and h2
does not have data for k
;f ~key:k (`Right d2)
if k
in h2
maps to d2, and h1
does not have data for k
;f ~key:k (`Both (d1, d2))
otherwise, where k
in h1
maps to d1
and k
in h2
maps to d2
.Each key k
is mapped to a single piece of data x
, where d(k) = Some x
.
Example:
let h1 = Hashtbl.of_alist_exn (module Int) [(1, 5); (2, 3232)] in let h2 = Hashtbl.of_alist_exn (module Int) [(1, 3)] in Hashtbl.merge h1 h2 ~f:(fun ~key:_ -> function | `Left x -> Some (`Left x) | `Right x -> Some (`Right x) | `Both (x, y) -> if x=y then None else Some (`Both (x,y)) ) |> Hashtbl.to_alist;; - : (int * [> `Both of int * int | `Left of int | `Right of int ]) list = [(2, `Left 3232); (1, `Both (5, 3))]
val merge_into :
src:('k, 'a) t_ ->
dst:('k, 'b) t_ ->
f:(key:'k key_ -> 'a -> 'b option -> 'b Base.Hashtbl.Merge_into_action.t) ->
unit
Every key
in src
will be removed or set in dst
according to the return value of f
.
val data : (_, 'b) t_ -> 'b list
Returns the list of all data for given hashtable.
filter_inplace t ~f
removes all the elements from t
that don't satisfy f
.
val filter_inplace : (_, 'b) t_ -> f:('b -> bool) -> unit
val map_inplace : (_, 'b) t_ -> f:('b -> 'b) -> unit
map_inplace t ~f
applies f
to all elements in t
, transforming them in place.
val filter_map_inplace : (_, 'b) t_ -> f:('b -> 'b option) -> unit
filter_map_inplace
combines the effects of map_inplace
and filter_inplace
.
equal f t1 t2
and similar f t1 t2
both return true iff t1
and t2
have the same keys and for all keys k
, f (find_exn t1 k) (find_exn t2 k)
. equal
and similar
only differ in their types.
Returns the list of all (key, data) pairs for given hashtable.
remove_if_zero
's default is false
.
val validate :
name:('a key_ -> Base.String.t) ->
'b Validate.check ->
('a, 'b) t_ Validate.check
include Core.Hashtbl_intf.Multi
with type ('a, 'b) t := ('a, 'b) t_
with type 'a key := 'a key_
add_multi t ~key ~data
if key
is present in the table then cons data
on the list, otherwise add key
with a single element list.
remove_multi t key
updates the table, removing the head of the list bound to key
. If the list has only one element (or is empty) then the binding is removed.
module Provide_of_sexp (Key : sig ... end) : sig ... end
module Provide_bin_io (Key : sig ... end) : sig ... end
include sig ... end
val t_of_sexp : (Sexplib0.Sexp.t -> 'a__002_) -> Sexplib0.Sexp.t -> 'a__002_ t