package batteries

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

Install 

dune-project
 Dependency

github.com 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>

Sources

v3.3.0.tar.gz
sha256=40d18485911e343500a5636bbf1d84e2ee32f924fe87e5fd13a37641a4d8f226
md5=fe4da12b678a82faaeda4e58492ea871

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.