package owl-base

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

Install

Dune Dependency

Authors

Maintainers

Sources

owl-1.2.tbz
sha256=3817a2e4391922c8a2225b4e33ca95da6809246994e6bf291a300c82d8cac6c5
sha512=68a21f540cb4a289419f35cd152d132af36f1000fb41f98bab6e100698820379e36d650c5aa70a0126513451b354f86a28ea4ecf6f1d3b196b5b5e56f0fac9bd

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.