Up

Module Linked_queue

Linked_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.

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 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
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
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
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 to_list : 'a t -> 'a 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 concat_map : 'a t -> f:('a -> 'b list) -> 'b t
val filter_map : 'a t -> f:('a -> 'b option) -> 'b t
val filter : 'a t -> f:('a -> bool) -> 'a t
val of_array : 'a array -> 'a t
val to_array : 'a t -> 'a array
val fold : 'a t -> init:'b -> f:('b -> 'a -> 'b) -> 'b
val singleton : 'a -> 'a t