Module Pairing_heap

Heap implementation based on a pairing-heap.

This heap implementations supports an arbitrary element type via a comparison function.

type 'a t

of_sexp and bin_io functions aren't supplied for heaps due to the difficulties in reconstructing the correct comparison function when de-serializing.

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

Mutation of the heap during iteration is not supported, but there is no check to prevent it. The behavior of a heap that is mutated during iteration is undefined.

include Core.Container.S1 with type 'a t := 'a t
include sig ... end
val length : 'a 'p1 'p2. 'a t -> int
val is_empty : 'a 'p1 'p2. 'a t -> bool
val iter : 'a 'p1 'p2. 'a t -> f:('a -> unit) @ local -> unit

iter must allow exceptions raised in f to escape, terminating the iteration cleanly. The same holds for all functions below taking an f.

val exists : 'a 'p1 'p2. 'a t -> f:('a -> bool) @ local -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : 'a 'p1 'p2. 'a t -> f:('a -> bool) @ local -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : 'a 'p1 'p2. 'a t -> f:('a -> bool) @ local -> int

Returns the number of elements for which the provided function evaluates to true.

val find : 'a 'p1 'p2. 'a t -> f:('a -> bool) @ local -> 'a Option.t

Returns as an option the first element for which f evaluates to true.

val to_list : 'a 'p1 'p2. 'a t -> 'a list
val sum : 'a 'sum 'p1 'p2. (module Base.Container.Summable with type t = 'sum) -> 'a t -> f:('a -> 'sum) @ local -> 'sum

Returns the sum of f i for all i in the container. The order in which the elements will be summed is unspecified.

val iter_until : 'a 'p1 'p2 'final. 'a t -> f:('a -> (unit, 'final) Base.Container.Continue_or_stop.t) @ local -> (finish:(unit -> 'final) @ local -> 'final) @ local

iter_until t ~f ~finish is a short-circuiting version of iter. If f returns Stop x the computation ceases and returns x. If f always returns Continue () the final result is computed by finish.

val fold : 'a 'p1 'p2 'acc. 'a t -> init:'acc -> f:('acc -> ('a -> 'acc) @ local) @ local -> 'acc

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t.

val fold_result : 'a 'p1 'p2 'acc 'e. 'a t -> init:'acc -> f:('acc -> ('a -> ('acc, 'e) Result.t) @ local) @ local -> ('acc, 'e) Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val find_map : 'a 'p1 'p2 'b. 'a t -> f:('a -> 'b Option.t) @ local -> 'b Option.t

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val fold_until : 'a 'p1 'p2 'acc 'final. 'a t -> init:'acc -> f: ('acc -> ('a -> ('acc, 'final) Base.Container.Continue_or_stop.t) @ local) @ local -> (finish:('acc -> 'final) @ local -> 'final) @ local

fold_until t ~init ~f ~finish is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed. If f never returns Stop _, the final result is computed by finish.

Example:

  type maybe_negative =
    | Found_negative of int
    | All_nonnegative of { sum : int }

  (** [first_neg_or_sum list] returns the first negative number in [list], if any,
      otherwise returns the sum of the list. *)
  let first_neg_or_sum =
    List.fold_until ~init:0
      ~f:(fun sum x ->
        if x < 0
        then Stop (Found_negative x)
        else Continue (sum + x))
      ~finish:(fun sum -> All_nonnegative { sum })
  ;;

  let x = first_neg_or_sum [1; 2; 3; 4; 5]
  val x : maybe_negative = All_nonnegative {sum = 15}

  let y = first_neg_or_sum [1; 2; -3; 4; 5]
  val y : maybe_negative = Found_negative -3
val mem : 'a 'p1 'p2. 'a t -> 'a -> equal:('a -> ('a -> bool) @ local) @ local -> bool

Checks whether the provided element is there, using equal.

val to_array : 'a. 'a t -> 'a array
include Core.Invariant.S1 with type 'a t := 'a t
val invariant : ('a -> unit) -> 'a t -> unit

Even though these two functions min_elt and max_elt are part of Container.S1, they are documented separately to make sure there is no confusion. They are independent of the comparison function used to order the heap. Instead, a traversal of the entire structure is done using the provided compare function to find a min or max.

If you want to access the smallest element of the heap according to the heap's comparison function in constant time, you should use top.

val min_elt : 'a t -> compare:('a -> ('a -> int) @ local) @ local -> 'a option @@ portable
val max_elt : 'a t -> compare:('a -> ('a -> int) @ local) @ local -> 'a option @@ portable
val create : ?min_size:int -> cmp:('a -> 'a -> int) -> unit -> 'a t @@ portable

create ?min_size ~cmp returns a new min-heap that can store min_size elements without reallocations, using ordering function cmp.

The top of the heap is the smallest element as determined by the provided comparison function. In particular, if cmp x y < 0 then x will be "on top of" y in the heap.

Memory use can be surprising in that the underlying pool never shrinks, so current memory use will at least be proportional to the largest number of elements that the heap has ever held.

val of_array : 'a array -> cmp:('a -> 'a -> int) -> 'a t @@ portable

min_size (see create) will be set to the size of the input array or list.

val of_list : 'a list -> cmp:('a -> 'a -> int) -> 'a t @@ portable
val top : 'a t -> 'a option @@ portable

Returns the top (i.e., smallest) element of the heap.

val top_or_null : 'a t -> 'a or_null @@ portable
val top_exn : 'a t -> 'a @@ portable
val add : 'a t -> 'a -> unit @@ portable
val remove_top : _ t -> unit @@ portable

remove_top t does nothing if t is empty.

val clear : _ t -> unit @@ portable

Removes all elements, leaving an empty heap. This operation is O(n) where n is the size of the heap.

val pop : 'a t -> 'a option @@ portable

pop removes and returns the top (i.e. least) element.

val pop_or_null : 'a t -> 'a or_null @@ portable
val pop_exn : 'a t -> 'a @@ portable
val pop_if : 'a t -> ('a -> bool) -> 'a option @@ portable

pop_if t cond returns Some top_element of t if it satisfies condition cond, removing it, or None in any other case.

val pop_if_or_null : 'a t -> ('a -> bool) -> 'a or_null @@ portable
val pop_while : 'a t -> ('a -> bool) -> 'a list @@ portable

pop_while t cond returns a list of top elements from t while they satisfy condition cond, removing each of them, or an empty list if none of the elements satisfy the condition. The returned list is in order of removal.

val copy : 'a t -> 'a t @@ portable

copy t returns a shallow copy.

module Elt : sig ... end
val add_removable : 'a t -> 'a -> 'a Elt.t @@ portable

add_removable t v adds v to t, returning a token that can be used to delete v from t in lg(n) amortized time.

Note that while add doesn't allocate unless the underlying pool needs to be resized, add_removable always allocates. The Unsafe module has a non-allocating alternative.

val remove : 'a t -> 'a Elt.t -> unit @@ portable

If t and token are mismatched then behavior is undefined. Trying to remove an already removed token (by an earlier call to remove or pop for instance) is a no-op, but keeping token around after it has been removed may lead to memory leaks since it has a reference to the heap.

val update : 'a t -> 'a Elt.t -> 'a -> 'a Elt.t @@ portable

update t token v is shorthand for remove t token; add_removable t v.

val find_elt : 'a t -> f:('a -> bool) -> 'a Elt.t option @@ portable

find_elt t ~f. If f is true for some element in t, return an Elt.t for that element. This operation is O(n).

module Unsafe : sig ... end

Unsafe functions provide faster alternatives to regular functions with the same name. They don't allocate but the behavior is unspecified and could be memory unsafe in certain cases where regular functions would fail with informative exceptions.