Class PriorityQueue<T, P>

A priority queue implementation.

Type Parameters

T
The type of elements in the priority queue.
P = number
The type of priority associated with each element.

Hierarchy (View Summary)

BinaryHeapCollection<[T, P]>
- PriorityQueue

Implements

IPriorityQueue<T, P>

Index

Constructors

constructor

new PriorityQueue<T, P = number>(
    iterable?: Iterable<[T, P], any, any>,
    capacity?: number,
    isHigherPriority?: PriorityQueueIsHigherPriorityPredicate<P>,
): PriorityQueue<T, P>
Type Parameters
- T
- P = number
Parameters
- Optionaliterable: Iterable<[T, P], any, any>
- Optionalcapacity: number
- isHigherPriority: PriorityQueueIsHigherPriorityPredicate<P> = ...
Returns PriorityQueue<T, P>
Overrides BinaryHeapCollection.constructor
- Defined in packages/misc-util/src/data/priority-queue.ts:17

Properties

`Readonly`capacity

capacity: number = Infinity

The maximum number of elements the collection can hold. If the collection is unbounded, this will be Infinity.

`Protected` `Readonly`data

data: BinaryHeap<[T, P]>

`Readonly`isHigherPriority

isHigherPriority: PriorityQueueIsHigherPriorityPredicate<P> = ...

Predicate function which determine if one priority is higher than another.

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<[T, P]>
Returns AsyncIterator<[T, P]>
Implementation of IPriorityQueue.[asyncIterator]
Inherited from BinaryHeapCollection.[asyncIterator]
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:19

[iterator]

"[iterator]"(): Iterator<[T, P]>
Returns Iterator<[T, P]>
Implementation of IPriorityQueue.[iterator]
Inherited from BinaryHeapCollection.[iterator]
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:16

clear

clear(): void
Removes all elements from the collection.

Returns void
Implementation of IPriorityQueue.clear
Inherited from BinaryHeapCollection.clear
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:23

concat

concat(...items: [T, P][]): IterableIterator<[T, P]>
Concatenates the given items to the end of the collection and returns an iterator over the merged items.

This method does not mutate the original collection.
Parameters
- ...items: [T, P][]
  The items to merge.
Returns IterableIterator<[T, P]>
An iterator of the merged items.
Implementation of IPriorityQueue.concat
Inherited from BinaryHeapCollection.concat
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:31

count

count(): number
Returns the number of elements in the collection.

Returns number
Implementation of IPriorityQueue.count
Inherited from BinaryHeapCollection.count
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:27

extract

extract(): T | undefined
Removes and returns the item with the highest priority from the priority queue.

Returns T | undefined
The item with the highest priority, or undefined if the queue is empty.
Implementation of IPriorityQueue.extract
- Defined in packages/misc-util/src/data/priority-queue.ts:51

insert

insert(priority: P, ...items: T[]): void
Inserts one or more items with their associated priorities into the priority queue.
Parameters
- priority: P
  The priority of the items to insert.
- ...items: T[]
  The items to insert.
Returns void
Throws
If the operation would exceed the deque's capacity.
Implementation of IPriorityQueue.insert
- Defined in packages/misc-util/src/data/priority-queue.ts:36

peek

peek(): T | undefined
Returns the item with the highest priority without removing it from the queue.

Returns T | undefined
The item with the highest priority, or undefined if the queue is empty.
Implementation of IPriorityQueue.peek
- Defined in packages/misc-util/src/data/priority-queue.ts:60

remove

remove(condition: Predicate<[[T, P]]>): IterableIterator<[T, P]>
Removes all the items matching the given predicate from the collection.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the items to remove.
Returns IterableIterator<[T, P]>
An iterable of the removed items.
Implementation of IPriorityQueue.remove
Inherited from BinaryHeapCollection.remove
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:39

removeFirst

removeFirst(condition: Predicate<[[T, P]]>): boolean
Removes the first occurrence of the item matching the given predicate from the collection.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the item to remove.
Returns boolean
true if the item was found and removed, false otherwise.
Implementation of IPriorityQueue.removeFirst
Inherited from BinaryHeapCollection.removeFirst
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:35

replace

replace(
condition: Predicate<[[T, P]]>,
newItem: Callable<[[T, P]], [T, P]>,
): IterableIterator<[T, P]>
Replaces all the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the items to replace.
- newItem: Callable<[[T, P]], [T, P]>
Returns IterableIterator<[T, P]>
An iterable of the replaced items.
Implementation of IPriorityQueue.replace
Inherited from BinaryHeapCollection.replace
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:47

replaceFirst

replaceFirst(condition: Predicate<[[T, P]]>, newItem: [T, P]): boolean
Replaces the first occurence of the item matching the given predicate in the collection with a new item.
Parameters
- condition: Predicate<[[T, P]]>
  A predicate function to identify the item to replace.
- newItem: [T, P]
  The new item to insert.
Returns boolean
true if the item was found and replaced, false otherwise.
Implementation of IPriorityQueue.replaceFirst
Inherited from BinaryHeapCollection.replaceFirst
- Defined in packages/misc-util/src/data/collection-base/binary-heap-collection.ts:43

setPriority

setPriority(item: T, newPriority: P): boolean
Updates the priority of an existing item in the priority queue.
Parameters
- item: T
  The item whose priority is to be updated.
- newPriority: P
  The new priority of the item.
Returns boolean
Implementation of IPriorityQueue.setPriority
- Defined in packages/misc-util/src/data/priority-queue.ts:69

waitInsert

waitInsert(
    priority: P,
    items: Iterable<T>,
    signal?: AbortSignal | null,
): Promise<void>
Same as insert, but waits for capacity if the operation would exceed it.
Parameters
- priority: P
- items: Iterable<T>
- Optionalsignal: AbortSignal | null
  Optional abort signal to cancel the operation.
Returns Promise<void>
See
IPriorityQueue.insert
Implementation of IPriorityQueue.waitInsert
- Defined in packages/misc-util/src/data/priority-queue.ts:40

Class PriorityQueue<T, P>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PriorityQueue<T, P>

Properties

Readonlycapacity

Protected Readonlydata

ReadonlyisHigherPriority

Methods

[asyncIterator]

Returns AsyncIterator<[T, P]>

[iterator]

Returns Iterator<[T, P]>

clear

Returns void

concat

Parameters

Returns IterableIterator<[T, P]>

count

Returns number

extract

Returns T | undefined

insert

Parameters

Returns void

Throws

peek

Returns T | undefined

remove

Parameters

Returns IterableIterator<[T, P]>

removeFirst

Parameters

Returns boolean

replace

Parameters

Returns IterableIterator<[T, P]>

replaceFirst

Parameters

Returns boolean

setPriority

Parameters

Returns boolean

waitInsert

Parameters

Returns Promise<void>

See

Settings

On This Page

`Readonly`capacity

`Protected` `Readonly`data

`Readonly`isHigherPriority