X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPriorityQueue.html;h=a74d4c91691820031346abc162f59542bcde7840;hb=0aa00166eaa9a8c9b505b4fa7fd5dc50d831b7ef;hp=0b11d2e35af2f9a276ed15e9769d04a78c8a691f;hpb=c5d5cc086c12de1bc8ceb7f6bcda6b8e283ab405;p=poolifier.git diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index 0b11d2e3..a74d4c91 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,46 +1,38 @@ -
Internal
Priority queue.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.15Class PriorityQueue<T>
Internal
Priority queue.
Type Parameters
Type of priority queue data.
-Index
Constructors
Properties
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Constructs a priority queue.
-Type Parameters
Parameters
Prioritized bucket size.
-Returns PriorityQueue<T>
Default Value
-Properties
Private
Readonly
kPrioritized bucket size.
-max Size
The maximum size of the priority queue.
-Private
nodesize
The size of the priority queue.
-Accessors
buckets
The number of filled prioritized buckets.
-Returns number
Methods
[iterator]
Returns an iterator for the priority queue.
+Constructors
constructor
Constructs a priority queue.
+Type Parameters
Parameters
Prioritized bucket size.
+Whether to enable priority.
+Returns PriorityQueue<T>
PriorityQueue.
+Default Value
+ +Default Value
+ +Properties
max Size
The priority queue maximum size.
+Accessors
buckets
The number of filled prioritized buckets.
+Returns number
The number of filled prioritized buckets.
+enable Priority
Returns boolean
Parameters
Returns void
size
The priority queue size.
+Returns number
The priority queue size.
+Methods
[iterator]
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
-clear
Clears the priority queue.
-Returns void
Private
decrementDecrements the size of the priority queue.
-Returns number
The new size of the priority queue.
-dequeue
Dequeue data from the priority queue.
-Parameters
The prioritized bucket to dequeue from.
+See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
+clear
Clears the priority queue.
+Returns void
dequeue
Dequeue data from the priority queue.
+Parameters
Optional
bucket: numberThe prioritized bucket to dequeue from.
Returns undefined | T
The dequeued data or
-undefined
if the priority queue is empty.Default Value
-enqueue
Enqueue data into the priority queue.
+enqueue
Enqueue data into the priority queue.
Parameters
Data to enqueue.
-Optional
priority: numberPriority of the data. Lower values have higher priority.
+Optional
priority: numberPriority of the data. Lower values have higher priority.
Returns number
The new size of the priority queue.
-Private
incrementIncrements the size of the priority queue.
-Returns number
The new size of the priority queue.
-peek First
Peeks at the first data.
-Returns undefined | T
The first data or
-undefined
if the priority queue is empty.peek Last
Peeks at the last data.
-Returns undefined | T
The last data or
-undefined
if the priority queue is empty.Settings
Member Visibility
Theme
On This Page
Settings
On This Page
Constructors
Properties
Accessors
Methods