Module Belt.MutableQueue

Belt.MutableQueue

An FIFO(first in first out) queue data structure

First-in first-out queues.

This module implements queues (FIFOs), with in-place modification.

type 'a t

type t('a);

The type of queues containing elements of type 'a.

val make : unit -> 'a t

let make: unit => t('a);

returns a new queue, initially empty.

val clear : 'a t -> unit

let clear: t('a) => unit;

Discard all elements from the queue.

val isEmpty : 'a t -> bool

let isEmpty: t('a) => bool;

returns true if the given queue is empty, false otherwise.

val fromArray : 'a array -> 'a t

let fromArray: array('a) => t('a);

fromArray a is equivalent to Array.forEach a (add q a)

val add : 'a t -> 'a -> unit

let add: t('a) => 'a => unit;

add q x adds the element x at the end of the queue q.

val peek : 'a t -> 'a option

let peek: t('a) => option('a);

peekOpt q returns the first element in queue q, without removing it from the queue.

val peekUndefined : 'a t -> 'a Js.undefined

let peekUndefined: t('a) => Js.undefined('a);

peekUndefined q returns undefined if not found

val peekExn : 'a t -> 'a

let peekExn: t('a) => 'a;

peekExn q

raise an exception if q is empty

val pop : 'a t -> 'a option

let pop: t('a) => option('a);

pop q removes and returns the first element in queue q.

val popUndefined : 'a t -> 'a Js.undefined

let popUndefined: t('a) => Js.undefined('a);

popUndefined q removes and returns the first element in queue q. it will return undefined if it is already empty

val popExn : 'a t -> 'a

let popExn: t('a) => 'a;

popExn q

raise an exception if q is empty

val copy : 'a t -> 'a t

let copy: t('a) => t('a);

copy q

returns a fresh queue

val size : 'a t -> int

let size: t('a) => int;

returns the number of elements in a queue.

val mapU : 'a t -> ('a -> 'b) Js.Fn.arity1 -> 'b t

let mapU: t('a) => Js.Fn.arity1(('a => 'b)) => t('b);

val map : 'a t -> ('a -> 'b) -> 'b t

let map: t('a) => ('a => 'b) => t('b);

val forEachU : 'a t -> ('a -> unit) Js.Fn.arity1 -> unit

let forEachU: t('a) => Js.Fn.arity1(('a => unit)) => unit;

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

let forEach: t('a) => ('a => unit) => unit;

forEach q f applies f in turn to all elements of q, from the least recently entered to the most recently entered. The queue itself is unchanged.

val reduceU : 'a t -> 'b -> ('b -> 'a -> 'b) Js.Fn.arity2 -> 'b

let reduceU: t('a) => 'b => Js.Fn.arity2(('b => 'a => 'b)) => 'b;

val reduce : 'a t -> 'b -> ('b -> 'a -> 'b) -> 'b

let reduce: t('a) => 'b => ('b => 'a => 'b) => 'b;

reduce q accu f is equivalent to List.reduce l accu f, where l is the list of q's elements. The queue remains unchanged.

val transfer : 'a t -> 'a t -> unit

let transfer: t('a) => t('a) => unit;

transfer q1 q2 adds all of q1's elements at the end of the queue q2, then clears q1. It is equivalent to the sequence forEach (fun x -> add x q2) q1; clear q1, but runs in constant time.

val toArray : 'a t -> 'a array

let toArray: t('a) => array('a);

First added will be in the beginning of the array