X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fclasses%2FPriorityQueue.html;h=ff3fc09e9c749e6751d23855585a8df37a0ba43a;hb=6c2aa71d06cfeccb07a325f7d9bc5ecdbb42a11f;hp=3064f2ccf1b5f8227daec8abce8cd1482d28f212;hpb=2493c34370d0839614058bb55254fd7aec91b664;p=poolifier.git diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index 3064f2cc..ff3fc09e 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,6 +1,6 @@ -PriorityQueue | poolifier - v4.0.11

Class PriorityQueue<T>Internal

Priority queue.

+PriorityQueue | poolifier - v4.0.12

Class PriorityQueue<T>Internal

Priority queue.

Type Parameters

  • T

    Type of priority queue data.

    -

Constructors

Constructors

Properties

bucketSize maxSize nodeArray @@ -18,29 +18,29 @@

Type Parameters

  • T

Parameters

  • bucketSize: number = Number.POSITIVE_INFINITY

    Prioritized bucket size.

Returns PriorityQueue<T>

Default Value

Number.POSITIVE_INFINITY
 
-

Properties

bucketSize: number

Prioritized bucket size.

-
maxSize: number

The maximum size of the priority queue.

-
nodeArray: PriorityQueueNode<T>[]
size: number

The size of the priority queue.

-

Accessors

Methods

Properties

bucketSize: number

Prioritized bucket size.

+
maxSize: number

The maximum size of the priority queue.

+
nodeArray: PriorityQueueNode<T>[]
size: number

The size of the priority queue.

+

Accessors

Methods

  • Decrements the size of the priority queue.

    Returns number

    The new size of the priority queue.

    -
  • Dequeue data from the priority queue.

    Parameters

    • bucket: number = 0

      The prioritized bucket to dequeue from.

    Returns undefined | T

    The dequeued data or undefined if the priority queue is empty.

    Default Value

    0
     
    -
  • Enqueue data into the priority queue.

    Parameters

    • data: T

      Data to enqueue.

    • Optional priority: number

      Priority of the data. Lower values have higher priority.

    Returns number

    The new size of the priority queue.

    -
  • Increments the size of the priority queue.

    Returns number

    The new size of the priority queue.

    -
  • Peeks at the first data.

    Returns undefined | T

    The first data or undefined if the priority queue is empty.

    -
  • Peeks at the last data.

    Returns undefined | T

    The last data or undefined if the priority queue is empty.

    -
\ No newline at end of file +
\ No newline at end of file