max-priority-queue-typed 2.5.2 → 2.5.3

package/dist/esm/index.mjs

@@ -343,6 +343,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -396,7 +400,7 @@ var Heap = class _Heap extends IterableElementBase {
   }
   /**
     * 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.
     
@@ -429,6 +433,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -486,6 +494,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -546,10 +558,41 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
     
     
     
     
+     * @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 {
@@ -577,6 +620,14 @@ var Heap = class _Heap extends IterableElementBase {
   *     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();
@@ -620,6 +671,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -720,6 +775,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -767,6 +826,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -781,16 +844,6 @@ var Heap = class _Heap extends IterableElementBase {
   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)
@@ -817,6 +870,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -864,6 +921,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -885,7 +946,7 @@ var Heap = class _Heap extends IterableElementBase {
     }
     if (index < 0) return false;
     if (index === 0) {
-      this.poll();
+      this.pop();
     } else if (index === this.elements.length - 1) {
       this.elements.pop();
     } else {
@@ -895,13 +956,19 @@ var Heap = class _Heap extends IterableElementBase {
     }
     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)) {
@@ -911,7 +978,7 @@ var Heap = class _Heap extends IterableElementBase {
     }
     if (idx < 0) return false;
     if (idx === 0) {
-      this.poll();
+      this.pop();
     } else if (idx === this.elements.length - 1) {
       this.elements.pop();
     } else {
@@ -957,6 +1024,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -1037,6 +1108,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -1090,6 +1165,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -1142,6 +1221,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -1201,6 +1284,10 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
     
     
     
@@ -1394,7 +1481,7 @@ var FibonacciHeap = class {
    * 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);
@@ -1403,7 +1490,7 @@ var FibonacciHeap = class {
     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;