priority-queue-typed 2.5.1 → 2.5.3

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

@@ -33,9 +33,61 @@ var priorityQueueTyped = (() => {
     MinHeap: () => MinHeap,
     MinPriorityQueue: () => MinPriorityQueue,
     PriorityQueue: () => PriorityQueue,
-    Range: () => Range
+    Range: () => Range,
+    raise: () => raise
   });
 
+  // src/common/error.ts
+  function raise(ErrorClass, message) {
+    throw new ErrorClass(message);
+  }
+  var ERR = {
+    // Range / index
+    indexOutOfRange: (index, min, max, ctx) => `${ctx ? ctx + ": " : ""}Index ${index} is out of range [${min}, ${max}].`,
+    invalidIndex: (ctx) => `${ctx ? ctx + ": " : ""}Index must be an integer.`,
+    // Type / argument
+    invalidArgument: (reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`,
+    comparatorRequired: (ctx) => `${ctx ? ctx + ": " : ""}Comparator is required for non-number/non-string/non-Date keys.`,
+    invalidKey: (reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`,
+    notAFunction: (name, ctx) => `${ctx ? ctx + ": " : ""}${name} must be a function.`,
+    invalidEntry: (ctx) => `${ctx ? ctx + ": " : ""}Each entry must be a [key, value] tuple.`,
+    invalidNaN: (ctx) => `${ctx ? ctx + ": " : ""}NaN is not a valid key.`,
+    invalidDate: (ctx) => `${ctx ? ctx + ": " : ""}Invalid Date key.`,
+    reduceEmpty: (ctx) => `${ctx ? ctx + ": " : ""}Reduce of empty structure with no initial value.`,
+    callbackReturnType: (expected, got, ctx) => `${ctx ? ctx + ": " : ""}Callback must return ${expected}; got ${got}.`,
+    // State / operation
+    invalidOperation: (reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`,
+    // Matrix
+    matrixDimensionMismatch: (op) => `Matrix: Dimensions must be compatible for ${op}.`,
+    matrixSingular: () => "Matrix: Singular matrix, inverse does not exist.",
+    matrixNotSquare: () => "Matrix: Must be square for inversion.",
+    matrixNotRectangular: () => "Matrix: Must be rectangular for transposition.",
+    matrixRowMismatch: (expected, got) => `Matrix: Expected row length ${expected}, but got ${got}.`,
+    // Order statistic
+    orderStatisticNotEnabled: (method, ctx) => `${ctx ? ctx + ": " : ""}${method}() requires enableOrderStatistic: true.`
+  };
+
+  // src/common/index.ts
+  var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
+    DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
+    DFSOperation2[DFSOperation2["PROCESS"] = 1] = "PROCESS";
+    return DFSOperation2;
+  })(DFSOperation || {});
+  var Range = class {
+    constructor(low, high, includeLow = true, includeHigh = true) {
+      this.low = low;
+      this.high = high;
+      this.includeLow = includeLow;
+      this.includeHigh = includeHigh;
+    }
+    // Determine whether a key is within the range
+    isInRange(key, comparator) {
+      const lowCheck = this.includeLow ? comparator(key, this.low) >= 0 : comparator(key, this.low) > 0;
+      const highCheck = this.includeHigh ? comparator(key, this.high) <= 0 : comparator(key, this.high) < 0;
+      return lowCheck && highCheck;
+    }
+  };
+
   // src/data-structures/base/iterable-element-base.ts
   var IterableElementBase = class {
     /**
@@ -58,7 +110,7 @@ var priorityQueueTyped = (() => {
       if (options) {
         const { toElementFn } = options;
         if (typeof toElementFn === "function") this._toElementFn = toElementFn;
-        else if (toElementFn) throw new TypeError("toElementFn must be a function type");
+        else if (toElementFn) raise(TypeError, "toElementFn must be a function type");
       }
     }
     /**
@@ -214,7 +266,7 @@ var priorityQueueTyped = (() => {
         acc = initialValue;
       } else {
         const first = iter.next();
-        if (first.done) throw new TypeError("Reduce of empty structure with no initial value");
+        if (first.done) raise(TypeError, "Reduce of empty structure with no initial value");
         acc = first.value;
         index = 1;
       }
@@ -256,52 +308,6 @@ var priorityQueueTyped = (() => {
     }
   };
 
-  // src/common/error.ts
-  var ERR = {
-    // Range / index
-    indexOutOfRange: (index, min, max, ctx) => `${ctx ? ctx + ": " : ""}Index ${index} is out of range [${min}, ${max}].`,
-    invalidIndex: (ctx) => `${ctx ? ctx + ": " : ""}Index must be an integer.`,
-    // Type / argument
-    invalidArgument: (reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`,
-    comparatorRequired: (ctx) => `${ctx ? ctx + ": " : ""}Comparator is required for non-number/non-string/non-Date keys.`,
-    invalidKey: (reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`,
-    notAFunction: (name, ctx) => `${ctx ? ctx + ": " : ""}${name} must be a function.`,
-    invalidEntry: (ctx) => `${ctx ? ctx + ": " : ""}Each entry must be a [key, value] tuple.`,
-    invalidNaN: (ctx) => `${ctx ? ctx + ": " : ""}NaN is not a valid key.`,
-    invalidDate: (ctx) => `${ctx ? ctx + ": " : ""}Invalid Date key.`,
-    reduceEmpty: (ctx) => `${ctx ? ctx + ": " : ""}Reduce of empty structure with no initial value.`,
-    callbackReturnType: (expected, got, ctx) => `${ctx ? ctx + ": " : ""}Callback must return ${expected}; got ${got}.`,
-    // State / operation
-    invalidOperation: (reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`,
-    // Matrix
-    matrixDimensionMismatch: (op) => `Matrix: Dimensions must be compatible for ${op}.`,
-    matrixSingular: () => "Matrix: Singular matrix, inverse does not exist.",
-    matrixNotSquare: () => "Matrix: Must be square for inversion.",
-    matrixNotRectangular: () => "Matrix: Must be rectangular for transposition.",
-    matrixRowMismatch: (expected, got) => `Matrix: Expected row length ${expected}, but got ${got}.`
-  };
-
-  // src/common/index.ts
-  var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
-    DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
-    DFSOperation2[DFSOperation2["PROCESS"] = 1] = "PROCESS";
-    return DFSOperation2;
-  })(DFSOperation || {});
-  var Range = class {
-    constructor(low, high, includeLow = true, includeHigh = true) {
-      this.low = low;
-      this.high = high;
-      this.includeLow = includeLow;
-      this.includeHigh = includeHigh;
-    }
-    // Determine whether a key is within the range
-    isInRange(key, comparator) {
-      const lowCheck = this.includeLow ? comparator(key, this.low) >= 0 : comparator(key, this.low) > 0;
-      const highCheck = this.includeHigh ? comparator(key, this.high) <= 0 : comparator(key, this.high) < 0;
-      return lowCheck && highCheck;
-    }
-  };
-
   // src/data-structures/heap/heap.ts
   var Heap = class _Heap extends IterableElementBase {
     /**
@@ -317,7 +323,7 @@ var priorityQueueTyped = (() => {
       __publicField(this, "_elements", []);
       __publicField(this, "_DEFAULT_COMPARATOR", (a, b) => {
         if (typeof a === "object" || typeof b === "object") {
-          throw new TypeError(ERR.comparatorRequired("Heap"));
+          raise(TypeError, ERR.comparatorRequired("Heap"));
         }
         if (a > b) return 1;
         if (a < b) return -1;
@@ -366,6 +372,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -423,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.
       
@@ -450,6 +463,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -504,6 +524,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -561,6 +588,12 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -568,6 +601,34 @@ 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 {
@@ -595,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();
@@ -632,6 +701,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -729,6 +805,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -773,6 +856,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -790,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)
@@ -820,6 +900,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -864,6 +951,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -888,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 {
@@ -898,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)) {
@@ -914,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 {
@@ -954,6 +1054,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1031,6 +1138,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1081,6 +1195,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1130,6 +1251,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1186,6 +1314,13 @@ var priorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1202,7 +1337,7 @@ var priorityQueueTyped = (() => {
       */
     map(callback, options, thisArg) {
       const { comparator, toElementFn, ...rest } = options != null ? options : {};
-      if (!comparator) throw new TypeError(ERR.comparatorRequired("Heap.map"));
+      if (!comparator) raise(TypeError, ERR.comparatorRequired("Heap.map"));
       const out = this._createLike([], { ...rest, comparator, toElementFn });
       let i = 0;
       for (const x of this) {
@@ -1330,7 +1465,7 @@ var priorityQueueTyped = (() => {
       __publicField(this, "_comparator");
       this.clear();
       this._comparator = comparator || this._defaultComparator;
-      if (typeof this.comparator !== "function") throw new TypeError(ERR.notAFunction("comparator", "FibonacciHeap"));
+      if (typeof this.comparator !== "function") raise(TypeError, ERR.notAFunction("comparator", "FibonacciHeap"));
     }
     /**
      * Get the circular root list head.
@@ -1367,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);
@@ -1376,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;
@@ -1539,7 +1674,7 @@ var priorityQueueTyped = (() => {
       super(elements, {
         comparator: (a, b) => {
           if (typeof a === "object" || typeof b === "object") {
-            throw new TypeError(ERR.comparatorRequired("MaxHeap"));
+            raise(TypeError, ERR.comparatorRequired("MaxHeap"));
           }
           if (a < b) return 1;
           if (a > b) return -1;
@@ -1595,7 +1730,7 @@ var priorityQueueTyped = (() => {
       super(elements, {
         comparator: (a, b) => {
           if (typeof a === "object" || typeof b === "object") {
-            throw new TypeError(ERR.comparatorRequired("MaxPriorityQueue"));
+            raise(TypeError, ERR.comparatorRequired("MaxPriorityQueue"));
           }
           if (a < b) return 1;
           if (a > b) return -1;