package containers

  1. Overview
  2. Docs
A modular, clean and powerful extension of the OCaml standard library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (23)

Authors

  1. S
    Simon Cruanes

Maintainers

  1. S
    simon.cruanes.2007@m4x.org

Sources

v2.8.tar.gz
md5=03b80e963186e91ddac62ef645bf7fb2
sha512=c8f434808be540c16926bf03d89f394d33fc2d092f963a7b6d412481229e0a96290f1ad7c7d522415115d35426b7aa0b3fda4b991ddc321dad279d402c9a0c0b

doc/containers.data/CCPersistentHashtbl/module-type-S/index.html

Module type CCPersistentHashtbl.SSource

Sourcetype key
Sourcetype 'a t
Sourceval empty : unit -> 'a t

Empty table. The table will be allocated at the first binding.

Sourceval create : int -> 'a t

Create a new hashtable, with the given initial capacity.

Sourceval is_empty : 'a t -> bool

Is the table empty?

Sourceval find : 'a t -> key -> 'a

Find the value for this key, or fails.

  • raises Not_found

    if the key is not present in the table.

Sourceval get_exn : key -> 'a t -> 'a

Synonym to find with flipped arguments.

Sourceval get : key -> 'a t -> 'a option

Safe version of get_exn.

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

Is the key bound?

Sourceval length : _ t -> int

Number of bindings.

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

Add the binding to the table, returning a new table. The old binding for this key, if it exists, is shadowed and will be restored upon remove tbl k.

  • since 0.14
Sourceval replace : 'a t -> key -> 'a -> 'a t

Add the binding to the table, returning a new table. This erases the current binding for key, if any.

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

update tbl key f calls f None if key doesn't belong in tbl, f (Some v) if key -> v otherwise; If f returns None then key is removed, else it returns Some v' and key -> v' is added.

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

Remove the key.

Sourceval copy : 'a t -> 'a t

Fresh copy of the table; the underlying structure is not shared anymore, so using both tables alternatively will be efficient.

Sourceval merge : f:(key -> [ `Left of 'a | `Right of 'b | `Both of 'a * 'b ] -> 'c option) -> 'a t -> 'b t -> 'c t

Merge two tables together into a new table. The function's argument correspond to values associated with the key (if present); if the function returns None the key will not appear in the result.

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

Iterate over bindings.

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

Fold over bindings.

Sourceval map : (key -> 'a -> 'b) -> 'a t -> 'b t

Map all values.

Sourceval filter : (key -> 'a -> bool) -> 'a t -> 'a t
Sourceval filter_map : (key -> 'a -> 'b option) -> 'a t -> 'b t
Sourceval for_all : (key -> 'a -> bool) -> 'a t -> bool
Sourceval exists : (key -> 'a -> bool) -> 'a t -> bool

Conversions

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

Add (replace) bindings from the sequence to the table.

Sourceval of_list : (key * 'a) list -> 'a t
Sourceval add_seq : 'a t -> (key * 'a) sequence -> 'a t
Sourceval add_list : 'a t -> (key * 'a) list -> 'a t
Sourceval to_seq : 'a t -> (key * 'a) sequence

Iter of the bindings of the table.

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

Misc

Sourceval equal : 'a equal -> 'a t equal
Sourceval pp : ?sep:string -> ?arrow:string -> key printer -> 'a printer -> 'a t printer
Sourceval stats : _ t -> Hashtbl.statistics

Statistics on the internal table.

  • since 0.14