undirected-graph-typed 2.5.2 → 2.6.0

package/dist/cjs/index.cjs

@@ -413,6 +413,35 @@ var IterableElementBase = class {
     for (const ele of this) if (ele === element) return true;
     return false;
   }
+  /**
+   * Check whether a value exists (Array-compatible alias for `has`).
+   * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1).
+   * @param element - Element to search for (uses `===`).
+   * @returns `true` if found.
+   */
+  includes(element) {
+    return this.has(element);
+  }
+  /**
+   * Return an iterator of `[index, value]` pairs (Array-compatible).
+   * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+   */
+  *entries() {
+    let index = 0;
+    for (const value of this) {
+      yield [index++, value];
+    }
+  }
+  /**
+   * Return an iterator of numeric indices (Array-compatible).
+   * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+   */
+  *keys() {
+    let index = 0;
+    for (const _ of this) {
+      yield index++;
+    }
+  }
   /**
    * Reduces all elements to a single accumulated value.
    *
@@ -675,6 +704,16 @@ var LinearBase = class _LinearBase extends IterableElementBase {
     }
     return this;
   }
+  /**
+   * Return a new instance of the same type with elements in reverse order (non-mutating).
+   * @remarks Provided for familiarity when migrating from Array (ES2023 `toReversed`). Time O(n), Space O(n).
+   * @returns A new reversed instance.
+   */
+  toReversed() {
+    const cloned = this.clone();
+    cloned.reverse();
+    return cloned;
+  }
 };
 
 // src/data-structures/heap/heap.ts
@@ -738,6 +777,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -794,7 +840,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.
     
@@ -824,6 +870,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -881,6 +934,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -945,6 +1005,40 @@ 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.
     
     
     
@@ -975,6 +1069,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();
@@ -1015,6 +1117,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1115,6 +1224,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1162,6 +1278,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1179,16 +1302,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)
@@ -1212,6 +1325,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1259,6 +1379,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1283,7 +1410,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 {
@@ -1293,13 +1420,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)) {
@@ -1309,7 +1442,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 {
@@ -1352,6 +1485,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1432,6 +1572,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1485,6 +1632,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1537,6 +1691,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1596,6 +1757,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1809,6 +1977,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1859,6 +2034,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1876,6 +2058,14 @@ var Queue = class _Queue extends LinearBase {
   get first() {
     return this.length > 0 ? this.elements[this._offset] : void 0;
   }
+  /**
+   * Peek at the front element without removing it (alias for `first`).
+   * @remarks Time O(1), Space O(1)
+   * @returns Front element or undefined.
+   */
+  peek() {
+    return this.first;
+  }
   /**
    * Get the last element (back) without removing it.
    * @remarks Time O(1), Space O(1)
@@ -1925,6 +2115,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1987,6 +2184,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2056,6 +2260,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2115,6 +2326,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2167,6 +2385,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2221,6 +2446,21 @@ var Queue = class _Queue extends LinearBase {
     this._elements[this._offset + index] = newElement;
     return true;
   }
+  /**
+   * Delete the first element that satisfies a predicate.
+   * @remarks Time O(N), Space O(N)
+   * @param predicate - Function (value, index, queue) → boolean to decide deletion.
+   * @returns True if a match was removed.
+   */
+  deleteWhere(predicate) {
+    for (let i = 0; i < this.length; i++) {
+      if (predicate(this._elements[this._offset + i], i, this)) {
+        this.deleteAt(i);
+        return true;
+      }
+    }
+    return false;
+  }
   /**
    * Reverse the queue in-place by compacting then reversing.
    * @remarks Time O(N), Space O(N)
@@ -2260,6 +2500,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2306,6 +2553,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2375,6 +2629,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2428,6 +2689,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2485,6 +2753,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3613,6 +3888,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3697,6 +3979,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3781,6 +4070,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3879,6 +4175,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3933,6 +4236,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4057,6 +4367,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4203,6 +4520,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4271,6 +4595,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4321,6 +4652,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+