package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

Imperative data structure for representing disjoint sets.

Union find is used to implement an equivalence relation on objects, where the equivalence relation can dynamically be coarsened by "union"ing two equivalence classes together.

All of the operations are effectively (amortized) constant time.

See Wikipedia.

This implementation is not thread-safe.

type 'a t

type 'a t is the type of objects, where each object is part of an equivalence class that is associated with a single value of type 'a.

include Base.Invariant.S1 with type 'a t := 'a t
val invariant : ('a -> unit) -> 'a t -> unit
val create : 'a -> 'a t

create v returns a new object in its own equivalence class that has value v.

val get : 'a t -> 'a

get t returns the value of the class of t.

val set : 'a t -> 'a -> Base.Unit.t

set t v sets the value of the class of t to v.

val same_class : 'a t -> 'a t -> Base.Bool.t

same_class t1 t2 returns true iff t1 and t2 are in the same equivalence class.

val union : 'a t -> 'a t -> Base.Unit.t

union t1 t2 makes the class of t1 and the class of t2 be the same (if they are already equal, then nothing changes). The value of the combined class is the value of t1 or t2; it is unspecified which. After union t1 t2, it will always be the case that same_class t1 t2.

module Private : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct