package containers

empty returns the empty heap.

is_empty h returns true if the heap h is empty.

merge h1 h2 merges the two heaps h1 and h2.

insert x h inserts an element x into the heap h.

add h x inserts an element x into the heap h.

filter p h filters values, only retaining the ones that satisfy the predicate p. Linear time at least.

find_min h find the minimal element of the heap h.

find_min_exn h is like find_min but can fail.

• raises Empty

  if the heap is empty.

take h extracts and returns the minimum element, and the new heap (without this element), or None if the heap h is empty.

take_exn h is like take, but can fail.

• raises Empty

  if the heap is empty.

delete_one eq x h uses eq to find one occurrence of a value x if it exist in the heap h, and delete it. If h do not contain x then it return h.

• since 2.0

delete_all eq x h uses eq to find all x in h and delete them. If h do not contain x then it return h. The difference with filter is that delete_all stops as soon as it enters a subtree whose root is bigger than the element.

• since 2.0

iter f h iterates over the heap h invoking f with the current element.

fold f acc h folds on all values of h.

size h is the number of elements in the heap h. Linear complexity.

to_list h returns the elements of the heap h, in no particular order.

to_list_sorted h returns the elements of the heap h in increasing order.

• since 1.1

add_list h l adds the elements of the list l into the heap h. An element occurring several times will be added that many times to the heap.

• since 0.16

of_list l is add_list empty l. Complexity: O(n log n).

add_iter h iter is like add_list.

• since 2.8

add_seq h seq is like add_list. Renamed from add_std_seq since 3.0.

• since 3.0

of_iter iter builds a heap from a given iter. Complexity: O(n log n).

• since 2.8

of_seq seq builds a heap from a given Seq.t. Complexity: O(n log n). Renamed from of_seq since 3.0.

• since 3.0

to_iter h returns a iter of the elements of the heap h.

• since 2.8

to_seq h returns a Seq.t of the elements of the heap h. Renamed from to_std_seq since 3.0.

• since 3.0

to_iter_sorted h returns a iter by iterating on the elements of h, in increasing order.

• since 2.8

to_seq_sorted h returns a Seq.t by iterating on the elements of h, in increasing order. Renamed from to_std_seq_sorted since 3.0.

• since 3.0

add_gen h gen adds the gen gen to the heap h.

• since 0.16

of_gen gen builds a heap from a given gen. Complexity: O(n log n).

to_gen h returns a gen of the elements of the heap h.

to_tree h returns a ktree of the elements of the heap h.

to_string ?sep f h prints the heap h in a string using sep as a given separator (default ",") between each element (converted to a string using f).

• since 2.7

pp ?pp_start ?pp_stop ?pp_sep ppf h prints h on ppf. Each element is formatted with ppf, pp_start is called at the beginning, pp_stop is called at the end, pp_sep is called between each elements. By defaults pp_start and pp_stop does nothing and pp_sep defaults to (fun out -> Format.fprintf out ",@ "). Renamed from print since 2.0

• since 0.16