summaryrefslogtreecommitdiff
path: root/lib/heap.mli
blob: d351edd065ffde9213d28bc7cf67af5069925da1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
(************************************************************************)
(*  v      *   The Coq Proof Assistant  /  The Coq Development Team     *)
(* <O___,, * CNRS-Ecole Polytechnique-INRIA Futurs-Universite Paris Sud *)
(*   \VV/  **************************************************************)
(*    //   *      This file is distributed under the terms of the       *)
(*         *       GNU Lesser General Public License Version 2.1        *)
(************************************************************************)

(*i $Id: heap.mli 6621 2005-01-21 17:24:37Z herbelin $ i*)

(* Heaps *)

module type Ordered = sig
  type t
  val compare : t -> t -> int
end

module type S =sig
  
  (* Type of functional heaps *)
  type t

  (* Type of elements *)
  type elt
    
  (* The empty heap *)
  val empty : t
    
  (* [add x h] returns a new heap containing the elements of [h], plus [x];
     complexity $O(log(n))$ *)
  val add : elt -> t -> t
    
  (* [maximum h] returns the maximum element of [h]; raises [EmptyHeap]
     when [h] is empty; complexity $O(1)$ *)
  val maximum : t -> elt
    
  (* [remove h] returns a new heap containing the elements of [h], except
     the maximum of [h]; raises [EmptyHeap] when [h] is empty; 
     complexity $O(log(n))$ *) 
  val remove : t -> t
    
  (* usual iterators and combinators; elements are presented in
     arbitrary order *)
  val iter : (elt -> unit) -> t -> unit
    
  val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
    
end

exception EmptyHeap

(*S Functional implementation. *)

module Functional(X: Ordered) : S with type elt=X.t