Queue

A queue is a FIFO (first-in-first-out) data structure where new values are added to the end and retrieved or removed from the beginning.

The default implementation is mutable, but an immutable queue implementation is available in the Immutable submodule.

1

from "queue" include Queue

Types

Type declarations included in the Queue module.

Queue.Queue

1

type Queue<a>

A mutable FIFO (first-in-first-out) data structure.

Values

Functions and constants included in the Queue module.

Queue.make

1

make : (?size: Number) => Queue<a>

Creates a new queue with an initial storage of the given size. As values are added or removed, the internal storage may grow or shrink. Generally, you won’t need to care about the storage size of your map and can use the default size.

Parameters:

Returns:

Queue.isEmpty

1

isEmpty : (queue: Queue<a>) => Bool

Checks if the given queue contains no items.

Parameters:

Returns:

Queue.size

1

size : (queue: Queue<a>) => Number

Computes the size of the input queue.

Parameters:

Returns:

Queue.peek

1

peek : (queue: Queue<a>) => Option<a>

Provides the value at the beginning of the queue, if it exists.

Parameters:

Returns:

Queue.push

1

push : (value: a, queue: Queue<a>) => Void

Adds a new item to the end of the queue.

Parameters:

Queue.pop

1

pop : (queue: Queue<a>) => Option<a>

Removes the item at the beginning of the queue.

Parameters:

Returns:

Queue.toList

1

toList : (queue: Queue<a>) => List<a>

Converts a queue into a list of its elements.

Parameters:

Returns:

Queue.fromList

1

fromList : (list: List<a>) => Queue<a>

Creates a queue from a list.

Parameters:

Returns:

Queue.clear

1

clear : (queue: Queue<a>) => Void

Clears the queue by removing all of its elements

Parameters:

Queue.copy

1

copy : (queue: Queue<a>) => Queue<a>

Produces a shallow copy of the input queue.

Parameters:

Returns:

Queue.toArray

1

toArray : (queue: Queue<a>) => Array<a>

Converts a queue into an array of its values.

Parameters:

Returns:

Queue.fromArray

1

fromArray : (arr: Array<a>) => Queue<a>

Creates a queue from an array.

Parameters:

Returns:

Queue.(==)

1

(==) : (queue1: Queue<a>, queue2: Queue<a>) => Bool

Checks if two queues are equivalent by value.

Parameters:

Returns:

Queue.Immutable

An immutable queue implementation.

Types

Type declarations included in the Queue.Immutable module.

Queue.Immutable.ImmutableQueue

1

type ImmutableQueue<a>

An immutable FIFO (first-in-first-out) data structure.

Values

Functions and constants included in the Queue.Immutable module.

Queue.Immutable.empty

1

empty : ImmutableQueue<a>

An empty queue.

Queue.Immutable.isEmpty

1

isEmpty : (queue: ImmutableQueue<a>) => Bool

Checks if the given queue contains any values.

Parameters:

Returns:

Queue.Immutable.peek

1

peek : (queue: ImmutableQueue<a>) => Option<a>

Returns the value at the beginning of the queue. It is not removed from the queue.

Parameters:

Returns:

Queue.Immutable.push

1

push : (value: a, queue: ImmutableQueue<a>) => ImmutableQueue<a>

Adds a value to the end of the queue.

Parameters:

Returns:

Queue.Immutable.pop

1

pop : (queue: ImmutableQueue<a>) => ImmutableQueue<a>

Dequeues the next value in the queue.

Parameters:

Returns:

Queue.Immutable.size

1

size : (queue: ImmutableQueue<a>) => Number

Get the number of values in a queue.

Parameters:

Returns:

Queue.Immutable.toList

1

toList : (queue: ImmutableQueue<a>) => List<a>

Converts a queue into a list of its elements.

Parameters:

Returns:

Queue.Immutable.fromList

1

fromList : (list: List<a>) => ImmutableQueue<a>

Creates a queue from a list.

Parameters:

Returns: