package batteries

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Construction
Operations
Transformation
Printing
Functorized version

A community-maintained standard library extension

Install

dune-project

Dependency

github.com Readme Edit opam file Versions (15)

Authors

O

OCaml batteries-included team

Maintainers

Sources

v3.9.0.tar.gz

md5=ea26b5c72e6731e59d856626049cca4d

sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb

doc/batteries.unthreaded/BatHeap/index.html

Module `BatHeap`Source

Functional heaps over ordered types

Ascribes to:

BatEnum.Enumerable with type 'a enumerable = 'a t

Sourcetype +'a t

Heap of elements that are compared with Pervasives.compare.

Sourceval size : 'a t -> int

Number of elements in the heap. O(1)

Construction

Sourceval empty : 'a t

The empty heap.

Sourceval insert : 'a t -> 'a -> 'a t

Insert an element into the heap. Duplicates are kept. O(log m)

Sourceval add : 'a -> 'a t -> 'a t

add x h is the same as insert h x. This function is intended to be used with fold_right.

Operations

Sourceval merge : 'a t -> 'a t -> 'a t

Merge two heaps. O(log m)

Sourceval find_min : 'a t -> 'a

Find the minimal element of the heap. O(1)

raises Invalid_argument
"find_min" if the heap is empty

Sourceval del_min : 'a t -> 'a t

Delete the minimal element of the heap. O(log n)

raises Invalid_argument
"del_min" if the heap is empty

Transformation

Sourceval of_list : 'a list -> 'a t

Build a heap from a given list. O(n log n)

Sourceval to_list : 'a t -> 'a list

Enumerate the elements of the heap. O(n log n)

Sourceval elems : 'a t -> 'a list

deprecated
Same as to_list.

Sourceval of_enum : 'a BatEnum.t -> 'a t

Build a heap from an enumeration. Consumes the enumeration. O(n log n)

Sourceval enum : 'a t -> 'a BatEnum.t

Enumerate the elements of the heap in heap order. O(log n) per BatEnum.get.

Printing

Source

val print : 
  ?first:string ->
  ?last:string ->
  ?sep:string ->
  ('a, 'b) BatIO.printer ->
  ('a t, 'b) BatIO.printer

Print the contents of the heap in heap order. O(n log n)

Functorized version

Sourcemodule type H = sig ... end

The result of Make

Sourcemodule Make (Ord : BatInterfaces.OrderedType) : H with type elem = Ord.t

Functorized heaps over arbitrary orderings. All the functions have the same complexity as the non-functorized versions.