Class PriorityQueue<T>`Internal`

Priority queue.

+PriorityQueue | poolifier - v4.0.6

Class PriorityQueue<T>`Internal`

Priority queue.

Type Parameters

T
Type of priority queue data.
-

Index

Constructors

constructor +

Index

Methods

[iterator] clear dequeue @@ -16,26 +17,27 @@

Type Parameters

Parameters

k: number = Infinity
Prioritized bucket size.

Returns PriorityQueue<T>

Default Value

Infinity

Properties

`Private` `Readonly` k

k: number

Prioritized bucket size.

maxSize

maxSize: number

The maximum size of the priority queue.

`Private` nodeArray

nodeArray: PriorityQueueNode<T>[]

size

size: number

The size of the priority queue.

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns an iterator for the priority queue.
+
- Defined in src/priority-queue.ts:41

Properties

`Private` `Readonly` k

k: number

Prioritized bucket size.

maxSize

maxSize: number

The maximum size of the priority queue.

`Private` nodeArray

nodeArray: PriorityQueueNode<T>[]

size

size: number

The size of the priority queue.

Accessors

buckets

get buckets(): number
The number of filled prioritized buckets.
+
Returns number
- Defined in src/priority-queue.ts:32

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns an iterator for the priority queue.

Returns Iterator<T, any, undefined>
An iterator for the priority queue.

See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-
- Defined in src/priority-queue.ts:127

clear

clear(): void
Clears the priority queue.
-
Returns void
- Defined in src/priority-queue.ts:115

dequeue

dequeue(bucket?): undefined | T
Dequeue data from the priority queue.
+
- Defined in src/priority-queue.ts:131

clear

clear(): void
Clears the priority queue.
+
Returns void
- Defined in src/priority-queue.ts:119

dequeue

dequeue(bucket?): undefined | T
Dequeue data from the priority queue.
Parameters
- bucket: number = 0
  The prioritized bucket to dequeue from.
Returns undefined | T
The dequeued data or undefined if the priority queue is empty.
Default Value
```
0
 
```
-
- Defined in src/priority-queue.ts:78

enqueue

enqueue(data, priority?): number
Enqueue data into the priority queue.
+
- Defined in src/priority-queue.ts:82

enqueue

enqueue(data, priority?): number
Enqueue data into the priority queue.
Parameters
- data: T
  Data to enqueue.
- Optional priority: number
  Priority of the data. Lower values have higher priority.
Returns number
The new size of the priority queue.
-
- Defined in src/priority-queue.ts:52

`Private` incrementSize

incrementSize(): number
Increments the size of the priority queue.
+
- Defined in src/priority-queue.ts:59

`Private` incrementSize

incrementSize(): number
Increments the size of the priority queue.

Returns number
The new size of the priority queue.
-
- Defined in src/priority-queue.ts:152

peekFirst

peekFirst(): undefined | T
Peeks at the first data.
+
- Defined in src/priority-queue.ts:156

peekFirst

peekFirst(): undefined | T
Peeks at the first data.

Returns undefined | T
The first data or undefined if the priority queue is empty.
-
- Defined in src/priority-queue.ts:100

peekLast

peekLast(): undefined | T
Peeks at the last data.
+
- Defined in src/priority-queue.ts:104

peekLast

peekLast(): undefined | T
Peeks at the last data.

Returns undefined | T
The last data or undefined if the priority queue is empty.
-
- Defined in src/priority-queue.ts:108

\ No newline at end of file +

Class PriorityQueue<T>Internal

Class PriorityQueue<T>Internal

Type Parameters

Index

Constructors

Index

Constructors

Properties

Accessors

Methods

Type Parameters

Parameters

Returns PriorityQueue<T>

Default Value

Properties

Private Readonly k

maxSize

Private nodeArray

size

Methods

[iterator]

Properties

Private Readonly k

maxSize

Private nodeArray

size

Accessors

buckets

Returns number

Methods

[iterator]

Returns Iterator<T, any, undefined>

See

clear

Returns void

dequeue

clear

Returns void

dequeue

Parameters

Returns undefined | T

Default Value

enqueue

enqueue

Parameters

Returns number

Private incrementSize

Private incrementSize

Returns number

peekFirst

peekFirst

Returns undefined | T

peekLast

peekLast

Returns undefined | T

Settings

Member Visibility

Theme

On This Page

Settings

Member Visibility

Theme

On This Page

Class PriorityQueue<T>`Internal`

Class PriorityQueue<T>`Internal`

`Private` `Readonly` k

`Private` nodeArray

`Private` `Readonly` k

`Private` nodeArray

`Private` incrementSize

`Private` incrementSize