module Queue: Core_queue
exception Empty
type 'a
t
include Container.S1
include Sexpable.S1
val create : unit -> 'a t
create ()
returns an empty queue.
val enqueue : 'a t -> 'a -> unit
enqueue t x
adds x
to the end of t
.
val dequeue : 'a t -> 'a option
dequeue t
returns None
if t
is empty, otherwise it removes and returns
the front of t
val dequeue_exn : 'a t -> 'a
dequeue_exn t
removes and returns the front of t
, raising Empty
if t
is empty.
val peek : 'a t -> 'a option
peek t
returns None
if t
is empty, otherwise it returns Some x
where
x
is the front of t
.
val peek_exn : 'a t -> 'a
peek_exn t
raises Empty
if t
is empty, otherwise it returns the front
of t
.
val clear : 'a t -> unit
clear t
discards all elements from t
.
val copy : 'a t -> 'a t
copy t
returns a copy of t
.
val filter_inplace : 'a t -> f:('a -> bool) -> unit
filter_inplace t ~f
removes all elements of t
that don't satisfy f
.
val transfer : src:'a t -> dst:'a t -> 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 of_list : 'a list -> 'a t
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 partial_iter : 'a t -> f:('a -> [ `Continue | `Stop ]) -> unit
partial_iter t ~f
iterates through t until f returns `Stop
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