package owl-base

  1. Overview
  2. Docs
OCaml Scientific and Engineering Computing - Base

Install

Dune Dependency

Authors

Maintainers

Sources

owl-0.7.2.tbz
sha256=08c63c2c6f4a73143062ae1d2b7a809cdc8ae829a50b5bb1ecd9de6e2e5a5549
sha512=574cc39a186ef89bf73fbd9e42dd555b0d03ac1f70f745bc3f0932c623d217030a6375b6418fe4f262d9bff161ff254df10ba27d8f5fa8783c86e88af0755305

doc/owl-base/Owl_utils_heap/index.html

Module Owl_utils_heapSource

Type definition
Sourcetype 'a t

Type of a min heap.

Basic functions
Sourceval make : ('a -> 'a -> int) -> 'a t

``make cmp`` creates an empty min heap, using ``cmp`` as a comparison function.

Sourceval make_int : ?initial_size:int -> (int -> int -> int) -> int t

``make_int ?initial_size cmp`` creates an empty integer heap, using ``cmp`` as a comparison function and pre-allocates a space of ``initial_size`` elements.

Sourceval make_float : ?initial_size:int -> (float -> float -> int) -> float t

``make_float ?initial_size cmp`` creates an empty float heap, using ``cmp`` as a comparison function and pre-allocates a space of ``initial_size`` elements.

Sourceval size : 'a t -> int

``size heap`` returns the number of elements in the heap.

Sourceval push : 'a t -> 'a -> unit

``push heap x`` pushes ``x`` into ``heap``. Time complexity is ``O(log(n))``, where n is the size of ``heap``.

Sourceval pop : 'a t -> 'a

``pop heap`` pops the minimal element from ``heap``. It raises an exception if the heap is empty. Time complexity is ``O(log(n))``, where n is the size of ``heap``.

Sourceval peek : 'a t -> 'a

``peek heap`` returns the value of the minimal element in ``heap`` but it does not remove the element from the heap. Raises an exception if the heap is empty. Time complexity is ``O(1)``.

Sourceval is_empty : 'a t -> bool

``is_empty heap`` returns ``true`` if ``heap`` is empty, ``false`` otherwise.

Sourceval to_array : 'a t -> 'a array

``to_array heap`` returns the elements in ``heap`` into an (unsorted) array.

OCaml

Innovation. Community. Security.