X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fclasses%2FFixedPriorityQueue.html;h=436a8013876e5923007e87b5a0d1babae1a04f58;hb=8b7aa4204c27efd1dc699f7baea65b5262bd26b3;hp=12964b7d08ed41310ac2bd742855058c8af63623;hpb=fcb83cac5406186d9646362d0f3f97db339012d9;p=poolifier.git diff --git a/docs/classes/FixedPriorityQueue.html b/docs/classes/FixedPriorityQueue.html index 12964b7d..436a8013 100644 --- a/docs/classes/FixedPriorityQueue.html +++ b/docs/classes/FixedPriorityQueue.html @@ -1,48 +1,45 @@ -
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
Methods
Constructors
constructor
Constructs a fixed priority queue.
+Constructors
constructor
Constructs a fixed priority queue.
Type Parameters
Parameters
Fixed priority queue size.
Whether to enable priority.
Returns FixedPriorityQueue<T>
FixedPriorityQueue.
-Default Value
-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.
+Default Value
+ +Default Value
+ +Properties
Readonly
capacityThe fixed priority queue capacity.
+enable Priority
Whether to enable priority.
+size
The fixed priority queue size.
+Methods
[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.
-Parameters
Queue size.
-Returns void
clear
Clears the fixed priority queue.
-Returns void
dequeue
Dequeue data from the fixed priority queue.
+See
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
+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.
+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.
+Throws
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
On This Page
Constructors
Properties
Methods