ixfx
    Preparing search index...

    Class PriorityMutable<V>

    Simple priority queue implementation. Higher numbers mean higher priority.

    const pm = new PriorityMutable();

    // Add items with a priority (higher numeric value = higher value)
    pm.enqueueWithPriority(`hello`, 4);
    pm.enqueueWithPriotity(`there`, 1);

    Type Parameters

    • V

    Hierarchy (View Summary)

    Implements

    Constructors

    constructor

    Properties

    data eq options

    Accessors

    isDisposed isEmpty isFull length peek

    Methods

    addEventListener at changePriority clear dequeue dequeueMax dequeueMin dispose enqueue enqueueWithPriority fireEvent onClear onEnqueue onRemoved peekMax peekMin removeEventListener removeWhere toArray

    Constructors

    constructor

    Properties

    data

    data: readonly Readonly<{ item: V; priority: number }>[]

    eq

    eq: IsEqual<Readonly<{ item: V; priority: number }>>

    Readonlyoptions

    options: QueueOpts<Readonly<{ item: V; priority: number }>>

    Accessors

    isDisposed

    • get isDisposed(): boolean

      Returns boolean

    isEmpty

    • get isEmpty(): boolean

      Returns true if queue is empty

      Returns boolean

    isFull

    • get isFull(): boolean

      Is queue full? Returns false if no capacity has been set

      Returns boolean

    length

    • get length(): number

      Number of items in queue

      Returns number

    peek

    • get peek(): undefined | V

      Returns front of queue (oldest item), or undefined if queue is empty

      Returns undefined | V

    Methods

    addEventListener

    at

    • at(index: number): Readonly

      Returns the item at given rank (0 being front of queue)

      Parameters

      • index: number

      Returns Readonly

    changePriority

    • changePriority(
          item: V,
          priority: number,
          addIfMissing?: boolean,
          eq?: IsEqual<V>,
      ): void

      Parameters

      • item: V
      • priority: number
      • addIfMissing: boolean = false
      • Optionaleq: IsEqual<V>

      Returns void

    clear

    dequeue

    • dequeue(): undefined | Readonly<{ item: V; priority: number }>

      Dequeues (removes oldest item / item at front of queue)

      Use peek to look at the item at front of queue without removing it.

      Returns undefined | Readonly<{ item: V; priority: number }>

      Item, or undefined if queue is empty

    dequeueMax

    dequeueMin

    dispose

    enqueue

    • enqueue(...toAdd: readonly Readonly<{ item: V; priority: number }>[]): number

      Enqueues (adds items to back of queue). If a capacity is set, not all items might be added.

      Parameters

      • ...toAdd: readonly Readonly<{ item: V; priority: number }>[]

      Returns number

      How many items were added

    enqueueWithPriority

    • enqueueWithPriority(item: V, priority: number): void

      Adds an item with a given priority

      Parameters

      • item: V

        Item

      • priority: number

        Priority (higher numeric value means higher priority)

      Returns void

    ProtectedfireEvent

    ProtectedonClear

    ProtectedonEnqueue

    • onEnqueue(
          result: readonly Readonly<{ item: V; priority: number }>[],
          attemptedToAdd: readonly Readonly<{ item: V; priority: number }>[],
      ): void

      Parameters

      • result: readonly Readonly<{ item: V; priority: number }>[]
      • attemptedToAdd: readonly Readonly<{ item: V; priority: number }>[]

      Returns void

    ProtectedonRemoved

    • onRemoved(
          removed: readonly Readonly<{ item: V; priority: number }>[],
          finalData: readonly Readonly<{ item: V; priority: number }>[],
      ): void

      Parameters

      • removed: readonly Readonly<{ item: V; priority: number }>[]
      • finalData: readonly Readonly<{ item: V; priority: number }>[]

      Returns void

    peekMax

    • peekMax(): undefined | V

      Peeks at the item with highest priority without removing it. undefined if queue is empty.

      Returns undefined | V

    peekMin

    • peekMin(): undefined | V

      Peeks at the item with the lowest priority without removing it. undefined if queue is empty.

      Returns undefined | V

    removeEventListener

    removeWhere

    • removeWhere(predicate: (item: Readonly) => boolean): number

      Removes values that match predicate.

      Parameters

      • predicate: (item: Readonly) => boolean

      Returns number

      Returns number of items removed.

    toArray

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods