PriorityQueue

A mutable priority queue implementation. A priority queue is a data structure that maintains elements in a priority order. Elements with higher priority are served before elements with lower priority when extracting from the priority queue.

1

import PriorityQueue from "priorityqueue"

Types

Type declarations included in the PriorityQueue module.

PriorityQueue.PriorityQueue

1

type PriorityQueue<a>

Mutable data structure which maintains a priority order for its elements.

Values

Functions for working with PriorityQueues.

PriorityQueue.makeSized

1

makeSized : (Number, ((a, a) -> Number)) -> PriorityQueue<a>

Creates a new priority queue with a given internal storage size and a comparator function, which is used to determine priority of elements. The comparator function takes two elements and must return 0 if both share priority, a positive number if the first has greater priority, and a negative number if the first has less priority.

Generally, you won’t need to care about the storage size of your priority queue and can use PriorityQueue.make() instead.

Parameters:

Returns:

PriorityQueue.make

1

make : ((a, a) -> Number) -> PriorityQueue<a>

Creates a new priority queue with a comparator function, which is used to determine priority of elements. The comparator function takes two elements and must return 0 if both share priority, a positive number if the first has greater priority, and a negative number if the first has less priority.

Parameters:

Returns:

Examples:

1

PriorityQueue.make(compare) // creates a min priority queue of numbers using the compare pervasive

1

PriorityQueue.make((a, b) => String.length(b) - String.length(a)) // creates a priority queue by string length (longest to shortest)

PriorityQueue.size

1

size : PriorityQueue<a> -> Number

Gets the number of elements in a priority queue.

Parameters:

Returns:

PriorityQueue.isEmpty

1

isEmpty : PriorityQueue<a> -> Bool

Determines if the priority queue contains no elements.

Parameters:

Returns:

PriorityQueue.push

1

push : (a, PriorityQueue<a>) -> Void

Adds a new element to the priority queue.

Parameters:

PriorityQueue.peek

1

peek : PriorityQueue<a> -> Option<a>

Retrieves the highest priority element in the priority queue. It is not removed from the queue.

Parameters:

Returns:

PriorityQueue.pop

1

pop : PriorityQueue<a> -> Option<a>

Removes and retrieves the highest priority element in the priority queue.

Parameters:

Returns:

PriorityQueue.drain

1

drain : PriorityQueue<a> -> List<a>

Clears the priority queue and produces a list of all of the elements in the priority queue in priority order.

Parameters:

Returns:

PriorityQueue.fromArray

1

fromArray : (Array<a>, ((a, a) -> Number)) -> PriorityQueue<a>

Constructs a new priority queue initialized with the elements in the array using a custom comparator function, which is used to determine priority of elements. The comparator function takes two elements and must return 0 if both share priority, a positive number if the first has greater priority, and a negative number if the first has less priority.

Parameters:

Returns:

PriorityQueue.fromList

1

fromList : (List<a>, ((a, a) -> Number)) -> PriorityQueue<a>

Constructs a new priority queue initialized with the elements in the list using a custom comparator function, which is used to determine priority of elements. The comparator function takes two elements and must return 0 if both share priority, a positive number if the first has greater priority, and a negative number if the first has less priority.

Parameters:

Returns: