max-priority-queue-typed 2.4.5 → 2.5.0

package/dist/cjs-legacy/index.cjs

@@ -5,54 +5,6 @@ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { en
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
-// 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/common/index.ts
-var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
-  DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
-  DFSOperation2[DFSOperation2["PROCESS"] = 1] = "PROCESS";
-  return DFSOperation2;
-})(DFSOperation || {});
-var _Range = class _Range {
-  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;
-  }
-};
-__name(_Range, "Range");
-var Range = _Range;
-
 // src/data-structures/base/iterable-element-base.ts
 var _IterableElementBase = class _IterableElementBase {
   /**
@@ -75,7 +27,7 @@ var _IterableElementBase = class _IterableElementBase {
     if (options) {
       const { toElementFn } = options;
       if (typeof toElementFn === "function") this._toElementFn = toElementFn;
-      else if (toElementFn) throw new TypeError(ERR.notAFunction("toElementFn"));
+      else if (toElementFn) throw new TypeError("toElementFn must be a function type");
     }
   }
   /**
@@ -231,7 +183,7 @@ var _IterableElementBase = class _IterableElementBase {
       acc = initialValue;
     } else {
       const first = iter.next();
-      if (first.done) throw new TypeError(ERR.reduceEmpty());
+      if (first.done) throw new TypeError("Reduce of empty structure with no initial value");
       acc = first.value;
       index = 1;
     }
@@ -275,6 +227,54 @@ var _IterableElementBase = class _IterableElementBase {
 __name(_IterableElementBase, "IterableElementBase");
 var IterableElementBase = _IterableElementBase;
 
+// 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/common/index.ts
+var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
+  DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
+  DFSOperation2[DFSOperation2["PROCESS"] = 1] = "PROCESS";
+  return DFSOperation2;
+})(DFSOperation || {});
+var _Range = class _Range {
+  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;
+  }
+};
+__name(_Range, "Range");
+var Range = _Range;
+
 // src/data-structures/heap/heap.ts
 var _Heap = class _Heap extends IterableElementBase {
   /**
@@ -312,10 +312,30 @@ var _Heap = class _Heap extends IterableElementBase {
     return this._elements;
   }
   /**
-   * Get the number of elements.
-   * @remarks Time O(1), Space O(1)
-   * @returns Heap size.
-   */
+    * Get the number of elements.
+    * @remarks Time O(1), Space O(1)
+    * @returns Heap size.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Track heap capacity
+  *  const heap = new Heap<number>();
+  *     console.log(heap.size); // 0;
+  *     heap.add(10);
+  *     heap.add(20);
+  *     console.log(heap.size); // 2;
+  *     heap.poll();
+  *     console.log(heap.size); // 1;
+    */
   get size() {
     return this.elements.length;
   }
@@ -354,21 +374,61 @@ var _Heap = class _Heap extends IterableElementBase {
     return new _Heap(elements, options);
   }
   /**
-   * Insert an element.
-   * @remarks Time O(1) amortized, Space O(1)
-   * @param element - Element to insert.
-   * @returns True.
-   */
+    * Insert an element.
+    * @remarks Time O(1) amortized, Space O(1)
+    * @param element - Element to insert.
+    * @returns True.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // basic Heap creation and add operation
+  *  // Create a min heap (default)
+  *     const minHeap = new Heap([5, 3, 7, 1, 9, 2]);
+  *
+  *     // Verify size
+  *     console.log(minHeap.size); // 6;
+  *
+  *     // Add new element
+  *     minHeap.add(4);
+  *     console.log(minHeap.size); // 7;
+  *
+  *     // Min heap property: smallest element at root
+  *     const min = minHeap.peek();
+  *     console.log(min); // 1;
+    */
   add(element) {
     this._elements.push(element);
     return this._bubbleUp(this.elements.length - 1);
   }
   /**
-   * Insert many elements from an iterable.
-   * @remarks Time O(N log N), Space O(1)
-   * @param elements - Iterable of elements or raw values.
-   * @returns Array of per-element success flags.
-   */
+    * Insert many elements from an iterable.
+    * @remarks Time O(N log N), Space O(1)
+    * @param elements - Iterable of elements or raw values.
+    * @returns Array of per-element success flags.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Add multiple elements
+  *  const heap = new Heap<number>([], { comparator: (a, b) => a - b });
+  *     heap.addMany([5, 3, 7, 1]);
+  *     console.log(heap.peek()); // 1;
+  *     console.log(heap.size); // 4;
+    */
   addMany(elements) {
     const flags = [];
     for (const el of elements) {
@@ -383,10 +443,46 @@ var _Heap = class _Heap extends IterableElementBase {
     return flags;
   }
   /**
-   * Remove and return the top element.
-   * @remarks Time O(log N), Space O(1)
-   * @returns Top element or undefined.
-   */
+    * Remove and return the top element.
+    * @remarks Time O(log N), Space O(1)
+    * @returns Top element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @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';
+    */
   poll() {
     if (this.elements.length === 0) return;
     const value = this.elements[0];
@@ -398,26 +494,125 @@ var _Heap = class _Heap extends IterableElementBase {
     return value;
   }
   /**
-   * Get the current top element without removing it.
-   * @remarks Time O(1), Space O(1)
-   * @returns Top element or undefined.
-   */
+    * Get the current top element without removing it.
+    * @remarks Time O(1), Space O(1)
+    * @returns Top element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Heap for event processing with priority
+  *  interface Event {
+  *       id: number;
+  *       type: 'critical' | 'warning' | 'info';
+  *       timestamp: number;
+  *       message: string;
+  *     }
+  *
+  *     // Custom priority: critical > warning > info
+  *     const priorityMap = { critical: 3, warning: 2, info: 1 };
+  *
+  *     const eventHeap = new Heap<Event>([], {
+  *       comparator: (a: Event, b: Event) => {
+  *         const priorityA = priorityMap[a.type];
+  *         const priorityB = priorityMap[b.type];
+  *         return priorityB - priorityA; // Higher priority first
+  *       }
+  *     });
+  *
+  *     // Add events in random order
+  *     eventHeap.add({ id: 1, type: 'info', timestamp: 100, message: 'User logged in' });
+  *     eventHeap.add({ id: 2, type: 'critical', timestamp: 101, message: 'Server down' });
+  *     eventHeap.add({ id: 3, type: 'warning', timestamp: 102, message: 'High memory' });
+  *     eventHeap.add({ id: 4, type: 'info', timestamp: 103, message: 'Cache cleared' });
+  *     eventHeap.add({ id: 5, type: 'critical', timestamp: 104, message: 'Database error' });
+  *
+  *     console.log(eventHeap.size); // 5;
+  *
+  *     // Process events by priority (critical first)
+  *     const processedOrder: Event[] = [];
+  *     while (eventHeap.size > 0) {
+  *       const event = eventHeap.poll();
+  *       if (event) {
+  *         processedOrder.push(event);
+  *       }
+  *     }
+  *
+  *     // Verify critical events came first
+  *     console.log(processedOrder[0].type); // 'critical';
+  *     console.log(processedOrder[1].type); // 'critical';
+  *     console.log(processedOrder[2].type); // 'warning';
+  *     console.log(processedOrder[3].type); // 'info';
+  *     console.log(processedOrder[4].type); // 'info';
+  *
+  *     // Verify O(log n) operations
+  *     const newHeap = new Heap<number>([5, 3, 7, 1]);
+  *
+  *     // Add - O(log n)
+  *     newHeap.add(2);
+  *     console.log(newHeap.size); // 5;
+  *
+  *     // Poll - O(log n)
+  *     const removed = newHeap.poll();
+  *     console.log(removed); // 1;
+  *
+  *     // Peek - O(1)
+  *     const top = newHeap.peek();
+  *     console.log(top); // 2;
+    */
   peek() {
     return this.elements[0];
   }
   /**
-   * Check whether the heap is empty.
-   * @remarks Time O(1), Space O(1)
-   * @returns True if size is 0.
-   */
+    * Check whether the heap is empty.
+    * @remarks Time O(1), Space O(1)
+    * @returns True if size is 0.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Check if heap is empty
+  *  const heap = new Heap<number>([], { comparator: (a, b) => a - b });
+  *     console.log(heap.isEmpty()); // true;
+  *     heap.add(1);
+  *     console.log(heap.isEmpty()); // false;
+    */
   isEmpty() {
     return this.size === 0;
   }
   /**
-   * Remove all elements.
-   * @remarks Time O(1), Space O(1)
-   * @returns void
-   */
+    * Remove all elements.
+    * @remarks Time O(1), Space O(1)
+    * @returns void
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove all elements
+  *  const heap = new Heap<number>([1, 2, 3], { comparator: (a, b) => a - b });
+  *     heap.clear();
+  *     console.log(heap.isEmpty()); // true;
+    */
   clear() {
     this._elements = [];
   }
@@ -432,21 +627,41 @@ var _Heap = class _Heap extends IterableElementBase {
     return this.fix();
   }
   /**
-   * Check if an equal element exists in the heap.
-   * @remarks Time O(N), Space O(1)
-   * @param element - Element to search for.
-   * @returns True if found.
-   */
+    * Check if an equal element exists in the heap.
+    * @remarks Time O(N), Space O(1)
+    * @param element - Element to search for.
+    * @returns True if found.
+    
+    
+     * @example
+  * // Check element existence
+  *  const heap = new Heap<number>([3, 1, 2], { comparator: (a, b) => a - b });
+  *     console.log(heap.has(1)); // true;
+  *     console.log(heap.has(99)); // false;
+    */
   has(element) {
     for (const el of this.elements) if (this._equals(el, element)) return true;
     return false;
   }
   /**
-   * Delete one occurrence of an element.
-   * @remarks Time O(N), Space O(1)
-   * @param element - Element to delete.
-   * @returns True if an element was removed.
-   */
+    * Delete one occurrence of an element.
+    * @remarks Time O(N), Space O(1)
+    * @param element - Element to delete.
+    * @returns True if an element was removed.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove specific element
+  *  const heap = new Heap<number>([3, 1, 4, 1, 5], { comparator: (a, b) => a - b });
+  *     heap.delete(4);
+  *     console.log(heap.toArray().includes(4)); // false;
+    */
   delete(element) {
     let index = -1;
     for (let i = 0; i < this.elements.length; i++) {
@@ -504,11 +719,18 @@ var _Heap = class _Heap extends IterableElementBase {
     return this;
   }
   /**
-   * Traverse the binary heap as a complete binary tree and collect elements.
-   * @remarks Time O(N), Space O(H)
-   * @param [order] - Traversal order: 'PRE' | 'IN' | 'POST'.
-   * @returns Array of visited elements.
-   */
+    * Traverse the binary heap as a complete binary tree and collect elements.
+    * @remarks Time O(N), Space O(H)
+    * @param [order] - Traversal order: 'PRE' | 'IN' | 'POST'.
+    * @returns Array of visited elements.
+    
+    
+     * @example
+  * // Depth-first traversal
+  *  const heap = new Heap<number>([3, 1, 2], { comparator: (a, b) => a - b });
+  *     const result = heap.dfs('IN');
+  *     console.log(result.length); // 3;
+    */
   dfs(order = "PRE") {
     const result = [];
     const _dfs = /* @__PURE__ */ __name((index) => {
@@ -545,10 +767,26 @@ var _Heap = class _Heap extends IterableElementBase {
     return results;
   }
   /**
-   * Return all elements in ascending order by repeatedly polling.
-   * @remarks Time O(N log N), Space O(N)
-   * @returns Sorted array of elements.
-   */
+    * Return all elements in ascending order by repeatedly polling.
+    * @remarks Time O(N log N), Space O(N)
+    * @returns Sorted array of elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Sort elements using heap
+  *  const heap = new Heap<number>([5, 1, 3, 2, 4]);
+  *     const sorted = heap.sort();
+  *     console.log(sorted); // [1, 2, 3, 4, 5];
+    */
   sort() {
     const visited = [];
     const cloned = this._createInstance();
@@ -560,22 +798,52 @@ var _Heap = class _Heap extends IterableElementBase {
     return visited;
   }
   /**
-   * Deep clone this heap.
-   * @remarks Time O(N), Space O(N)
-   * @returns A new heap with the same elements.
-   */
+    * Deep clone this heap.
+    * @remarks Time O(N), Space O(N)
+    * @returns A new heap with the same elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Create independent copy
+  *  const heap = new Heap<number>([3, 1, 4], { comparator: (a, b) => a - b });
+  *     const copy = heap.clone();
+  *     copy.poll();
+  *     console.log(heap.size); // 3;
+  *     console.log(copy.size); // 2;
+    */
   clone() {
     const next = this._createInstance();
     for (const x of this.elements) next.add(x);
     return next;
   }
   /**
-   * Filter elements into a new heap of the same class.
-   * @remarks Time O(N log N), Space O(N)
-   * @param callback - Predicate (element, index, heap) → boolean to keep element.
-   * @param [thisArg] - Value for `this` inside the callback.
-   * @returns A new heap with the kept elements.
-   */
+    * Filter elements into a new heap of the same class.
+    * @remarks Time O(N log N), Space O(N)
+    * @param callback - Predicate (element, index, heap) → boolean to keep element.
+    * @param [thisArg] - Value for `this` inside the callback.
+    * @returns A new heap with the kept elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Filter elements
+  *  const heap = new Heap<number>([1, 2, 3, 4, 5], { comparator: (a, b) => a - b });
+  *     const evens = heap.filter(x => x % 2 === 0);
+  *     console.log(evens.size); // 2;
+    */
   filter(callback, thisArg) {
     const out = this._createInstance();
     let i = 0;
@@ -589,15 +857,28 @@ var _Heap = class _Heap extends IterableElementBase {
     return out;
   }
   /**
-   * Map elements into a new heap of possibly different element type.
-   * @remarks Time O(N log N), Space O(N)
-   * @template EM
-   * @template RM
-   * @param callback - Mapping function (element, index, heap) → newElement.
-   * @param options - Options for the output heap, including comparator for EM.
-   * @param [thisArg] - Value for `this` inside the callback.
-   * @returns A new heap with mapped elements.
-   */
+    * Map elements into a new heap of possibly different element type.
+    * @remarks Time O(N log N), Space O(N)
+    * @template EM
+    * @template RM
+    * @param callback - Mapping function (element, index, heap) → newElement.
+    * @param options - Options for the output heap, including comparator for EM.
+    * @param [thisArg] - Value for `this` inside the callback.
+    * @returns A new heap with mapped elements.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Transform elements
+  *  const heap = new Heap<number>([1, 2, 3], { comparator: (a, b) => a - b });
+  *     const doubled = heap.map(x => x * 2, { comparator: (a, b) => a - b });
+  *     console.log(doubled.peek()); // 2;
+    */
   map(callback, options, thisArg) {
     const { comparator, toElementFn, ...rest } = options != null ? options : {};
     if (!comparator) throw new TypeError(ERR.comparatorRequired("Heap.map"));