Class PriorityQueue<T>

A min-heap based priority queue. Elements with lower priority values are dequeued first.

Since

0.6.0

Type Parameters

T

Index

Constructors

Accessors

Methods

clear insert peek pop remove removeWhere toArray

Constructors

constructor

new PriorityQueue<T>(compareFn?: (a: T, b: T) => number): PriorityQueue<T>
Create a new PriorityQueue.
Type Parameters
- T
Parameters
- compareFn: (a: T, b: T) => number = ...
  Comparison function. Should return negative if a < b, positive if a > b, zero if equal. Defaults to numeric comparison.
Returns PriorityQueue<T>
- Defined in utils/PriorityQueue.ts:15

Accessors

isEmpty

get isEmpty(): boolean
Whether the queue is empty.

Returns boolean
- Defined in utils/PriorityQueue.ts:29

size

get size(): number
Number of elements in the queue.

Returns number
- Defined in utils/PriorityQueue.ts:22

Methods

clear

clear(): void
Remove all elements from the queue.

Returns void
- Defined in utils/PriorityQueue.ts:100

insert

insert(item: T): void
Insert an element into the queue.
Parameters
- item: T
Returns void
- Defined in utils/PriorityQueue.ts:36

peek

peek(): T
View the highest-priority element without removing it. Returns undefined if the queue is empty.

Returns T
- Defined in utils/PriorityQueue.ts:45

pop

pop(): T
Remove and return the highest-priority element. Returns undefined if the queue is empty.

Returns T
- Defined in utils/PriorityQueue.ts:53

remove

remove(item: T): boolean
Remove a specific item from the queue. Returns true if the item was found and removed.
Parameters
- item: T
Returns boolean
- Defined in utils/PriorityQueue.ts:67

removeWhere

removeWhere(predicate: (item: T) => boolean): number
Remove all elements matching a predicate. Returns the number of elements removed.
Parameters
- predicate: (item: T) => boolean
Returns number
- Defined in utils/PriorityQueue.ts:87

toArray

toArray(): T[]
Convert to array (does not modify queue). Order is not guaranteed.

Returns T[]
- Defined in utils/PriorityQueue.ts:107