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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
(******************************************************************************
* 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 *
* *
******************************************************************************)
(** Core_queue is a wrapper around OCaml's standard Queue module that
follows Core idioms and adds some functions.
Differences from the standard module:
[enqueue] replaces [push], [add], and takes the queue first.
[dequeue] replaces [pop], [take], takes the queue first, and returns an
option rather than raising [Empty].
[dequeue_exn] is available if you want to raise [Empty].
[iter] takes a labeled argument.
[transfer]'s arguments are labeled.
*)
exception Empty
type 'a t
include Container.S1 with type 'a container = 'a t
include Sexpable.S1 with type 'a sexpable = 'a t
(** [create ()] returns an empty queue. *)
val create : unit -> 'a t
(** [enqueue t x] adds [x] to the end of [t].*)
val enqueue : 'a t -> 'a -> unit
(** [dequeue t] returns [None] if [t] is empty, otherwise it removes and returns
the front of [t] *)
val dequeue : 'a t -> 'a option
(** [dequeue_exn t] removes and returns the front of [t], raising [Empty] if [t]
is empty. *)
val dequeue_exn : 'a t -> 'a
(** [peek t] returns [None] if [t] is empty, otherwise it returns [Some x] where
[x] is the front of [t].
*)
val peek : 'a t -> 'a option
(** [peek_exn t] raises [Empty] if [t] is empty, otherwise it returns the front
of [t].
*)
val peek_exn : 'a t -> 'a
(** [clear t] discards all elements from [t]. *)
val clear : 'a t -> unit
(** [copy t] returns a copy of [t]. *)
val copy : 'a t -> 'a t
(** [filter_inplace t ~f] removes all elements of [t] that don't satisfy [f]. *)
val filter_inplace : 'a t -> f:('a -> bool) -> unit
(** [transfer ~src ~dst] adds all of the elements of [src] to the end of [dst],
then clears [src]. It is equivalent to the sequence
[iter ~src ~f:(enqueue dst); clear src]
but runs in constant time. *)
val transfer : src:'a t -> dst:'a t -> unit
(** [of_list list] returns a queue [t] with the elements of [list] in the same
order as the elements of [list] (i.e. the first element of [t] is the first
element of the list). *)
val of_list : 'a list -> 'a t
(** [partial_iter t ~f] iterates through t until f returns `Stop *)
val partial_iter : 'a t -> f:('a -> [`Continue | `Stop]) -> unit
val map : 'a t -> f:('a -> 'b) -> 'b t
val filter_map : 'a t -> f:('a -> 'b option) -> 'b t
val of_array : 'a array -> 'a t
val fold : 'a t -> init:'b -> f:('b -> 'a -> 'b) -> 'b
val to_list : 'a t -> 'a list
|
