diff options
Diffstat (limited to 'lib/heap.mli')
| -rw-r--r-- | lib/heap.mli | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/lib/heap.mli b/lib/heap.mli index 3183e0ec..c2bd95ae 100644 --- a/lib/heap.mli +++ b/lib/heap.mli @@ -1,14 +1,12 @@ (************************************************************************) (* v * The Coq Proof Assistant / The Coq Development Team *) -(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2011 *) +(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2012 *) (* \VV/ **************************************************************) (* // * This file is distributed under the terms of the *) (* * GNU Lesser General Public License Version 2.1 *) (************************************************************************) -(*i $Id: heap.mli 14641 2011-11-06 11:59:10Z herbelin $ i*) - -(* Heaps *) +(** Heaps *) module type Ordered = sig type t @@ -17,29 +15,29 @@ end module type S =sig - (* Type of functional heaps *) + (** Type of functional heaps *) type t - (* Type of elements *) + (** Type of elements *) type elt - (* The empty heap *) + (** The empty heap *) val empty : t - (* [add x h] returns a new heap containing the elements of [h], plus [x]; - complexity $O(log(n))$ *) + (** [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)$ *) + (** [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 + (** [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))$ *) + complexity {% $ %}O(log(n)){% $ %} *) val remove : t -> t - (* usual iterators and combinators; elements are presented in + (** usual iterators and combinators; elements are presented in arbitrary order *) val iter : (elt -> unit) -> t -> unit @@ -49,6 +47,6 @@ end exception EmptyHeap -(*S Functional implementation. *) +(** {6 Functional implementation. } *) module Functional(X: Ordered) : S with type elt=X.t |