package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

Dune Dependency

github.com Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.5.1.tar.gz

md5=d3d16ffc960e832a1c0e21b7123194e9

sha512=36c8561079aa9fefc864c2f03bd8ae20aa05987bb67e7a9beac3ab4f440dbf7d44f141c172b05fddb1a5b618fc55a27962bb45fc39bd7b3a15d56e0ed3ff3870

doc/batteries.unthreaded/BatUref/index.html

Module `BatUref`

Unifiable references using destructive union-find

type 'a uref

A t uref is a reference to a cell that contains a value of type t.

type 'a t = 'a uref

A synonym for convenience

val uref : 'a -> 'a uref

uref x allocates a new uref and places the value x in it.

val uget : 'a uref -> 'a

uget ur returns the value stored in the uref ur.

val uset : 'a uref -> 'a -> unit

uset ur x updates the contents of ur with x.

val unite : ?sel:('a -> 'a -> 'a) -> 'a uref -> 'a uref -> unit

unite ~sel ur1 ur2 unites the urefs ur1 and ur2, selecting the result of sel (uget ur1) (uget ur2) for the contents of the resulting united uref. After this operation, uget ur1 == uget ur2. By default, sel is fun x _y -> x.

val equal : 'a uref -> 'a uref -> bool

equal ur1 ur2 returns true iff ur1 and ur2 are equal urefs, either because they are physically the same or because they have been united.

Printing

val print : ('a, 'b) BatIO.printer -> ('a uref, 'b) BatIO.printer

Print the uref.

On This Page

Printing