X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPriorityQueue.html;h=a74d4c91691820031346abc162f59542bcde7840;hb=224d008191f52fa20b93e1ba67919569f8d6e315;hp=eef1b25020c8aa2c05165d63f3275e248f9a998f;hpb=dea42379cfdbcf1c1c9800df7c097eab484ebc07;p=poolifier.git diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index eef1b250..a74d4c91 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,10 +1,7 @@ -PriorityQueue | poolifier - v4.0.15

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

Properties

bucketSize -head -maxSize -tail +

Index

Constructors

Properties

Accessors

buckets enablePriority size @@ -12,28 +9,30 @@ clear dequeue enqueue -

Constructors

constructor

new PriorityQueue<T>(bucketSize?, enablePriority?): PriorityQueue<T>
Constructs a priority queue.
+

Constructors

constructor

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

Properties

`Private` `Readonly` bucketSize

bucketSize: number

`Private` head

head: PriorityQueueNode<T>

maxSize

maxSize: number

The priority queue maximum size.

-

`Private` tail

tail: PriorityQueueNode<T>

Accessors

buckets

get buckets(): number
The number of filled prioritized buckets.
+
Default Value
```
defaultBucketSize
+
```
+ +
Default Value
```
false
+
```
+ +
- Defined in src/priority-queue.ts:37

Properties

maxSize

maxSize: number

The priority queue maximum size.

+

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.
+
- 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.
+
- 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: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: number
  The prioritized bucket to dequeue from.
  +
  See
  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
  +
  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
- Optionalbucket: number
  The 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:120

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: 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.
-
- Defined in src/priority-queue.ts:100

\ No newline at end of file +

\ No newline at end of file