data-structure-typed 2.5.1 → 2.5.3

package/dist/cjs/heap.cjs

@@ -3,6 +3,37 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
+// src/common/error.ts
+function raise(ErrorClass, message) {
+  throw new ErrorClass(message);
+}
+__name(raise, "raise");
+var ERR = {
+  // Range / index
+  indexOutOfRange: /* @__PURE__ */ __name((index, min, max, ctx) => `${ctx ? ctx + ": " : ""}Index ${index} is out of range [${min}, ${max}].`, "indexOutOfRange"),
+  invalidIndex: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Index must be an integer.`, "invalidIndex"),
+  // Type / argument
+  invalidArgument: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidArgument"),
+  comparatorRequired: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Comparator is required for non-number/non-string/non-Date keys.`, "comparatorRequired"),
+  invalidKey: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidKey"),
+  notAFunction: /* @__PURE__ */ __name((name, ctx) => `${ctx ? ctx + ": " : ""}${name} must be a function.`, "notAFunction"),
+  invalidEntry: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Each entry must be a [key, value] tuple.`, "invalidEntry"),
+  invalidNaN: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}NaN is not a valid key.`, "invalidNaN"),
+  invalidDate: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Invalid Date key.`, "invalidDate"),
+  reduceEmpty: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Reduce of empty structure with no initial value.`, "reduceEmpty"),
+  callbackReturnType: /* @__PURE__ */ __name((expected, got, ctx) => `${ctx ? ctx + ": " : ""}Callback must return ${expected}; got ${got}.`, "callbackReturnType"),
+  // State / operation
+  invalidOperation: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidOperation"),
+  // Matrix
+  matrixDimensionMismatch: /* @__PURE__ */ __name((op) => `Matrix: Dimensions must be compatible for ${op}.`, "matrixDimensionMismatch"),
+  matrixSingular: /* @__PURE__ */ __name(() => "Matrix: Singular matrix, inverse does not exist.", "matrixSingular"),
+  matrixNotSquare: /* @__PURE__ */ __name(() => "Matrix: Must be square for inversion.", "matrixNotSquare"),
+  matrixNotRectangular: /* @__PURE__ */ __name(() => "Matrix: Must be rectangular for transposition.", "matrixNotRectangular"),
+  matrixRowMismatch: /* @__PURE__ */ __name((expected, got) => `Matrix: Expected row length ${expected}, but got ${got}.`, "matrixRowMismatch"),
+  // Order statistic
+  orderStatisticNotEnabled: /* @__PURE__ */ __name((method, ctx) => `${ctx ? ctx + ": " : ""}${method}() requires enableOrderStatistic: true.`, "orderStatisticNotEnabled")
+};
+
 // src/data-structures/base/iterable-element-base.ts
 var IterableElementBase = class {
   static {
@@ -21,7 +52,7 @@ var IterableElementBase = class {
     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");
     }
   }
   /**
@@ -184,7 +215,7 @@ var IterableElementBase = class {
       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;
     }
@@ -226,31 +257,6 @@ var IterableElementBase = class {
   }
 };
 
-// src/common/error.ts
-var ERR = {
-  // Range / index
-  indexOutOfRange: /* @__PURE__ */ __name((index, min, max, ctx) => `${ctx ? ctx + ": " : ""}Index ${index} is out of range [${min}, ${max}].`, "indexOutOfRange"),
-  invalidIndex: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Index must be an integer.`, "invalidIndex"),
-  // Type / argument
-  invalidArgument: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidArgument"),
-  comparatorRequired: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Comparator is required for non-number/non-string/non-Date keys.`, "comparatorRequired"),
-  invalidKey: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidKey"),
-  notAFunction: /* @__PURE__ */ __name((name, ctx) => `${ctx ? ctx + ": " : ""}${name} must be a function.`, "notAFunction"),
-  invalidEntry: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Each entry must be a [key, value] tuple.`, "invalidEntry"),
-  invalidNaN: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}NaN is not a valid key.`, "invalidNaN"),
-  invalidDate: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Invalid Date key.`, "invalidDate"),
-  reduceEmpty: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Reduce of empty structure with no initial value.`, "reduceEmpty"),
-  callbackReturnType: /* @__PURE__ */ __name((expected, got, ctx) => `${ctx ? ctx + ": " : ""}Callback must return ${expected}; got ${got}.`, "callbackReturnType"),
-  // State / operation
-  invalidOperation: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidOperation"),
-  // Matrix
-  matrixDimensionMismatch: /* @__PURE__ */ __name((op) => `Matrix: Dimensions must be compatible for ${op}.`, "matrixDimensionMismatch"),
-  matrixSingular: /* @__PURE__ */ __name(() => "Matrix: Singular matrix, inverse does not exist.", "matrixSingular"),
-  matrixNotSquare: /* @__PURE__ */ __name(() => "Matrix: Must be square for inversion.", "matrixNotSquare"),
-  matrixNotRectangular: /* @__PURE__ */ __name(() => "Matrix: Must be rectangular for transposition.", "matrixNotRectangular"),
-  matrixRowMismatch: /* @__PURE__ */ __name((expected, got) => `Matrix: Expected row length ${expected}, but got ${got}.`, "matrixRowMismatch")
-};
-
 // src/data-structures/heap/heap.ts
 var Heap = class _Heap extends IterableElementBase {
   static {
@@ -307,6 +313,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -364,7 +378,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.
     
@@ -389,6 +403,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -442,6 +464,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -498,6 +528,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -506,6 +543,34 @@ 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 {
@@ -533,6 +598,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();
@@ -568,6 +641,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -664,6 +745,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -707,6 +796,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -725,16 +822,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)
@@ -753,6 +840,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -796,6 +891,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -821,7 +924,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 {
@@ -831,13 +934,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)) {
@@ -847,7 +956,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 {
@@ -885,6 +994,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -961,6 +1078,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1010,6 +1135,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1058,6 +1191,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1113,6 +1254,14 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1130,7 +1279,7 @@ var Heap = class _Heap extends IterableElementBase {
     */
   map(callback, options, thisArg) {
     const { comparator, toElementFn, ...rest } = 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) {
@@ -1157,7 +1306,7 @@ var Heap = class _Heap extends IterableElementBase {
   }
   _DEFAULT_COMPARATOR = /* @__PURE__ */ __name((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;
@@ -1269,7 +1418,7 @@ var FibonacciHeap = class {
   constructor(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"));
   }
   _root;
   /**
@@ -1310,7 +1459,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);
@@ -1319,7 +1468,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;
@@ -1485,7 +1634,7 @@ var MaxHeap = class extends Heap {
     super(elements, {
       comparator: /* @__PURE__ */ __name((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;