data-structure-typed 2.5.2 → 2.5.3

package/src/data-structures/graph/directed-graph.ts

@@ -244,6 +244,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -339,6 +343,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -429,6 +437,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -519,6 +531,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -574,6 +590,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -701,6 +721,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -795,6 +819,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -846,6 +874,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -909,7 +941,7 @@ export class DirectedGraph<
    * Remove all vertices and edges.
    * @remarks Time O(V + E), Space O(1)
    */
-  clear() {
+  clear(): void {
     this._vertexMap = new Map<VertexKey, VO>();
     this._inEdgeMap = new Map<VO, EO[]>();
     this._outEdgeMap = new Map<VO, EO[]>();
@@ -955,6 +987,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -1074,6 +1110,10 @@ export class DirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    

package/src/data-structures/graph/undirected-graph.ts

@@ -253,6 +253,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -344,6 +348,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -430,6 +438,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -540,6 +552,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -595,6 +611,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -679,7 +699,7 @@ export class UndirectedGraph<
    * Remove all vertices and edges.
    * @remarks Time O(V + E), Space O(1)
    */
-  clear() {
+  clear(): void {
     this._vertexMap = new Map<VertexKey, VO>();
     this._edgeMap = new Map<VO, EO[]>();
   }
@@ -724,6 +744,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -897,6 +921,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -968,6 +996,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    
@@ -1019,6 +1051,10 @@ export class UndirectedGraph<
    
    
    
+   
+   
+   
+   
    
    
    

package/src/data-structures/hash/hash-map.ts

@@ -199,6 +199,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -245,6 +249,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -338,6 +346,14 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
+   
+   
+   
+   
    
    
    
@@ -366,7 +382,7 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
  *     // Verify entries
  *     console.log([...map.entries()]); // length: 4;
    */
-  set(key: K, value: V): boolean {
+  set(key: K, value: V): this {
     if (this._isObjKey(key)) {
       if (!this.objMap.has(key)) this._size++;
       this.objMap.set(key, value);
@@ -375,7 +391,7 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
       if (this.store[strKey] === undefined) this._size++;
       this._store[strKey] = { key, value };
     }
-    return true;
+    return this;
   }
 
   /**
@@ -411,6 +427,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -428,7 +448,11 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
       let key: K | undefined, value: V | undefined;
       if (this.isEntry(rawEle)) [key, value] = rawEle;
       else if (this._toEntryFn) [key, value] = this._toEntryFn(rawEle);
-      if (key !== undefined && value !== undefined) results.push(this.set(key, value));
+      if (key !== undefined && value !== undefined) {
+        const sizeBefore = this._size;
+        this.set(key, value);
+        results.push(sizeBefore < this._size);
+      }
     }
     return results;
   }
@@ -468,6 +492,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -536,6 +564,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -589,6 +621,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -661,6 +697,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -715,6 +755,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -771,6 +815,10 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
    
    
    
+   
+   
+   
+   
    
    
    
@@ -803,11 +851,11 @@ export class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K,
  *     console.log(values); // contains 7;
    */
 
-  filter(predicate: EntryCallback<K, V, boolean>, thisArg?: unknown): any {
+  filter(predicate: EntryCallback<K, V, boolean>, thisArg?: unknown): this {
     const out = this._createLike<K, V, [K, V]>();
     let index = 0;
     for (const [key, value] of this) if (predicate.call(thisArg, value, key, index++, this)) out.set(key, value);
-    return out;
+    return out as this;
   }
 
   /**
@@ -1015,9 +1063,9 @@ export class LinkedHashMap<K = any, V = any, R = [K, V]> extends IterableEntryBa
    * @remarks Time O(1), Space O(1)
    * @param key - Key.
    * @param [value] - Value.
-   * @returns True when the operation succeeds.
+   * @returns This map (for chaining).
    */
-  set(key: K, value?: V): boolean {
+  set(key: K, value?: V): this {
     let node: HashMapLinkedNode<K, V | undefined> | undefined;
     const isNewKey = !this.has(key);
 
@@ -1053,7 +1101,7 @@ export class LinkedHashMap<K = any, V = any, R = [K, V]> extends IterableEntryBa
       this._size++;
     }
 
-    return true;
+    return this;
   }
 
   setMany(entryOrRawElements: Iterable<R | [K, V]>): boolean[] {
@@ -1062,7 +1110,11 @@ export class LinkedHashMap<K = any, V = any, R = [K, V]> extends IterableEntryBa
       let key: K | undefined, value: V | undefined;
       if (this.isEntry(rawEle)) [key, value] = rawEle;
       else if (this._toEntryFn) [key, value] = this._toEntryFn(rawEle);
-      if (key !== undefined && value !== undefined) results.push(this.set(key, value));
+      if (key !== undefined && value !== undefined) {
+        const sizeBefore = this._size;
+        this.set(key, value);
+        results.push(sizeBefore < this._size);
+      }
     }
     return results;
   }
@@ -1146,13 +1198,16 @@ export class LinkedHashMap<K = any, V = any, R = [K, V]> extends IterableEntryBa
    * Delete the entry at a given index.
    * @remarks Time O(N), Space O(1)
    * @param index - Zero-based index.
-   * @returns True if removed.
+   * @returns The removed entry [key, value].
+   * @throws {RangeError} If index is out of bounds.
    */
-  deleteAt(index: number): boolean {
+  deleteAt(index: number): [K, V | undefined] {
     rangeCheck(index, 0, this._size - 1);
     let node = this.head;
     while (index--) node = node.next;
-    return this._deleteNode(node);
+    const entry: [K, V | undefined] = [node.key as K, node.value];
+    this._deleteNode(node);
+    return entry;
   }
 
   isEmpty(): boolean {

package/src/data-structures/heap/heap.ts

@@ -12,7 +12,7 @@ import { ERR, raise } from '../../common';
 
 /**
  * Binary heap with pluggable comparator; supports fast insertion and removal of the top element.
- * @remarks Time O(1), Space O(1)
+ * @remarks Typical operations: O(log N) insert/remove, O(1) peek. Space O(N).
  * @template E
  * @template R
  * 1. Complete Binary Tree: Heaps are typically complete binary trees, meaning every level is fully filled except possibly for the last level, which has nodes as far left as possible.
@@ -215,6 +215,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -280,7 +284,7 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
 
   /**
    * 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.
    
@@ -313,6 +317,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -372,6 +380,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -434,6 +446,9 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
    
    
    
@@ -465,7 +480,44 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
  *     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 {
+ *       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(): E | undefined {
+    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(): E | undefined {
     if (this.elements.length === 0) return;
     const value = this.elements[0];
     const last = this.elements.pop()!;
@@ -510,6 +562,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -612,6 +668,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -661,6 +721,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -677,17 +741,7 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
     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: Iterable<E>): boolean[] {
-    this._elements = Array.from(elements);
-    return this.fix();
-  }
 
   /**
    * Check if an equal element exists in the heap.
@@ -715,6 +769,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -764,6 +822,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -786,7 +848,7 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
     }
     if (index < 0) return false;
     if (index === 0) {
-      this.poll();
+      this.pop();
     } else if (index === this.elements.length - 1) {
       this.elements.pop();
     } else {
@@ -797,14 +859,20 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
     return true;
   }
 
+  /**
+   * @deprecated Use `deleteWhere` instead. Will be removed in a future major version.
+   */
+  deleteBy(predicate: (element: E, index: number, heap: this) => boolean): boolean {
+    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: (element: E, index: number, heap: this) => boolean): boolean {
+  deleteWhere(predicate: (element: E, index: number, heap: this) => boolean): boolean {
     let idx = -1;
     for (let i = 0; i < this.elements.length; i++) {
       if (predicate(this.elements[i], i, this)) {
@@ -814,7 +882,7 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
     }
     if (idx < 0) return false;
     if (idx === 0) {
-      this.poll();
+      this.pop();
     } else if (idx === this.elements.length - 1) {
       this.elements.pop();
     } else {
@@ -863,6 +931,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -948,6 +1020,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -1003,6 +1079,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -1057,6 +1137,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -1118,6 +1202,10 @@ export class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    
    
    
+   
+   
+   
+   
    
    
    
@@ -1361,17 +1449,17 @@ export class FibonacciHeap<E> {
    * 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: E): this {
+  push(element: E): boolean {
     const node = this.createNode(element);
     node.left = node;
     node.right = node;
     this.mergeWithRoot(node);
     if (!this.min || this.comparator(node.element, this.min.element) <= 0) this._min = node;
     this._size++;
-    return this;
+    return true;
   }
 
   peek(): E | undefined {