priority-queue-typed 2.5.2 → 2.5.3

package/dist/umd/priority-queue-typed.js

@@ -378,6 +378,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -432,7 +436,7 @@ var priorityQueueTyped = (() => {
     }
     /**
       * Insert an element.
-      * @remarks Time O(1) amortized, Space O(1)
+      * @remarks Time O(log N) amortized, Space O(1)
       * @param element - Element to insert.
       * @returns True.
       
@@ -465,6 +469,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -522,6 +530,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -582,10 +594,41 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
       
       
       
       
+       * @example
+    * // Heap with custom comparator (MaxHeap behavior)
+    *  interface Task {
+    *       id: number;
+    *       priority: number;
+    *       name: string;
+    *     }
+    *
+    *     // Custom comparator for max heap behavior (higher priority first)
+    *     const tasks: Task[] = [
+    *       { id: 1, priority: 5, name: 'Email' },
+    *       { id: 2, priority: 3, name: 'Chat' },
+    *       { id: 3, priority: 8, name: 'Alert' }
+    *     ];
+    *
+    *     const maxHeap = new Heap(tasks, {
+    *       comparator: (a: Task, b: Task) => b.priority - a.priority
+    *     });
+    *
+    *     console.log(maxHeap.size); // 3;
+    *
+    *     // Peek returns highest priority task
+    *     const topTask = maxHeap.peek();
+    *     console.log(topTask?.priority); // 8;
+    *     console.log(topTask?.name); // 'Alert';
+      */
+    /**
+      * @deprecated Use `pop` instead. Will be removed in a future major version.
        * @example
     * // Heap with custom comparator (MaxHeap behavior)
     *  interface Task {
@@ -613,6 +656,14 @@ var priorityQueueTyped = (() => {
     *     console.log(topTask?.name); // 'Alert';
       */
     poll() {
+      return this.pop();
+    }
+    /**
+     * Remove and return the top element (min or max depending on comparator).
+     * @remarks Time O(log N) amortized, Space O(1)
+     * @returns The removed top element, or undefined if empty.
+     */
+    pop() {
       if (this.elements.length === 0) return;
       const value = this.elements[0];
       const last = this.elements.pop();
@@ -656,6 +707,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -756,6 +811,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -803,6 +862,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -817,16 +880,6 @@ var priorityQueueTyped = (() => {
     clear() {
       this._elements = [];
     }
-    /**
-     * Replace the backing array and rebuild the heap.
-     * @remarks Time O(N), Space O(N)
-     * @param elements - Iterable used to refill the heap.
-     * @returns Array of per-node results from fixing steps.
-     */
-    refill(elements) {
-      this._elements = Array.from(elements);
-      return this.fix();
-    }
     /**
       * Check if an equal element exists in the heap.
       * @remarks Time O(N), Space O(1)
@@ -853,6 +906,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -900,6 +957,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -921,7 +982,7 @@ var priorityQueueTyped = (() => {
       }
       if (index < 0) return false;
       if (index === 0) {
-        this.poll();
+        this.pop();
       } else if (index === this.elements.length - 1) {
         this.elements.pop();
       } else {
@@ -931,13 +992,19 @@ var priorityQueueTyped = (() => {
       }
       return true;
     }
+    /**
+     * @deprecated Use `deleteWhere` instead. Will be removed in a future major version.
+     */
+    deleteBy(predicate) {
+      return this.deleteWhere(predicate);
+    }
     /**
      * Delete the first element that matches a predicate.
      * @remarks Time O(N), Space O(1)
      * @param predicate - Function (element, index, heap) → boolean.
      * @returns True if an element was removed.
      */
-    deleteBy(predicate) {
+    deleteWhere(predicate) {
       let idx = -1;
       for (let i = 0; i < this.elements.length; i++) {
         if (predicate(this.elements[i], i, this)) {
@@ -947,7 +1014,7 @@ var priorityQueueTyped = (() => {
       }
       if (idx < 0) return false;
       if (idx === 0) {
-        this.poll();
+        this.pop();
       } else if (idx === this.elements.length - 1) {
         this.elements.pop();
       } else {
@@ -993,6 +1060,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -1073,6 +1144,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -1126,6 +1201,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -1178,6 +1257,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -1237,6 +1320,10 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
       
       
       
@@ -1415,7 +1502,7 @@ var priorityQueueTyped = (() => {
      * Push an element into the root list.
      * @remarks Time O(1) amortized, Space O(1)
      * @param element - Element to insert.
-     * @returns This heap.
+     * @returns True when the element is added.
      */
     push(element) {
       const node = this.createNode(element);
@@ -1424,7 +1511,7 @@ var priorityQueueTyped = (() => {
       this.mergeWithRoot(node);
       if (!this.min || this.comparator(node.element, this.min.element) <= 0) this._min = node;
       this._size++;
-      return this;
+      return true;
     }
     peek() {
       return this.min ? this.min.element : void 0;