module Queue:Queue is a wrapper around 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.
transfer's arguments are labeled.
exception Empty
type 'a t
include Container.S1
include Sexpable.S1
val create : unit -> 'a tcreate () returns an empty queue.val enqueue : 'a t -> 'a -> unitenqueue t x adds x to the end of t.val dequeue : 'a t -> 'a optiondequeue t returns None if t is empty, otherwise it removes and returns
the front of tval dequeue_exn : 'a t -> 'adequeue_exn t removes and returns the front of t, raising Empty if t
is empty.val peek : 'a t -> 'a optionpeek t returns None if t is empty, otherwise it returns Some x where
x is the front of t.val peek_exn : 'a t -> 'apeek_exn t raises Empty if t is empty, otherwise it returns the front
of t.val clear : 'a t -> unitclear t discards all elements from t.val copy : 'a t -> 'a tcopy t returns a copy of t.val filter_inplace : 'a t -> f:('a -> bool) -> unitfilter_inplace t ~f removes all elements of t that don't satisfy f.val transfer : src:'a t -> dst:'a t -> unittransfer ~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 tof_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 ]) -> unitpartial_iter t ~f iterates through t until f returns `Stop