X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPriorityQueueNode.html;h=383789f39e2da4fbc4192a943b9a80e8b40788c1;hb=refs%2Fheads%2Fmaster;hp=4044e26e8652545019920033c2886d1d35b435d6;hpb=4ac8e928fb5e8ea7423f03a02edde998e1320921;p=poolifier.git diff --git a/docs/interfaces/PriorityQueueNode.html b/docs/interfaces/PriorityQueueNode.html deleted file mode 100644 index 4044e26e..00000000 --- a/docs/interfaces/PriorityQueueNode.html +++ /dev/null @@ -1,35 +0,0 @@ -PriorityQueueNode | poolifier - v4.0.14

Interface PriorityQueueNode<T>Internal

Priority queue node.

-
interface PriorityQueueNode<T> {
    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

  • T

    Type of priority queue node data.

    -

Hierarchy (view full)

Properties

capacity -enablePriority -next? -size -

Methods

[iterator] -clear -dequeue -empty -enqueue -full -get -

Properties

Readonly capacity

capacity: number

The fixed priority queue capacity.

-

enablePriority

enablePriority: boolean

Whether to enable priority.

-

Optional next

next?: FixedPriorityQueue<T>

size

size: number

The fixed priority queue size.

-

Methods

[iterator]

clear

dequeue

empty

enqueue

  • enqueue(data, priority?): number

  • Enqueue data into the fixed 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.

    -

    Throws

    If the fixed priority queue is full.

    -

full

get

  • get(index): undefined | T

  • Gets data from the fixed priority queue.

    -

    Parameters

    • index: number

      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

capacityenablePrioritynextsize[iterator]cleardequeueemptyenqueuefullget
\ No newline at end of file