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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
(******************************************************************************
* Core *
* *
* Copyright (C) 2008- Jane Street Holding, LLC *
* Contact: opensource@janestreet.com *
* WWW: http://www.janestreet.com/ocaml *
* *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
* *
******************************************************************************)
(** Simple implementation of a polymorphic functional queue.
Push and top and bottom are O(1). Pop and take are O(1) amortized.
to_list is O(n). length is O(1).
*)
exception Empty
type 'a t with bin_io, sexp
(** test via asserts whether invariants hold *)
val test_invariants : 'a t -> unit
(** The empty queue *)
val empty : 'a t
(** push a single element on queue *)
val push : 'a -> 'a t -> 'a t
(** push a single element on the *top* of the queue *)
val push_top : 'a -> 'a t -> 'a t
(** alias for push *)
val enq : 'a -> 'a t -> 'a t
(** returns the bottom (most-recently enqueued element). Raises [Empty] if no element is
found. *)
val bot_exn : 'a t -> 'a
(** like [bot_exn], but returns result optionally, without exception *)
val bot : 'a t -> 'a option
(** Like [bot_exn], except returns top (least-recently enqueued element *)
val top_exn : 'a t -> 'a
(** like [top_exn], but returns result optionally, without exception *)
val top : 'a t -> 'a option
(** Like [top_exn], but returns pair of the top element, and a new queue with the top element
removed *)
val pop_exn : 'a t -> 'a * 'a t
(** Like [pop_exn], but returns result optionally, without exception *)
val pop : 'a t -> ('a * 'a t) option
(** alias for pop *)
val deq : 'a t -> ('a * 'a t) option
(** alias for pop_exn *)
val deq_exn : 'a t -> 'a * 'a t
(** Returns version of queue with top element removed *)
val discard_exn : 'a t -> 'a t
(** [to_list t] returns a list of the elements in [t] in order from
least-recently-added (at the head) to most-recently added (at the tail). *)
val to_list : 'a t -> 'a list
val length : 'a t -> int
val is_empty : 'a t -> bool
|
