hamt 1.0.0 (latest) · OCaml Package

Output signature of the Make module.

Parameters

module Key : Hashtbl.HashedType

Signature

type key = Key.t

The type of the Hamt keys.

type 'a t

The type of tables from type key to type 'a.

val empty : 'a t

The empty table.

val is_empty : 'a t -> bool

Tests whether a table is empty or not.

val singleton : key -> 'a -> 'a t

Creates a new table with a single binding.

val cardinal : 'a t -> int

Returns the number of bindings of a table.

val length : 'a t -> int

alias of cardinal

Modify bindings

val alter : key -> ('a option -> 'a option) -> 'a t -> 'a t

alter k f t adds, modifies or deletes the binding from the key k in t, returning the new table. If such a binding exists in t to a value v, f is given Some v, otherwise None. The presence of the binding from k in the result is determined the same way by f.

val add : key -> 'a -> 'a t -> 'a t

Adds a binding to a map, returning the new map. If the binding already existed, the older one disappears.

val add_carry : key -> 'a -> 'a t -> 'a t * 'a option

add_carry k v t adds a binding to t, returning the new table and optionnally the value previously bound to k.

val remove : key -> 'a t -> 'a t

Removes a binding from a table, returning the new table.

extract, update and modify raise Not_found if the corresponding binding is not present in their table parameter.

val extract : key -> 'a t -> 'a * 'a t

extract k t removes the binding with the key k from t, returning the value previously bound from k and the new table.

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

update k f t updates the binding from k in t, optionnally deleting it, and returns the new table.

val modify : key -> ('a -> 'a) -> 'a t -> 'a t

modify k f t modifies the binding from k in t, and returns the new table.

val modify_def : 'a -> key -> ('a -> 'a) -> 'a t -> 'a t

modify_def v0 k f t modifies the binding from k in t. If no value is bound from k, the default one v0 is used by f.

Getting elements

val find_exn : key -> 'a t -> 'a

find k t returns the value bound from the key k in t. If there is no such binding, Not_found is raised.

val mem : key -> 'a t -> bool

Checks for the presence of a binding from a key in a table.

val choose : 'a t -> key * 'a

Returns a binding from a table, which one is unspecified. If the table is Empty, raises Not_found.

val pop : 'a t -> (key * 'a) * 'a t

Removes a binding from a table, returning a pair constituted of this binding and the table without it. If the table is Empty, raises Not_found.

Iterators

val keys : 'a t -> key list

Returns the list of the keys of a table (order unspecified).

val values : 'a t -> 'a list

Returns the list of the values of a table (order unspecified).

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

Returns the list of the bindings (key, value) of a table (order unspecified).

val iter : (key -> 'a -> unit) -> 'a t -> unit

Iterates the application of a function over the bindings of a table.

val map : ('a -> 'b) -> 'a t -> 'b t

map f t returns the table with the same keys as t, where all value v in t has been replaced by f v.

val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t

mapi f t returns the table with the same keys as t, where all value v of t bound from the key k has been replaced by f k v.

val filterv : ('a -> bool) -> 'a t -> 'a t

filterv f t returns a table whose bindings are the bindings of t to a value v where f v = true.

val filter : (key -> 'a -> bool) -> 'a t -> 'a t

filter f t returns a table whose bindings are the bindings of t from a key k to a value v where f k v = true.

val filter_map : (key -> 'a -> 'b option) -> 'a t -> 'b t

Combines the features of filter and map. filter_map f t returns a table where there is a binding from a key k to a value v if and only if there is a binding from k to a value w in t where f k w = Some v.

val foldv : ('a -> 'b -> 'b) -> 'a t -> 'b -> 'b

fold f t x computes (f vN ... (f v1 (f v0 x))) where v0, v1, ..., vN are the values bound in t, provided in unspecified order.

val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b

fold f t x computes (f kN vN ... (f k1 v1 (f k0 v0 x))) where k0, k1, ..., kN are the keys of t and v0, v1, ..., vN the values associated to these keys. The order in which the bindings are provided to f is unspecified.

Scanning

val for_all : (key -> 'a -> bool) -> 'a t -> bool

for_all f t returns true if f k v is true for all binding from k to v in t, false otherwise.

val exists : (key -> 'a -> bool) -> 'a t -> bool

exists f t returns true if f k v is true for at least one binding from k to v in t, false otherwise.

val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t

partition f t returns a pair (t1, t2) where t1 is composed of the bindings of t satisfying the predicate f, and t2 of the bindings which do not.

Merging

val intersecti : (key -> 'a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t

intersecti f t1 t2 returns a table with bindings only from keys k found in t1 and t2, and to values v = f k v1 v2 if k is bound to v1 in t1 and to v2 in t2.

val intersect : ('a -> 'b -> 'c) -> 'a t -> 'b t -> 'c t

intersecti f t1 t2 returns a table with bindings only from keys k found in t1 and t2, and to values v = f v1 v2 if k is bound to v1 in t1 and to v2 in t2.

val merge : 
  (key -> 'a option -> 'b option -> 'c option) ->
  'a t ->
  'b t ->
  'c t

merge f t1 t2 returns a table whose keys is a subset of the keys of t1 and t2. The presence in the result of each such binding, and its corresponding value, are determined by the function f.

val union : 'a t -> 'a t -> 'a t

union t1 t2 returns a table whose keys are all keys presents in t1 or in t2. If the key is present in both tables, the corresponding value is the one bound in t2.

val union_f : (key -> 'a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t

union_f f t1 t2 returns a table whose keys are all keys presents in t1 or in t2. If a key k is present in only one table, the corresponding value is chosen in the result. If it is bound to v1 in t1 and v2 in t2, the value in the result is f k v1 v2.

Importing values from another structure

The Import module is used to transform a full big set of data into a Hamt. It uses internal mechanisms relying on the implementation of the Hamt structure to provide faster imports than adding the bindings of the imported structure element by element. However, if you want to import a data structure into a Hamt which is already a lot bigger, you should consider adding the elements with the usual fonctions of Make. At which size difference the faster method is switched is not yet determined and must be analysed in your own case.

module Import : sig ... end

Alternative operations

module ExceptionLess : sig ... end

Operations without exceptions.

module Infix : sig ... end

Infix operations.

package hamt