data-structure-typed 2.5.2 → 2.6.0

package/dist/esm/graph.mjs

@@ -387,6 +387,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.
    *
@@ -649,6 +678,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
@@ -712,6 +751,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -768,7 +814,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.
     
@@ -798,6 +844,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -855,6 +908,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -918,7 +978,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.
     
     
     
@@ -949,6 +1043,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();
@@ -989,6 +1091,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1089,6 +1198,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1136,6 +1252,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1153,16 +1276,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)
@@ -1186,6 +1299,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1233,6 +1353,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1257,7 +1384,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 {
@@ -1267,13 +1394,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)) {
@@ -1283,7 +1416,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 {
@@ -1326,6 +1459,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1406,6 +1546,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1459,6 +1606,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1511,6 +1665,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1570,6 +1731,13 @@ var Heap = class _Heap extends IterableElementBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1783,6 +1951,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1833,6 +2008,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1850,6 +2032,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)
@@ -1899,6 +2089,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1961,6 +2158,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2030,6 +2234,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2089,6 +2300,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2141,6 +2359,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2195,6 +2420,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)
@@ -2234,6 +2474,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2280,6 +2527,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2349,6 +2603,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2402,6 +2663,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2459,6 +2727,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3598,6 +3873,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3686,6 +3968,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3772,6 +4061,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3849,6 +4145,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3903,6 +4206,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4010,6 +4320,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4098,6 +4415,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4148,6 +4472,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4251,6 +4582,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4357,6 +4695,13 @@ var DirectedGraph = class _DirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4529,6 +4874,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4613,6 +4965,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4697,6 +5056,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4795,6 +5161,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4849,6 +5222,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4973,6 +5353,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5119,6 +5506,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5187,6 +5581,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5237,6 +5638,13 @@ var UndirectedGraph = class _UndirectedGraph extends AbstractGraph {
     
     
     
+    
+    
+    
+    
+    
+    
+