package batteries

  1. Overview
  2. Docs
On This Page
  1. Printing
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (13)

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

batteries-3.11.0.tar.gz
md5=096be9e83e347b4c7b5b6e5b2af22992
sha512=621dca842c4a7adf0ac1e907bf44c1405e0b66a088987a138a4f4e98ca744815913bf87fd780619151cb049a07d7fdb1e8adb7b65698ab46b8c2dfe46cd7119d

doc/batteries.unthreaded/BatUref/index.html

Module BatUrefSource

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.