Class PriorityQueue<T>`Internal`

Priority queue.

+PriorityQueue | poolifier - v4.0.14

Class PriorityQueue<T>`Internal`

Priority queue.

Type Parameters

T
Type of priority queue data.
-

Index

Constructors

constructor -

Properties

k +

Index

Constructors

constructor

new PriorityQueue<T>(k?): PriorityQueue<T>
Constructs a priority queue.
-
Type Parameters
- T
Parameters
- k: number = Infinity
  Prioritized bucket size.
  -
Returns PriorityQueue<T>
Default Value
```
Infinity
+
```

`Constructors`

constructor
new PriorityQueue<T>(bucketSize?, enablePriority?): PriorityQueue<T>
Constructs a priority queue.
+
Type Parameters
T
Parameters
bucketSize: number = defaultBucketSizePrioritized bucket size.
+
enablePriority: boolean = falseWhether to enable priority.
+
Returns PriorityQueue<T>
PriorityQueue.
+Default Value
defaultBucketSize
 
-
Defined in src/priority-queue.ts:41

`Properties`

Private Readonly k
k: number
Prioritized bucket size.
-
Defined in src/priority-queue.ts:23

maxSize
maxSize: number
The maximum size of the priority queue.
-
Defined in src/priority-queue.ts:27

Private nodeArray
nodeArray: PriorityQueueNode<T>[]
Defined in src/priority-queue.ts:21

size
size: number
The size of the priority queue.
-
Defined in src/priority-queue.ts:25

`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.
+Default Value
false
+
+
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
Defined in src/priority-queue.ts:88

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

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

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

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

Private decrementSize
decrementSize(): number
Decrements the size of the priority queue.
-
Returns number
The new size of the priority queue.
-
Defined in src/priority-queue.ts:167

dequeue
dequeue(bucket?): undefined | T
Dequeue data from the priority queue.
-
Parameters
bucket: number = 0The prioritized bucket to dequeue from.
+
Defined in src/priority-queue.ts:172

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

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.
-Default Value
0
-
-
Defined in src/priority-queue.ts:82

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

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: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:154

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:102

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:110


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

Class PriorityQueue<T>Internal

Class PriorityQueue<T>Internal

Type Parameters

Index

Constructors

Properties

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PriorityQueue<T>

Default Value

Constructors

constructor

Type Parameters

Parameters

Returns PriorityQueue<T>

Default Value

Properties

Private Readonly k

maxSize

Private nodeArray

size

Accessors

buckets

Returns number

Methods

[iterator]

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]

Returns Iterator<T, any, undefined>

See

clear

Returns void

Private decrementSize

Returns number

dequeue

Parameters

clear

Returns void

dequeue

Parameters

Returns undefined | T

Default Value

enqueue

enqueue

Parameters

Returns number

Private incrementSize

Returns number

peekFirst

Returns undefined | T

peekLast

Returns undefined | T

Settings

Member Visibility

Theme

On This Page

Settings

Member Visibility

Class PriorityQueue<T>`Internal`

Class PriorityQueue<T>`Internal`

`Constructors`

`Properties`

`Private` `Readonly` k

`Private` nodeArray

`Accessors`

`Methods`

`Properties`

`Private` `Readonly` bucketSize

`Private` head

`Private` tail

`Accessors`

`Methods`

`Private` decrementSize

`Private` incrementSize

`Settings`

`Member Visibility`

`Theme`

`On This Page`

`Settings`

`Member Visibility`

`Theme`

`On This Page`