X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPriorityQueue.html;h=8079f1f0763dd8a3c6f035196dc1ac44f19a526e;hb=388a5bee28fb64a2743d65189afd0a6e63314819;hp=caeb9a8772d7de76ed7a6448c91a932ae3bf6952;hpb=38e6b85b3247f847b61f30efc37851489f106e8a;p=poolifier.git diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index caeb9a87..8079f1f0 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,43 +1,37 @@ -
Internal
Priority queue.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.13Class 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
Constructors
constructor
Constructs a priority queue.
+Type Parameters
Parameters
Prioritized bucket size.
+Whether to enable priority.
+Returns PriorityQueue<T>
PriorityQueue.
+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.
+Default Value
+Properties
Private
Readonly
bucketPrivate
headmax Size
The priority queue maximum size.
+Private
tailAccessors
buckets
The number of filled prioritized buckets.
+Returns number
enable Priority
Returns boolean
Parameters
Returns void
size
The priority queue size.
+Returns number
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
dequeue
Dequeue data from the priority queue.
-Parameters
The prioritized bucket to dequeue from.
+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.
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
Member Visibility
Theme
On This Page