package core_kernel

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

Functional heaps (implemented as Pairing heaps)

type 'a t

t_of_sexp is not supported, because of the difficulty involved in recreating the comparison function.

include sig ... end
val sexp_of_t : ('a -> Sexplib.Sexp.t) -> 'a t -> Sexplib.Sexp.t

Even though min_elt, max_elt, and to_list are in Container.S1, they are documented separately to make sure there is no confusion.

val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool
val length : 'a t -> int
val is_empty : 'a t -> bool
val iter : 'a t -> f:('a -> unit) -> unit
val fold : 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum
val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Base__.Result.t) -> ('accum, 'e) Base__.Result.t
val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'stop) Base.Container_intf.Continue_or_stop.t) -> ('accum, 'stop) Base.Container_intf.Finished_or_stopped_early.t
val exists : 'a t -> f:('a -> bool) -> bool
val for_all : 'a t -> f:('a -> bool) -> bool
val count : 'a t -> f:('a -> bool) -> int
val sum : (module Base__.Commutative_group.S with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum
val find : 'a t -> f:('a -> bool) -> 'a option
val find_map : 'a t -> f:('a -> 'b option) -> 'b option
val to_array : 'a t -> 'a array
val min_elt : 'a t -> cmp:('a -> 'a -> Base.Int.t) -> 'a Base.Option.t

The comparison functions in min_elt and max_elt are independent of the one used to order the heap. Since the provided cmp may be different from the one used to create the heap, it is necessary for these functions to traverse the entire heap. If you want to access the smallest element of the heap according to the heap's comparison function, you should use top.

val max_elt : 'a t -> cmp:('a -> 'a -> Base.Int.t) -> 'a Base.Option.t
val to_list : 'a t -> 'a Base.List.t

The elements of to_list t are not in any particular order. You need to sort the list afterwards if you want to get a sorted list.

val create : cmp:('a -> 'a -> Base.Int.t) -> 'a t

create ~cmp returns a new min-heap that uses ordering function cmp.

The top of the heap is the smallest element as determined by the provided comparison function.

val of_array : 'a Base.Array.t -> cmp:('a -> 'a -> Base.Int.t) -> 'a t
val of_list : 'a Base.List.t -> cmp:('a -> 'a -> Base.Int.t) -> 'a t
val add : 'a t -> 'a -> 'a t

add t v returns the new heap after addition. Complexity O(1).

val top : 'a t -> 'a Base.Option.t

This returns the top (i.e., smallest) element of the heap. Complexity O(1).

val top_exn : 'a t -> 'a
val remove_top : 'a t -> 'a t Base.Option.t

remove_top t returns the new heap after a remove. It does nothing if t is empty.

The amortized time per remove_top t (or pop t, pop_exn t, pop_if t) is O(lg n). The complexity of the worst case is O(n).

val pop : 'a t -> ('a * 'a t) Base.Option.t

This removes and returns the top (i.e., least) element and the modified heap.

val pop_exn : 'a t -> 'a * 'a t
val pop_if : 'a t -> ('a -> Base.Bool.t) -> ('a * 'a t) Base.Option.t

pop_if t cond returns Some (top_element, rest_of_heap) if t is not empty and its top element satisfies condition cond, or None in any other case.

val to_sequence : 'a t -> 'a Base.Sequence.t

to_sequence t is a sequence of the elements of t in ascending order.

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