module Core_queue:Core_queue is a re-implementation of OCaml's standard Queue module that follows Core idioms and adds some functions.sig
..end
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.
enqueue
takes the queue argument first.
transfer
's arguments are labeled.
exception Empty
type 'a
t
include Container.S1
val invariant : 'a t -> unit
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 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).