Module `Base.Queue`

module type S = sig ... end

type 'a t

val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int

include S with type 'a t := 'a t

val filteri_inplace : 'a t -> f:(int -> 'a -> bool) -> unit
val filter_inplace : 'a t -> f:('a -> bool) -> unit: filter_inplace t ~f removes all elements of t that don't satisfy f. If f raises, t is unchanged. This is inplace in that it modifies t; however, it uses space linear in the final length of t.

val filteri : 'a t -> f:(int -> 'a -> bool) -> 'a t
val filter : 'a t -> f:('a -> bool) -> 'a t: filter is like filter_map, except with List.filter.

val filter_mapi : 'a t -> f:(int -> 'a -> 'b option) -> 'a t
val filter_map : 'a t -> f:('a -> 'b option) -> 'a t: filter_map creates a new queue with elements equal to List.filter_map ~f (to_list t).

val concat_mapi : 'a t -> f:(int -> 'a -> 'b list) -> 'a t
val concat_map : 'a t -> f:('a -> 'b list) -> 'a t: Creates a new queue with elements equal to List.concat_map ~f (to_list t).

val mapi : 'a t -> f:(int -> 'a -> 'b) -> 'a t
val map : 'a t -> f:('a -> 'b) -> 'a t
val copy : 'a t -> 'a t: copy t returns a copy of t.

val clear : 'a t -> unit: clear t discards all elements from t.

val peek_exn : 'a t -> 'a
val peek : 'a t -> 'a option: peek t returns but does not remove the front element of t, if any.

val dequeue_exn : 'a t -> 'a
val dequeue : 'a t -> 'a option: dequeue t removes and returns the front element of t, if any.

val enqueue_all : 'a t -> 'a list -> unit: enqueue_all t list adds all elements in list to t in order of list.

val enqueue : 'a t -> 'a -> unit: enqueue t a adds a to the end of t.

val init : int -> f:(int -> 'a) -> 'a t: init n ~f is equivalent to of_list (List.init n ~f).

val of_array : 'a array -> 'a t
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 singleton : 'a -> 'a t: singleton a returns a queue with one element.

include Indexed_container.S1 with type 'a t := 'a t

val mem : 'a t -> 'a -> equal:('a -> 'a -> bool) -> bool
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
val fold_result : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'e) Result.t) -> ('accum, 'e) Result.t
val fold_until : 'a t -> init:'accum -> f:('accum -> 'a -> ('accum, 'final) Base__.Container_intf.Export.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
val exists : 'a t -> f:('a -> bool) -> bool
val for_all : 'a t -> f:('a -> bool) -> bool
val count : 'a t -> f:('a -> bool) -> int
val sum : (module Base__.Container_intf.Summable with type t = 'sum) -> 'a t -> f:('a -> 'sum) -> 'sum
val find : 'a t -> f:('a -> bool) -> 'a option
val find_map : 'a t -> f:('a -> 'b option) -> 'b option
val to_list : 'a t -> 'a list
val to_array : 'a t -> 'a array
val min_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
val max_elt : 'a t -> compare:('a -> 'a -> int) -> 'a option
val foldi : 'a t -> init:'b -> f:(int -> 'b -> 'a -> 'b) -> 'b
val iteri : 'a t -> f:(int -> 'a -> unit) -> unit
val existsi : 'a t -> f:(int -> 'a -> bool) -> bool
val for_alli : 'a t -> f:(int -> 'a -> bool) -> bool
val counti : 'a t -> f:(int -> 'a -> bool) -> int
val findi : 'a t -> f:(int -> 'a -> bool) -> (int * 'a) option
val find_mapi : 'a t -> f:(int -> 'a -> 'b option) -> 'b option

val t_of_sexp : (Sexp.t -> 'a) -> Sexp.t -> 'a t
val sexp_of_t : ('a -> Sexp.t) -> 'a t -> Sexp.t

include Equal.S1 with type 'a t := 'a t

val equal : 'a Equal.equal -> 'a t Equal.equal

include Invariant.S1 with type 'a t := 'a t

val invariant : ('a -> unit) -> 'a t -> unit

val create : ?⁠capacity:int -> unit -> _ t: Create an empty queue.

val last : 'a t -> 'a option: last t returns the most recently enqueued element in t, if any.

val last_exn : 'a t -> 'a

val blit_transfer : src:'a t -> dst:'a t -> ?⁠len:int -> unit -> unit

Transfers up to len elements from the front of src to the end of dst, removing them from src. It is an error if len < 0.

Aside from a call to set_capacity dst if needed, runs in O(len) time

val get : 'a t -> int -> 'a: get t i returns the i'th element in t, where the 0'th element is at the front of t and the length t - 1 element is at the back.

val set : 'a t -> int -> 'a -> unit
val capacity : _ t -> int: Returns the current length of the backing array.

val set_capacity : _ t -> int -> unit: set_capacity t c sets the capacity of t's backing array to at least max c (length t). If t's capacity changes, then this involves allocating a new backing array and copying the queue elements over. set_capacity may decrease the capacity of t, if c < capacity t.