X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPriorityQueue.html;h=a74d4c91691820031346abc162f59542bcde7840;hb=0aa00166eaa9a8c9b505b4fa7fd5dc50d831b7ef;hp=707904d96d1e5274b4ecb4d1fe3e13bd63fdf6f9;hpb=f30cddb8f07ac919d75140469faab6e0883709da;p=poolifier.git diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index 707904d9..a74d4c91 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,43 +1,38 @@ -PriorityQueue | poolifier - v4.0.3

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

k -maxSize -nodeArray -size +

Index

Constructors

Properties

Accessors

buckets +enablePriority +size

Methods

[iterator] clear dequeue enqueue -incrementSize -peekFirst -peekLast -

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

Properties

`Private` `Readonly` k

k: number

Prioritized bucket size.

-

maxSize

maxSize: number

The maximum size of the priority queue.

-

`Private` nodeArray

nodeArray: PriorityQueueNode<T>[]

size

size: number

The size of the priority queue.

-

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.
+

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

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.
+
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:131

clear

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

dequeue

dequeue(bucket?): undefined | T
Dequeue data from the priority queue.
-
Parameters
- bucket: number = 0
  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.
-
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: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: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:156

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

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

\ No newline at end of file +

\ No newline at end of file