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/CCWBTree/Make/index.html

Module CCWBTree.MakeSource

Parameters

module X : ORD

Signature

Sourcetype key = X.t
Sourcetype +'a t
Sourceval empty : 'a t
Sourceval is_empty : _ t -> bool
Sourceval singleton : key -> 'a -> 'a t
Sourceval mem : key -> _ t -> bool
Sourceval get : key -> 'a t -> 'a option
Sourceval get_exn : key -> 'a t -> 'a
Sourceval nth : int -> 'a t -> (key * 'a) option

nth i m returns the i-th key, value in the ascending order. Complexity is O(log (cardinal m)).

Sourceval nth_exn : int -> 'a t -> key * 'a
Sourceval get_rank : key -> 'a t -> [ `At of int | `After of int | `First ]

get_rank k m looks for the rank of k in m, i.e. the index of k in the sorted list of bindings of m. let (`At n) = get_rank k m in nth_exn n m = get m k should hold.

  • since 1.4
Sourceval add : key -> 'a -> 'a t -> 'a t
Sourceval remove : key -> 'a t -> 'a t
Sourceval update : key -> ('a option -> 'a option) -> 'a t -> 'a t

update k f m calls f (Some v) if get k m = Some v, f None otherwise. Then, if f returns Some v' it binds k to v', if f returns None it removes k.

Sourceval cardinal : _ t -> int
Sourceval weight : _ t -> int
Sourceval fold : f:('b -> key -> 'a -> 'b) -> x:'b -> 'a t -> 'b
Sourceval mapi : f:(key -> 'a -> 'b) -> 'a t -> 'b t

Map values, giving both key and value. Will use WORD.of_list to rebuild keys.

  • since 0.17
Sourceval map : f:('a -> 'b) -> 'a t -> 'b t

Map values, giving only the value.

  • since 0.17
Sourceval iter : f:(key -> 'a -> unit) -> 'a t -> unit
Sourceval split : key -> 'a t -> 'a t * 'a option * 'a t

split k t returns l, o, r where l is the part of the map with keys smaller than k, r has keys bigger than k, and o = Some v if k, v belonged to the map.

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

Like Map.S.merge.

Sourceval extract_min : 'a t -> key * 'a * 'a t

extract_min m returns k, v, m' where k,v is the pair with the smallest key in m, and m' does not contain k.

Sourceval extract_max : 'a t -> key * 'a * 'a t

extract_max m returns k, v, m' where k,v is the pair with the highest key in m, and m' does not contain k.

Sourceval choose : 'a t -> (key * 'a) option
Sourceval choose_exn : 'a t -> key * 'a
Sourceval random_choose : Random.State.t -> 'a t -> key * 'a

Randomly choose a (key,value) pair within the tree, using weights as probability weights.

Sourceval add_list : 'a t -> (key * 'a) list -> 'a t
Sourceval of_list : (key * 'a) list -> 'a t
Sourceval to_list : 'a t -> (key * 'a) list
Sourceval add_seq : 'a t -> (key * 'a) sequence -> 'a t
Sourceval of_seq : (key * 'a) sequence -> 'a t
Sourceval to_seq : 'a t -> (key * 'a) sequence
Sourceval add_gen : 'a t -> (key * 'a) gen -> 'a t
Sourceval of_gen : (key * 'a) gen -> 'a t
Sourceval to_gen : 'a t -> (key * 'a) gen
Sourceval pp : key printer -> 'a printer -> 'a t printer

Renamed from val print.

  • since 2.0