@technobuddha > library > Utility > Classes
Class: PriorityQueue<T>
Defined in: priority-queue.ts:6
A simple priority queue
Type Parameters
| Type Parameter |
|---|
T |
Constructors
Constructor
new PriorityQueue<T>(comparator: (a: T, b: T) => number, contents?: Iterable<T, any, any>): PriorityQueue<T>;Defined in: src/priority-queue.ts:14
Creates a new PriorityQueue.
Parameters
| Parameter | Type | Description |
|---|---|---|
comparator | (a: T, b: T) => number | Function to compare two elements and puts them in priority order. Takes two elements as arguments and returns a number greater, less then or equal to zero. |
contents? | Iterable<T, any, any> | Initial contents of the queue |
Returns
PriorityQueue<T>
Accessors
size
Get Signature
get size(): number;Defined in: src/priority-queue.ts:68
Determine the number of items in the queue
Returns
number
number of element in the queue
Methods
[iterator]()
iterator: Iterator<T>;Defined in: src/priority-queue.ts:56
Iterate through all elements in the queue
Returns
Iterator<T>
generator function
map()
map<S>(f: (value: T, index: number, array: T[]) => S): S[];Defined in: src/priority-queue.ts:78
Transform all elements in the queue
Type Parameters
| Type Parameter |
|---|
S |
Parameters
| Parameter | Type | Description |
|---|---|---|
f | (value: T, index: number, array: T[]) => S | Function to transform each element of the queue |
Returns
S[]
array of transformed queue elements
pop()
pop(): undefined | T;Defined in: src/priority-queue.ts:44
Return and remove the highest priority item from the queue
Returns
undefined | T
queue element
push()
push(...o: T[]): void;Defined in: src/priority-queue.ts:34
Add an element to the queue
Parameters
| Parameter | Type | Description |
|---|---|---|
...o | T[] | element to be added |
Returns
void
reorder()
reorder(newComparator: (a: T, b: T) => number): void;Defined in: src/priority-queue.ts:90
Change the function used to order the queue
Parameters
| Parameter | Type | Description |
|---|---|---|
newComparator | (a: T, b: T) => number | function to compare elements of the queue |
Returns
void