package batteries

You can search for identifiers within the package.

in-package search v0.2.0

A community-maintained standard library extension

Install

dune-project

Dependency

github.com Readme Edit opam file Versions (14)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.7.1.tar.gz

md5=d02c4f044e53edca010de46f9139ce00

sha512=99a5afa3604c4cf0c849c670111d617f7f255acb0da043b73ddffdf0e299948bce52516ee31921f269de6088156c4e0a187e0b931543c6819c6b25966b303281

doc/batteries.unthreaded/BatUref/index.html

Module `BatUref`Source

Unifiable references using destructive union-find

Sourcetype 'a uref

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

Sourcetype 'a t = 'a uref

A synonym for convenience

Sourceval uref : 'a -> 'a uref

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

Sourceval uget : 'a uref -> 'a

uget ur returns the value stored in the uref ur.

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

uset ur x updates the contents of ur with x.

Sourceval 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.

Sourceval 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

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

Print the uref.

On This Page

Printing