blob: 4cc0d6aa430f8e6932e37966a5345a31f5442d5d (
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
|
(***********************************************************************)
(* *)
(* Objective Caml *)
(* *)
(* Xavier Leroy, projet Cristal, INRIA Rocquencourt *)
(* *)
(* Copyright 1996 Institut National de Recherche en Informatique et *)
(* Automatique. Distributed only by permission. *)
(* *)
(***********************************************************************)
(* $Id$ *)
(* Module [Queue]: first-in first-out queues *)
(* This module implements queues (FIFOs), with in-place modification. *)
type 'a t
(* The type of queues containing elements of type ['a]. *)
exception Empty
(* Raised when [take] is applied to an empty queue. *)
val create: unit -> 'a t
(* Return a new queue, initially empty. *)
val add: 'a -> 'a t -> unit
(* [add x q] adds the element [x] at the end of the queue [q]. *)
val take: 'a t -> 'a
(* [take q] removes and returns the first element in queue [q],
or raises [Empty] if the queue is empty. *)
val peek: 'a t -> 'a
(* [peek q] returns the first element in queue [q], without removing
it from the queue, or raises [Empty] if the queue is empty. *)
val clear : 'a t -> unit
(* Discard all elements from a queue. *)
val length: 'a t -> int
(* Return the number of elements in a queue. *)
val iter: ('a -> 'b) -> 'a t -> unit
(* [iter f q] applies [f] in turn to all elements of [q],
from the least recently entered to the most recently entered.
The queue itself is unchanged. *)
|
