X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPriorityQueueNode.html;h=1fd3b7d3ad757910797663b7d48dcf65a14bca8a;hb=862503b9f2480d51bf3a666fc4d1d2a9b3c06b33;hp=4044e26e8652545019920033c2886d1d35b435d6;hpb=6a677734f19a229fe6a863acd0e6aa0b0d762d6f;p=poolifier.git diff --git a/docs/interfaces/PriorityQueueNode.html b/docs/interfaces/PriorityQueueNode.html index 4044e26e..1fd3b7d3 100644 --- a/docs/interfaces/PriorityQueueNode.html +++ b/docs/interfaces/PriorityQueueNode.html @@ -1,6 +1,6 @@ -
Internal
Priority queue node.
+- Preparing search index...
- The search index is not available
poolifier - v4.0.15Interface PriorityQueueNode<T>
Internal
Priority queue node.
    capacity: number;
    enablePriority: boolean;
    next?: FixedPriorityQueue<T>;
    size: number;
    [iterator](): Iterator<T, any, undefined>;
    clear(): void;
    dequeue(): undefined | T;
    empty(): boolean;
    enqueue(data, priority?): number;
    full(): boolean;
    get(index): undefined | T;
}
Type Parameters
Type of priority queue node data.
-Hierarchy (view full)
Index
Properties
Hierarchy (view full)
Index
Properties
Properties
Readonly
capacityThe fixed priority queue capacity.
-enable Priority
Whether to enable priority.
-Optional
nextsize
The fixed priority queue size.
-Methods
[iterator]
Returns an iterator for the fixed priority queue.
+enable Priority
Whether to enable priority.
+Optional
nextsize
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
-clear
Clears the fixed priority queue.
-Returns void
dequeue
Dequeue data from the fixed priority queue.
+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