X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPriorityQueue.html;h=ec17f3586f41a6649b27b0a49e52afe54cf0b095;hb=05a852b826fb54cbab49a196bbd0d123c3d0c367;hp=bb387b277cf40b8b623bac7b091f7b5cbce349c0;hpb=85de1563849907302a372b5da416e5cb15c23307;p=poolifier.git diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index bb387b27..ec17f358 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,41 +1,46 @@ -PriorityQueue | poolifier - v4.0.2

Class PriorityQueue<T>`Internal`

Priority queue.

+PriorityQueue | poolifier - v4.0.10

Class PriorityQueue<T>`Internal`

Priority queue.

Type Parameters

T
Type of priority queue data.
-

Index

Constructors

Properties

k +

Index

Constructors

Properties

bucketSize maxSize nodeArray size +

Accessors

Methods

[iterator] clear +decrementSize 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.
  +

Constructors

constructor

new PriorityQueue<T>(bucketSize?): PriorityQueue<T>
Constructs a priority queue.
+
Type Parameters
- T
Parameters
- bucketSize: number = Infinity
  Prioritized bucket size.
Returns PriorityQueue<T>
Default Value
```
Infinity
 
```
-
- Defined in src/priority-queue.ts:34

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.

-

Methods

[iterator]

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

Properties

`Private` `Readonly` bucketSize

bucketSize: 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.

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

clear

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

dequeue

dequeue(bucket?): undefined | T
Dequeue data from the priority queue.
+
- Defined in src/priority-queue.ts:132

clear

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

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

dequeue

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

enqueue

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

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.
Returns number
The new size of the priority queue.
-
- Defined in src/priority-queue.ts:52

`Private` incrementSize

incrementSize(): number
Increments the size of the priority queue.
+
- Defined in src/priority-queue.ts:61

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

peekFirst

peekFirst(): undefined | T
Peeks at the first data.
+
- Defined in src/priority-queue.ts:157

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

peekLast

peekLast(): undefined | T
Peeks at the last data.
+
- Defined in src/priority-queue.ts:105

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

\ No newline at end of file +

\ No newline at end of file