X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FFixedPriorityQueue.html;h=fa6e3ef25c4b7ae080312c93c22c9bd571cbfc54;hb=239d22372bddd21106b22361038be2f3aae6e5de;hp=bad5abd99a8659ed898c4a0f8ad870d1c38d9481;hpb=6a677734f19a229fe6a863acd0e6aa0b0d762d6f;p=poolifier.git diff --git a/docs/classes/FixedPriorityQueue.html b/docs/classes/FixedPriorityQueue.html index bad5abd9..fa6e3ef2 100644 --- a/docs/classes/FixedPriorityQueue.html +++ b/docs/classes/FixedPriorityQueue.html @@ -1,6 +1,6 @@ -
Internal
Fixed priority queue.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.15Class FixedPriorityQueue<T>
Internal
Fixed priority queue.
Type Parameters
Type of fixed priority queue data.
-Hierarchy (view full)
Index
Constructors
Hierarchy (view full)
Index
Constructors
Properties
Default Value
-Properties
Readonly
capacityThe fixed priority queue capacity.
-enable Priority
Whether to enable priority.
-Private
Readonly
nodesize
The fixed priority queue size.
-Private
startMethods
[iterator]
Returns an iterator for the fixed priority queue.
+Properties
Readonly
capacityThe fixed priority queue capacity.
+enable Priority
Whether to enable priority.
+Private
Readonly
nodesize
The fixed priority queue size.
+Private
startMethods
[iterator]
Returns an iterator for the fixed priority queue.
Returns Iterator<T, any, undefined>
An iterator for the fixed priority queue.
See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
-Private
checkChecks the queue size.
+Private
checkChecks the queue size.
Parameters
Queue size.
-Returns void
clear
Clears the fixed priority queue.
-Returns void
dequeue
Dequeue data from the fixed priority queue.
+Returns void
clear
Clears the fixed priority queue.
+Returns void
dequeue
Dequeue data from the fixed priority queue.
Returns undefined | T
The dequeued data or
-undefined
if the priority queue is empty.empty
Checks if the fixed priority queue is empty.
+empty
Checks if the fixed priority queue is empty.
Returns boolean
-true
if the fixed priority queue is empty,false
otherwise.enqueue
Enqueue data into the fixed priority queue.
+enqueue
Enqueue data into the fixed 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.
Throws
If the fixed priority queue is full.
-full
Checks if the fixed priority queue is full.
+full
Checks if the fixed priority queue is full.
Returns boolean
-true
if the fixed priority queue is full,false
otherwise.get
Gets data from the fixed priority queue.
+get
Gets data from the fixed priority queue.
Parameters
The index of the data to get.
Returns undefined | T
The data at the index or
-undefined
if the fixed priority queue is empty or the index is out of bounds.Settings
Member Visibility
Theme
On This Page
Settings
Member Visibility
Theme
On This Page