Class FixedPriorityQueue<T>`Internal`

Fixed priority queue.

+FixedPriorityQueue | poolifier - v4.0.15

Class FixedPriorityQueue<T>`Internal`

Fixed priority queue.

Type Parameters

T
Type of fixed priority queue data.
-

Hierarchy (view full)

FixedPriorityQueue
- PriorityQueueNode

Index

Constructors

constructor +

Hierarchy (view full)

FixedPriorityQueue
- PriorityQueueNode

Index

Constructors

constructor

Properties

capacity enablePriority nodeArray @@ -18,31 +18,31 @@

Type Parameters

Parameters

size: number = defaultQueueSize
Fixed priority queue size.
enablePriority: boolean = false
Whether to enable priority.

Returns FixedPriorityQueue<T>

FixedPriorityQueue.

Default Value

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

`Properties`

Readonly capacity
capacity: number
The fixed priority queue capacity.
-
Defined in src/fixed-priority-queue.ts:27

enablePriority
enablePriority: boolean
Whether to enable priority.
-
Defined in src/fixed-priority-queue.ts:31

Private Readonly nodeArray
nodeArray: FixedPriorityQueueNode<T>[]
Defined in src/fixed-priority-queue.ts:25

size
size: number
The fixed priority queue size.
-
Defined in src/fixed-priority-queue.ts:29

Private start
start: number
Defined in src/fixed-priority-queue.ts:24

`Methods`

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

`Properties`

Readonly capacity
capacity: number
The fixed priority queue capacity.
+
Defined in src/fixed-priority-queue.ts:25

enablePriority
enablePriority: boolean
Whether to enable priority.
+
Defined in src/fixed-priority-queue.ts:29

Private Readonly nodeArray
nodeArray: FixedPriorityQueueNode<T>[]
Defined in src/fixed-priority-queue.ts:23

size
size: number
The fixed priority queue size.
+
Defined in src/fixed-priority-queue.ts:27

Private start
start: number
Defined in src/fixed-priority-queue.ts:22

`Methods`

[iterator]
[iterator](): Iterator<T, any, undefined>
Returns an iterator for the fixed priority queue.
 
Returns Iterator<T, any, undefined>
An iterator for the fixed priority queue.
 See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-
Defined in src/fixed-priority-queue.ts:155

Private checkSize
checkSize(size): void
Checks the queue size.
+
Defined in src/fixed-priority-queue.ts:145

Private checkSize
checkSize(size): void
Checks the queue size.
 
Parameters
size: numberQueue size.
-
Returns void
Defined in src/fixed-priority-queue.ts:185

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

dequeue
dequeue(): undefined | T
Dequeue data from the fixed priority queue.
+

`Returns void`

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

dequeue
dequeue(): undefined | T
Dequeue data from the fixed priority queue.
 
Returns undefined | T
The dequeued data or undefined if the priority queue is empty.
-
Defined in src/fixed-priority-queue.ts:128

empty
empty(): boolean
Checks if the fixed priority queue is empty.
+
Defined in src/fixed-priority-queue.ts:119

empty
empty(): boolean
Checks if the fixed priority queue is empty.
 
Returns boolean
true if the fixed priority queue is empty, false otherwise.
-
Defined in src/fixed-priority-queue.ts:53

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

enqueue
enqueue(data, priority?): number
Enqueue data into the fixed 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.
 Throws
If the fixed priority queue is full.
-
Defined in src/fixed-priority-queue.ts:74

full
full(): boolean
Checks if the fixed priority queue is full.
+
Defined in src/fixed-priority-queue.ts:68

full
full(): boolean
Checks if the fixed priority queue is full.
 
Returns boolean
true if the fixed priority queue is full, false otherwise.
-
Defined in src/fixed-priority-queue.ts:62

get
get(index): undefined | T
Gets data from the fixed priority queue.
+
Defined in src/fixed-priority-queue.ts:57

get
get(index): undefined | T
Gets data from the fixed priority queue.
 
Parameters
index: numberThe index of the data to get.
 
Returns undefined | T
The data at the index or undefined if the fixed priority queue is empty or the index is out of bounds.
-
Defined in src/fixed-priority-queue.ts:112


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

Class FixedPriorityQueue<T>Internal

Class FixedPriorityQueue<T>Internal

Type Parameters

Hierarchy (view full)

Index

Constructors

Hierarchy (view full)

Index

Constructors

Properties

Type Parameters

Parameters

Returns FixedPriorityQueue<T>

Default Value

Default Value

Default Value

Default Value

Properties

Readonly capacity

enablePriority

Private Readonly nodeArray

size

Private start

Methods

[iterator]

Properties

Readonly capacity

enablePriority

Private Readonly nodeArray

size

Private start

Methods

[iterator]

Returns Iterator<T, any, undefined>

See

Private checkSize

Private checkSize

Parameters

Returns void

clear

Returns void

dequeue

Returns void

clear

Returns void

dequeue

Returns undefined | T

empty

empty

Returns boolean

enqueue

enqueue

Parameters

Returns number

Throws

full

full

Returns boolean

get

get

Parameters

Returns undefined | T

Settings

Member Visibility

Theme

On This Page

Settings

Member Visibility

Theme

On This Page

Class FixedPriorityQueue<T>`Internal`

Class FixedPriorityQueue<T>`Internal`

`Properties`

`Readonly` capacity

`Private` `Readonly` nodeArray

`Private` start

`Methods`

`Properties`

`Readonly` capacity

`Private` `Readonly` nodeArray

`Private` start

`Methods`

`Private` checkSize

`Private` checkSize

`Returns void`

`Settings`

`Member Visibility`

`Theme`

`On This Page`

`Settings`

`Member Visibility`

`Theme`

`On This Page`