package containers

get tbl k finds a binding for the key k if present, or returns None if no value is found. Safe version of Hashtbl.find.

get_or tbl k ~default returns the value associated to k if present, and returns default otherwise (if k doesn't belong in tbl).

• since 0.16

keys tbl f iterates on keys (similar order as Hashtbl.iter).

values tbl f iterates on values in the table tbl.

keys_list tbl is the list of keys in tbl. If the key is in the Hashtable multiple times, all occurrences will be returned.

• since 0.8

values_list tbl is the list of values in tbl.

• since 0.8

map_list f tbl maps on a tbl's items. Collect into a list.

incr ?by tbl x increments or initializes the counter associated with x. If get tbl x = None, then after update, get tbl x = Some 1; otherwise, if get tbl x = Some n, now get tbl x = Some (n+1).

• parameter by

  if specified, the int value is incremented by by rather than 1.

• since 0.16

decr ?by tbl x is like incr but subtract 1 (or the value of by). 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

Iterate on bindings in the table.

• since 2.8

add_list tbl x y adds y to the list x is bound to. If x is not bound, it becomes bound to y.

• since 0.16

Add the corresponding pairs to the table, using Hashtbl.add.

• since 2.8

Add the corresponding pairs to the table, using Hashtbl.add. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

• since 3.3

Add the corresponding pairs to the table, using Hashtbl.add. Renamed from add_std_seq since 3.0.

• since 3.0

Add the corresponding pairs to the table. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

• since 3.3

From the given bindings, added in order.

• since 2.8

From the given bindings, added in order. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

• since 3.3

From the given bindings, added in order. Renamed from of_std_seq since 3.0.

• since 3.0

From the given bindings, added in order. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

• since 3.3

add_iter_count tbl i increments the count of each element of i by calling incr. This is useful for counting how many times each element of i occurs.

• since 2.8

add_seq_count tbl seq increments the count of each element of seq by calling incr. This is useful for counting how many times each element of seq occurs. Renamed from add_std_seq_count since 3.0.

• since 3.0

Like add_seq_count, but allocates a new table and returns it.

• since 2.8

Like add_seq_count, but allocates a new table and returns it. Renamed from of_std_seq_count since 3.0.

• since 3.0

to_list tbl returns the list of (key,value) bindings (order unspecified).

of_list l builds a table from the given list l of bindings k_i -> v_i, added in order using add. If a key occurs several times, it will be added several times, and the visible binding will be the last one.

From the given bindings, added in order. If a key occurs multiple times in the input, the values are combined using f in an unspecified order.

• since 3.3

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

get_or_add tbl ~k ~f finds and returns the binding of k in tbl, if it exists. If it does not exist, then f k is called to obtain a new binding v; k -> v is added to tbl and v is returned.

• since 1.0

pp ~pp_start ~pp_stop ~pp_sep ~pp arrow pp_k pp_v returns a table printer given a pp_k printer for individual key and a pp_v printer for individual value. pp_start and pp_stop control the opening and closing delimiters, by default print nothing. pp_sep control the separator between binding. pp_arrow control the arrow between the key and value. Renamed from print since 2.0.

• since 0.13