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

new FixedPriorityQueue<T>(size?, enablePriority?): FixedPriorityQueue<T>
Constructs a fixed priority queue.
+

Constructors

constructor

new FixedPriorityQueue<T>(size?, enablePriority?): FixedPriorityQueue<T>
Constructs a fixed priority queue.
Type Parameters
- T
Parameters
- size: number = defaultQueueSize
  Fixed priority queue size.
- enablePriority: boolean = false
  Whether to enable priority.
Returns FixedPriorityQueue<T>
FixedPriorityQueue.
-
Default Value
```
defaultQueueSize
-
```
-
Default Value
```
false
-
```
-
- Defined in src/fixed-priority-queue.ts:37

Properties

`Readonly` capacity

capacity: number

The fixed priority queue capacity.

enablePriority

enablePriority: boolean

Whether to enable priority.

`Private` `Readonly` nodeArray

nodeArray: FixedPriorityQueueNode<T>[]

size

size: number

The fixed priority queue size.

`Private` start

start: number

Methods

[iterator]

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

Properties

`Readonly`capacity

capacity: number

The fixed priority queue capacity.

enablePriority

enablePriority: boolean

Whether to enable priority.

size

size: number

The fixed priority queue size.

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

`Private` checkSize

checkSize(size): void
Checks the queue size.
-
Parameters
- size: number
  Queue size.
  -
Returns void
- Defined in src/fixed-priority-queue.ts:175

clear

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

dequeue

dequeue(): undefined | T
Dequeue data from the fixed priority queue.
+
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
+
- Defined in src/fixed-priority-queue.ts:145

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

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

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: T
  Data to enqueue.
  -
- Optional priority: number
  Priority of the data. Lower values have higher priority.
  +
- Optionalpriority: number
  Priority 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:68

full

full(): boolean
Checks if the fixed priority queue is full.
+
Throws
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:57

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: number
  The 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:105

\ No newline at end of file +

Class FixedPriorityQueue<T>Internal

Class FixedPriorityQueue<T>Internal

Type Parameters

Hierarchy (view full)

Index

Constructors

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Constructors

constructor

Type Parameters

Parameters

Returns FixedPriorityQueue<T>

Default Value

Default Value

Properties

Readonly capacity

enablePriority

Private Readonly nodeArray

size

Private start

Methods

[iterator]

Default Value

Default Value

Properties

Readonlycapacity

enablePriority

size

Methods

[iterator]

Returns Iterator<T, any, undefined>

See

Private checkSize

Parameters

Returns void

clear

Returns void

dequeue

See

clear

Returns void

dequeue

Returns undefined | T

empty

empty

Returns boolean

enqueue

enqueue

Parameters

Returns number

Throws

full

Throws

full

Returns boolean

get

get

Parameters

Returns undefined | T

Settings

Member Visibility

Theme

On This Page

Settings

On This Page

Class FixedPriorityQueue<T>`Internal`

Class FixedPriorityQueue<T>`Internal`

`Readonly` capacity

`Private` `Readonly` nodeArray

`Private` start

`Readonly`capacity

`Private` checkSize