Up

Module Fqueue

A simple polymorphic functional queue. Use this data structure for strictly first-in, first-out access to a sequence of values. For a similar data structure with enqueue and dequeue accessors on both ends of a sequence, see Fdeque.

Amortized running times assumes that enqueue/dequeue are used sequentially, threading the changing Fqueue through the calls.

Signature

type 'a t
val t_of_sexp : (Sexplib.Sexp.t -> 'a) -> Sexplib.Sexp.t -> 'a t
val sexp_of_t : ('a -> Sexplib.Sexp.t) -> 'a t -> Sexplib.Sexp.t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val bin_read_t : 'a Bin_prot.Read.reader -> 'a t Bin_prot.Read.reader
val __bin_read_t__ : 'a Bin_prot.Read.reader -> (int -> 'a t) Bin_prot.Read.reader
val bin_size_t : 'a Bin_prot.Size.sizer -> 'a t Bin_prot.Size.sizer
val bin_write_t : 'a Bin_prot.Write.writer -> 'a t Bin_prot.Write.writer
include Container.S1 with type 'a t := 'a t
type 'a t
val mem : ?equal:('a -> 'a -> bool) -> 'a t -> 'a -> bool

Checks whether the provided element is there, using polymorphic compare if equal is not provided

val length : 'a t -> int
val is_empty : 'a t -> bool
val iter : 'a t -> f:('a -> unit) -> unit
val fold : 'a t -> init:'accum -> f:('accum -> 'a -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t

val exists : 'a t -> f:('a -> bool) -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : 'a t -> f:('a -> bool) -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : 'a t -> f:('a -> bool) -> int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Commutative_group.S with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum

Returns the sum of f i for i in the container

val find : 'a t -> f:('a -> bool) -> 'a option

Returns as an option the first element for which f evaluates to true.

val find_map : 'a t -> f:('a -> 'b option) -> 'b option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : 'a t -> 'a list
val to_array : 'a t -> 'a array
val min_elt : 'a t -> cmp:('a -> 'a -> int) -> 'a option

Returns a minimum (resp maximum) element from the collection using the provided cmp function, or None if the collection is empty. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold.

val max_elt : 'a t -> cmp:('a -> 'a -> int) -> 'a option
include Invariant.S1 with type 'a t := 'a t
type 'a t
val invariant : 'a Invariant_intf.inv -> 'a t Invariant_intf.inv
val empty : 'a t

The empty queue

val enqueue : 'a t -> 'a -> 'a t

enqueue t x returns a queue with adds x to the end of t. Complexity: O(1)

val enqueue_top : 'a t -> 'a -> 'a t

enqueue a single element on the *top* of the queue. Complexity: amortized O(1) enqueue_top is deprecated, use Fdeque.t instead.

val bot_exn : 'a t -> 'a

returns the bottom (most-recently enqueued element). Raises Empty if no element is found. Complexity: O(1) bot_exn is deprecated, use Fdeque.t instead.

val bot : 'a t -> 'a option

like bot_exn, but returns result optionally, without exception. Complexity: O(1) bot is deprecated, use Fdeque.t instead.

val top_exn : 'a t -> 'a

Like bot_exn, except returns top (least-recently enqueued element. Complexity: O(1)

val top : 'a t -> 'a option

like top_exn, but returns result optionally, without exception, Complexity: O(1)

val dequeue_exn : 'a t -> 'a * 'a t

dequeue_exn t removes and returns the front of t, raising Empty if t is empty. Complexity: amortized O(1)

val dequeue : 'a t -> ('a * 'a t) option

Like dequeue_exn, but returns result optionally, without exception. Complexity: amortized O(1)

val discard_exn : 'a t -> 'a t

Returns version of queue with top element removed. Complexity: amortized O(1)

val to_list : 'a t -> 'a list

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). Complexity: O(n)

val length : 'a t -> int

complexity: O(1)

complexity: O(1)

val is_empty : 'a t -> bool

complexity: O(1)

val singleton : 'a -> 'a t
module Stable : sig .. end