ImmutablePriorityQueue

An immutable priority queue. 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 ImmutablePriorityQueue from "immutablepriorityqueue"

Types

Type declarations included in the ImmutablePriorityQueue module.

ImmutablePriorityQueue.ImmutablePriorityQueue

1

type ImmutablePriorityQueue<a>

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

Values

Functions and constants for working with ImmutablePriorityQueues.

ImmutablePriorityQueue.empty

1

empty : ImmutablePriorityQueue<a>

An empty priority queue with the default compare comparator.

ImmutablePriorityQueue.make

1

make : ((a, a) -> Number) -> ImmutablePriorityQueue<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

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

1

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

ImmutablePriorityQueue.size

1

size : ImmutablePriorityQueue<a> -> Number

Gets the number of elements in a priority queue.

Parameters:

Returns:

ImmutablePriorityQueue.isEmpty

1

isEmpty : ImmutablePriorityQueue<a> -> Bool

Determines if the priority queue contains no elements.

Parameters:

Returns:

ImmutablePriorityQueue.push

1

push : (a, ImmutablePriorityQueue<a>) -> ImmutablePriorityQueue<a>

Produces a new priority queue by inserting the given element into the given priority queue.

Parameters:

Returns:

ImmutablePriorityQueue.peek

1

peek : ImmutablePriorityQueue<a> -> Option<a>

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

Parameters:

Returns:

ImmutablePriorityQueue.pop

1

pop : ImmutablePriorityQueue<a> -> ImmutablePriorityQueue<a>

Produces a new priority queue without the highest priority element in the given priority queue. If the input priority queue is empty, this function will return it.

Parameters:

Returns:

ImmutablePriorityQueue.drain

1

drain : ImmutablePriorityQueue<a> -> List<a>

Produces a list of all elements in the priority queue in priority order.

Parameters:

Returns:

ImmutablePriorityQueue.fromList

1

fromList : (List<a>, ((a, a) -> Number)) -> ImmutablePriorityQueue<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:

ImmutablePriorityQueue.fromArray

1

fromArray : (Array<a>, ((a, a) -> Number)) -> ImmutablePriorityQueue<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: