module MakeMin:
Functor building an implementation of the min-priority queue structure given a totally ordered type for elements.
| Parameters: |
|
type
The type of priority queues.
type
The type of priority queue elements.
val create : unit -> tReturn a new priority queue, initially empty.
val length : t -> intReturn the number of elements in a priority queue.
val is_empty : t -> boolis_empty q is true iff q is empty, that is, iff length q = 0.
val add : t -> elt -> unitadd q x adds the element x in the priority queue q.
val add_iter : t -> ((elt -> unit) -> 'x -> unit) -> 'x -> unitadd_iter q iter x adds each element of x to the end of q.
This is iter (add q) x.
val min_elt : t -> elt optionmin_elt q is an element of q with minimal priority or
None if the queue is empty. The queue is not modified.
val get_min_elt : t -> eltget_min_elt q returns an element of q with minimal
priority, or raises Invalid_argument if the queue is
empty. The queue is not modified.
val pop_min : t -> elt optionpop_min q removes and returns an element in queue q with
minimal priority, or returns None if the queue is empty.
val remove_min : t -> unitremove_min q removes an element in queue q with minimal
priority. It does nothing if q is empty.
val clear : t -> unitclear q removes all elements from q.
val copy : t -> tcopy q is a new priority queue with the same elements q has.
val of_array : elt array -> tof_array a returns a new priority queue containing the
elements of array a. Runs in linear time.
val of_list : elt list -> tof_list l returns a new priority queue containing the
elements of list l. Runs in linear time.
val of_iter : ((elt -> unit) -> 'x -> unit) -> 'x -> tof_iter iter x returns a new priority queue containing the
elements of x, obtained from iter.
For example, of_iter Seq.iter s returns a new priority queue
containing all the elements of the sequence s (provided it
is finite).
Runs in linear time (excluding the time spent in iter).
The order in which the elements of a priority queue are traversed is unspecified.
It is a programming error to mutate a priority queue (by adding or removing elements) during an iteration of the queue. Such an error may be detected and signaled by the backing dynamic array implementation, but this is not guaranteed.
val iter_unordered : (elt -> unit) -> t -> unititer_unordered f q applies f to all elements in q. The
order in which the elements are passed to f is unspecified.
The behavior is not specified if the priority queue is modified
by f during the iteration.
val fold_unordered : ('acc -> elt -> 'acc) -> 'acc -> t -> 'accfold_unordered f accu q is (f (... (f (f accu x1) x2) ...) where
xn)x1,x2,...,xn are the elements of q. The order
in which the elements are passed to f is unspecified.
The behavior is not specified if the priority queue is modified
by f during the iteration.