package core_kernel

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (10)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

core_kernel-v0.15.0.tar.gz
sha256=34a0288f16027c6b90e4ad16cb5cc677d7063d310faf918748ce70f1745116c0

doc/core_kernel.fheap/Fheap/index.html

Module Fheap

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.

val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.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.

include Core.Container.S1 with type 'a t := 'a t
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, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
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__.Container_intf.Summable 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

Fheap may be used as the module argument to Sequence.merge_all.

include Core.Sequence.Heap with type 'a t := 'a t
val min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option

The comparison functions in min_elt and max_elt are independent of the one used to order the heap. Since the provided compare 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 -> compare:('a -> 'a -> int) -> 'a option
val to_list : 'a t -> 'a list

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 : compare:('a -> 'a -> int) -> 'a t

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

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

val of_array : 'a array -> compare:('a -> 'a -> int) -> 'a t
val of_list : 'a list -> compare:('a -> 'a -> int) -> '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 option

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 option

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) option

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

val pop_min : 'a t -> ('a * 'a t) option

pop_min is a more descriptive name for pop.

val pop_exn : 'a t -> 'a * 'a t
val pop_min_exn : 'a t -> 'a * 'a t

pop_min_exn is a more descriptive name for pop_exn.

val pop_if : 'a t -> ('a -> bool) -> ('a * 'a t) option

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.