package containers

  1. Overview
  2. Docs
On This Page
  1. Conversions
A modular, clean and powerful extension of the OCaml standard library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (25)

Authors

  1. S
    Simon Cruanes

Maintainers

  1. S
    simon.cruanes.2007@m4x.org

Sources

v2.8.1.tar.gz
md5=d84e09c5d0abc501aa17cd502e31a038
sha512=8b832f4ada6035e80d81be0cfb7bdffb695ec67d465ed6097a144019e2b8a8f909095e78019c3da2d8181cc3cd730cd48f7519e87d3162442562103b7f36aabb

doc/containers/CCHeap/module-type-S/index.html

Module type CCHeap.SSource

Sourcetype elt
Sourcetype t
Sourceval empty : t

Empty heap.

Sourceval is_empty : t -> bool

Is the heap empty?

Sourceexception Empty
Sourceval merge : t -> t -> t

Merge two heaps.

Sourceval insert : elt -> t -> t

Insert a value in the heap.

Sourceval add : t -> elt -> t

Synonym to insert.

Sourceval filter : (elt -> bool) -> t -> t

Filter values, only retaining the ones that satisfy the predicate. Linear time at least.

Sourceval find_min : t -> elt option

Find minimal element.

Sourceval find_min_exn : t -> elt

Like find_min but can fail.

  • raises Empty

    if the heap is empty.

Sourceval take : t -> (t * elt) option

Extract and return the minimum element, and the new heap (without this element), or None if the heap is empty.

Sourceval take_exn : t -> t * elt

Like take, but can fail.

  • raises Empty

    if the heap is empty.

Sourceval delete_one : (elt -> elt -> bool) -> elt -> t -> t

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

  • since 2.0
Sourceval delete_all : (elt -> elt -> bool) -> elt -> t -> t

Delete all occurrences of a value in the heap. delete_all eq x h, use 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
Sourceval iter : (elt -> unit) -> t -> unit

Iterate on elements.

Sourceval fold : ('a -> elt -> 'a) -> 'a -> t -> 'a

Fold on all values.

Sourceval size : t -> int

Number of elements (linear complexity).

Conversions

The interface of of_gen, of_seq, of_klist has changed since 0.16 (the old signatures are now add_seq, add_gen, add_klist).

Sourceval to_list : t -> elt list

Return the elements of the heap, in no particular order.

Sourceval to_list_sorted : t -> elt list

Return the elements in increasing order.

  • since 1.1
Sourceval add_list : t -> elt list -> t

Add the elements of the list to the heap. An element occurring several times will be added that many times to the heap.

  • since 0.16
Sourceval of_list : elt list -> t

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

Sourceval add_iter : t -> elt iter -> t

Like add_list.

  • since 2.8
Sourceval add_std_seq : t -> elt Seq.t -> t

Like add_list.

  • since 2.8
Sourceval add_seq : t -> elt sequence -> t
  • deprecated use add_iter. For the standard Seq, see {!add_std_seq}
Sourceval of_iter : elt iter -> t

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

  • since 2.8
Sourceval of_std_seq : elt Seq.t -> t

Build a heap from a given Seq.t. Complexity: O(n log n).

  • since 2.8
Sourceval of_seq : elt sequence -> t
  • deprecated use of_iter. For the standard Seq, see {!of_std_seq}
Sourceval to_iter : t -> elt iter

Return a iter of the elements of the heap.

  • since 2.8
Sourceval to_std_seq : t -> elt Seq.t

Return a Seq.t of the elements of the heap.

  • since 2.8
Sourceval to_seq : t -> elt sequence
  • deprecated use to_iter. For the standard Seq, see {!to_std_seq}
Sourceval to_iter_sorted : t -> elt iter

Iterate on the elements, in increasing order.

  • since 2.8
Sourceval to_std_seq_sorted : t -> elt Seq.t

Iterate on the elements, in increasing order.

  • since 2.8
Sourceval to_seq_sorted : t -> elt sequence
  • deprecated use to_iter_sorted or to_std_seq_sorted
Sourceval add_klist : t -> elt klist -> t
  • since 0.16
Sourceval of_klist : elt klist -> t

Build a heap from a given klist. Complexity: O(n log n).

Sourceval to_klist : t -> elt klist

Return a klist of the elements of the heap.

Sourceval add_gen : t -> elt gen -> t
  • since 0.16
Sourceval of_gen : elt gen -> t

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

Sourceval to_gen : t -> elt gen

Return a gen of the elements of the heap.

Sourceval to_tree : t -> elt ktree

Return a ktree of the elements of the heap.

Sourceval to_string : ?sep:string -> (elt -> string) -> t -> string

Print the heap in a string

  • since 2.7
Sourceval pp : ?sep:string -> elt printer -> t printer

Printer. Renamed from print since 2.0

  • since 0.16