package containers

You can search for identifiers within the package.

in-package search v0.2.0

A modular, clean and powerful extension of the OCaml standard library

Install

Dune Dependency

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

Authors

S

Simon Cruanes

Maintainers

S

simon.cruanes.2007@m4x.org

Sources

v2.8.tar.gz

md5=03b80e963186e91ddac62ef645bf7fb2

sha512=c8f434808be540c16926bf03d89f394d33fc2d092f963a7b6d412481229e0a96290f1ad7c7d522415115d35426b7aa0b3fda4b991ddc321dad279d402c9a0c0b

doc/containers.data/CCMixset/index.html

Module `CCMixset`Source

Set of Heterogeneous Values

  let k1 : int key = newkey () in
  let k2 : int key = newkey () in
  let k3 : string key = newkey () in
  let set =
    empty
    |> set ~key:k1 1
    |> set ~key:k2 2
    |> set ~key:k3 "3"
  in
  assert (get ~key:k1 set = Some 1);
  assert (get ~key:k2 set = Some 2);
  assert (get ~key:k3 set = Some "3");
  ()

since 0.11

Sourcetype t

A set of values of heterogeneous types

Sourcetype 'a key

A unique "key" to access a value of type 'a in a set

Sourceval newkey : unit -> 'a key

newkey () creates a new unique key that can be used to access a 'a value in a set. Each key created with newkey is distinct from any other key, even if they have the same type.

Not thread-safe.

Sourceval empty : t

Empty set.

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

set ~key v set maps key to v in set. It means that for every set, get ~key (set ~key v set) = Some v.

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

get ~key set obtains the value for key in set, if any.

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

Same as get, but can fail.

raises Not_found
if the key is not present.

Sourceval cardinal : t -> int

Number of mappings.

On This Page

Set of Heterogeneous Values