Class PriorityQueue<T>`Internal`

Priority queue.

+PriorityQueue | poolifier - v4.0.15

Class PriorityQueue<T>`Internal`

Priority queue.

Type Parameters

T
Type of priority queue data.
-

Index

Constructors

constructor +

Index

Constructors

constructor

Properties

bucketSize head maxSize @@ -16,22 +16,24 @@

Type Parameters

Parameters

bucketSize: number = defaultBucketSize
Prioritized bucket size.
enablePriority: boolean = false
Whether to enable priority.

Returns PriorityQueue<T>

PriorityQueue.

Default Value

defaultBucketSize
+Default Value
defaultBucketSize
 
-Default Value
false
+Default Value
false
 
-
Defined in src/priority-queue.ts:40

`Properties`

Private Readonly bucketSize
bucketSize: number
Defined in src/priority-queue.ts:29

Private head
head: PriorityQueueNode<T>
Defined in src/priority-queue.ts:27

maxSize
maxSize: number
The priority queue maximum size.
-
Defined in src/priority-queue.ts:31

Private tail
tail: PriorityQueueNode<T>
Defined in src/priority-queue.ts:28

`Accessors`

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

enablePriority
get enablePriority(): boolean
Returns boolean
Defined in src/priority-queue.ts:73
set enablePriority(enablePriority): void
Parameters
enablePriority: boolean
Returns void
Defined in src/priority-queue.ts:77

size
get size(): number
The priority queue size.
-
Returns number
Defined in src/priority-queue.ts:63

`Methods`

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

`Properties`

Private Readonly bucketSize
bucketSize: number
Defined in src/priority-queue.ts:27

Private head
head: PriorityQueueNode<T>
Defined in src/priority-queue.ts:25

maxSize
maxSize: number
The priority queue maximum size.
+
Defined in src/priority-queue.ts:29

Private tail
tail: PriorityQueueNode<T>
Defined in src/priority-queue.ts:26

`Accessors`

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

enablePriority
get enablePriority(): boolean
Returns boolean
Defined in src/priority-queue.ts:71
set enablePriority(enablePriority): void
Parameters
enablePriority: boolean
Returns void
Defined in src/priority-queue.ts:75

size
get size(): number
The priority queue size.
+
Returns number
The priority queue size.
+
Defined in src/priority-queue.ts:61

`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:178

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

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

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

dequeue
dequeue(bucket?): undefined | T
Dequeue data from the priority queue.
 
Parameters
Optional bucket: numberThe prioritized bucket to dequeue from.
 
Returns undefined | T
The dequeued data or undefined if the priority queue is empty.
-
Defined in src/priority-queue.ts:123

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

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


\ No newline at end of file
+
Defined in src/priority-queue.ts:100

Class PriorityQueue<T>Internal

Class PriorityQueue<T>Internal

Type Parameters

Index

Constructors

Index

Constructors

Properties

Type Parameters

Parameters

Returns PriorityQueue<T>

Default Value

Default Value

Default Value

Default Value

Properties

Private Readonly bucketSize

Private head

maxSize

Private tail

Accessors

buckets

Returns number

enablePriority

Returns boolean

Parameters

Returns void

size

Returns number

Methods

[iterator]

Properties

Private Readonly bucketSize

Private head

maxSize

Private tail

Accessors

buckets

Returns number

enablePriority

Returns boolean

Parameters

Returns void

size

Returns number

Methods

[iterator]

Returns Iterator<T, any, undefined>

See

clear

Returns void

dequeue

clear

Returns void

dequeue

Parameters

Returns undefined | T

enqueue

enqueue

Parameters

Returns number

Settings

Member Visibility

Theme

On This Page

Settings

Member Visibility

Theme

On This Page

Class PriorityQueue<T>`Internal`

Class PriorityQueue<T>`Internal`

`Properties`

`Private` `Readonly` bucketSize

`Private` head

`Private` tail

`Accessors`

`Methods`

`Properties`

`Private` `Readonly` bucketSize

`Private` head

`Private` tail

`Accessors`

`Methods`

`Settings`

`Member Visibility`

`Theme`

`On This Page`

`Settings`

`Member Visibility`

`Theme`

`On This Page`