package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

v3.7.1.tar.gz
md5=d02c4f044e53edca010de46f9139ce00
sha512=99a5afa3604c4cf0c849c670111d617f7f255acb0da043b73ddffdf0e299948bce52516ee31921f269de6088156c4e0a187e0b931543c6819c6b25966b303281

doc/batteries.unthreaded/BatHashcons/MakeTable/index.html

Module BatHashcons.MakeTableSource

Parameters

Signature

Sourcetype key = HT.t

type of objects in the table

Sourcetype t

type of the table

Sourceval create : int -> t

create n creates a table with at least n cells.

Sourceval clear : t -> unit

clear tab removes all entries from the table tab.

Sourceval hashcons : t -> key -> key hobj

hashcons tab k returns either k, adding it to the table tab as a side effect, or if k is already in the table then it returns the hashed object corresponding to that entry.

  • raises Failure

    if number of objects with the same hash reaches system limit of array size

Sourceval iter : (key hobj -> unit) -> t -> unit

iter f tab applies f to every live hashed object in the table tab.

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

fold f tab x0 folds f across every live hashed object in the table tab, starting with value x0

Sourceval count : t -> int

count tab returns a count of how many live objects are in tab. This can decrease whenever the GC runs, even during execution, so consider the returned value as an upper-bound.