avl-tree-typed 2.5.2 → 2.6.0

package/dist/cjs/index.cjs

@@ -261,6 +261,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.
    *
@@ -523,6 +552,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/base/iterable-entry-base.ts
@@ -794,6 +833,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -844,6 +890,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -861,6 +914,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)
@@ -910,6 +971,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -972,6 +1040,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1041,6 +1116,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1100,6 +1182,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1152,6 +1241,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1206,6 +1302,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)
@@ -1245,6 +1356,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1291,6 +1409,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1360,6 +1485,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1413,6 +1545,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1470,6 +1609,13 @@ var Queue = class _Queue extends LinearBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1944,7 +2090,7 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
   }
   /**
     * Adds a new node to the tree.
-    * @remarks Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). This implementation adds the node at the first available position in a level-order (BFS) traversal. This is NOT a Binary Search Tree insertion. Time O(N), where N is the number of nodes. It must traverse level-by-level to find an empty slot. Space O(N) in the worst case for the BFS queue (e.g., a full last level).
+    * @remarks Time O(N) — level-order traversal to find an empty slot. Space O(N) for the BFS queue. BST/Red-Black Tree/AVL Tree subclasses override to O(log N).
     *
     * @param keyNodeOrEntry - The key, node, or entry to add.
     * @returns True if the addition was successful, false otherwise.
@@ -1970,6 +2116,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -1992,7 +2145,7 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
   }
   /**
     * Adds or updates a new node to the tree.
-    * @remarks Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). This implementation sets the node at the first available position in a level-order (BFS) traversal. This is NOT a Binary Search Tree insertion. Time O(N), where N is the number of nodes. It must traverse level-by-level to find an empty slot. Space O(N) in the worst case for the BFS queue (e.g., a full last level).
+    * @remarks Time O(N) — level-order traversal to find an empty slot. Space O(N) for the BFS queue. BST/Red-Black Tree/AVL Tree subclasses override to O(log N).
     *
     * @param keyNodeOrEntry - The key, node, or entry to set or update.
     * @param [value] - The value, if providing just a key.
@@ -2024,6 +2177,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2130,6 +2290,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2172,6 +2339,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2235,6 +2409,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2254,22 +2435,69 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     this.setMany(anotherTree, []);
   }
   /**
-   * Clears the tree and refills it with new items.
-   * @remarks Time O(N) (for `clear`) + O(N * M) (for `setMany`) = O(N * M). Space O(M) (from `setMany`).
+   * Deletes a node from the tree (internal, returns balancing metadata).
+   * @remarks Time O(N) — O(N) to find the node + O(H) for predecessor swap. Space O(1). BST/Red-Black Tree/AVL Tree subclasses override to O(log N).
+   * @internal Used by AVL/BST subclasses that need balancing metadata after deletion.
    *
-   * @param keysNodesEntriesOrRaws - An iterable of items to set.
-   * @param [values] - An optional parallel iterable of values.
+   * @param keyNodeEntryRawOrPredicate - The node to delete.
+   * @returns An array containing deletion results with balancing metadata.
    */
-  refill(keysNodesEntriesOrRaws, values) {
-    this.clear();
-    this.setMany(keysNodesEntriesOrRaws, values);
+  _deleteInternal(keyNodeEntryRawOrPredicate) {
+    const deletedResult = [];
+    if (!this._root) return deletedResult;
+    const curr = this.getNode(keyNodeEntryRawOrPredicate);
+    if (!curr) return deletedResult;
+    const parent = curr?.parent;
+    let needBalanced;
+    let orgCurrent = curr;
+    if (!curr.left && !curr.right && !parent) {
+      this._setRoot(void 0);
+    } else if (curr.left) {
+      const leftSubTreeRightMost = this.getRightMost((node) => node, curr.left);
+      if (leftSubTreeRightMost) {
+        const parentOfLeftSubTreeMax = leftSubTreeRightMost.parent;
+        orgCurrent = this._swapProperties(curr, leftSubTreeRightMost);
+        if (this._isMapMode) {
+          this._store.set(curr.key, curr);
+          this._store.set(leftSubTreeRightMost.key, leftSubTreeRightMost);
+        }
+        if (parentOfLeftSubTreeMax) {
+          if (parentOfLeftSubTreeMax.right === leftSubTreeRightMost)
+            parentOfLeftSubTreeMax.right = leftSubTreeRightMost.left;
+          else parentOfLeftSubTreeMax.left = leftSubTreeRightMost.left;
+          needBalanced = parentOfLeftSubTreeMax;
+        }
+      }
+    } else if (parent) {
+      const { familyPosition: fp } = curr;
+      if (fp === "LEFT" || fp === "ROOT_LEFT") {
+        parent.left = curr.right;
+      } else if (fp === "RIGHT" || fp === "ROOT_RIGHT") {
+        parent.right = curr.right;
+      }
+      needBalanced = parent;
+    } else {
+      this._setRoot(curr.right);
+      curr.right = void 0;
+    }
+    this._size = this._size - 1;
+    deletedResult.push({ deleted: orgCurrent, needBalanced });
+    if (this._isMapMode && orgCurrent) this._store.delete(orgCurrent.key);
+    return deletedResult;
   }
   /**
     * Deletes a node from the tree.
-    * @remarks Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). This implementation finds the node, and if it has two children, swaps it with the rightmost node of its left subtree (in-order predecessor) before deleting. Time O(N) in the worst case. O(N) to find the node (`getNode`) and O(H) (which is O(N) worst-case) to find the rightmost node. Space O(1) (if `getNode` is iterative, which it is).
+    * @remarks Time O(N) — O(N) to find the node + O(H) for predecessor swap. Space O(1). BST/Red-Black Tree/AVL Tree subclasses override to O(log N).
     *
     * @param keyNodeEntryRawOrPredicate - The node to delete.
-    * @returns An array containing deletion results (for compatibility with self-balancing trees).
+    * @returns True if the node was found and deleted, false otherwise.
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2313,51 +2541,11 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
   *     console.log(tree.size); // 4;
     */
   delete(keyNodeEntryRawOrPredicate) {
-    const deletedResult = [];
-    if (!this._root) return deletedResult;
-    const curr = this.getNode(keyNodeEntryRawOrPredicate);
-    if (!curr) return deletedResult;
-    const parent = curr?.parent;
-    let needBalanced;
-    let orgCurrent = curr;
-    if (!curr.left && !curr.right && !parent) {
-      this._setRoot(void 0);
-    } else if (curr.left) {
-      const leftSubTreeRightMost = this.getRightMost((node) => node, curr.left);
-      if (leftSubTreeRightMost) {
-        const parentOfLeftSubTreeMax = leftSubTreeRightMost.parent;
-        orgCurrent = this._swapProperties(curr, leftSubTreeRightMost);
-        if (this._isMapMode) {
-          this._store.set(curr.key, curr);
-          this._store.set(leftSubTreeRightMost.key, leftSubTreeRightMost);
-        }
-        if (parentOfLeftSubTreeMax) {
-          if (parentOfLeftSubTreeMax.right === leftSubTreeRightMost)
-            parentOfLeftSubTreeMax.right = leftSubTreeRightMost.left;
-          else parentOfLeftSubTreeMax.left = leftSubTreeRightMost.left;
-          needBalanced = parentOfLeftSubTreeMax;
-        }
-      }
-    } else if (parent) {
-      const { familyPosition: fp } = curr;
-      if (fp === "LEFT" || fp === "ROOT_LEFT") {
-        parent.left = curr.right;
-      } else if (fp === "RIGHT" || fp === "ROOT_RIGHT") {
-        parent.right = curr.right;
-      }
-      needBalanced = parent;
-    } else {
-      this._setRoot(curr.right);
-      curr.right = void 0;
-    }
-    this._size = this._size - 1;
-    deletedResult.push({ deleted: orgCurrent, needBalanced });
-    if (this._isMapMode && orgCurrent) this._store.delete(orgCurrent.key);
-    return deletedResult;
+    return this._deleteInternal(keyNodeEntryRawOrPredicate).length > 0;
   }
   /**
    * Searches the tree for nodes matching a predicate.
-   * @remarks Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). Performs a full DFS (pre-order) scan of the tree. Time O(N), as it may visit every node. Space O(H) for the call stack (recursive) or explicit stack (iterative), where H is the tree height (O(N) worst-case).
+   * @remarks Time O(N) — full DFS scan; may visit every node. Space O(H) for call/explicit stack (O(N) worst-case). BST subclasses with key search override to O(log N).
    *
    * @template C - The type of the callback function.
    * @param keyNodeEntryOrPredicate - The key, node, entry, or predicate function to search for.
@@ -2406,7 +2594,7 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
   }
   /**
     * Gets the first node matching a predicate.
-    * @remarks Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). Time O(N) in the worst case (via `search`). Space O(H) or O(N) (via `search`).
+    * @remarks Time O(N) via `search`. Space O(H) or O(N). BST/Red-Black Tree/AVL Tree subclasses override to O(log N) for key lookups.
     *
     * @param keyNodeEntryOrPredicate - The key, node, entry, or predicate function to search for.
     * @param [startNode=this._root] - The node to start the search from.
@@ -2437,6 +2625,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2462,7 +2657,7 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
   }
   /**
     * Gets the value associated with a key.
-    * @remarks Time O(log N), For BST, Red-Black Tree, and AVL Tree subclasses, the worst-case time is O(log N). Time O(1) if in Map mode. O(N) if not in Map mode (uses `getNode`). Space O(1) if in Map mode. O(H) or O(N) otherwise.
+    * @remarks Time O(1) in Map mode, O(N) otherwise (via `getNode`). Space O(1) in Map mode, O(H) or O(N) otherwise. BST subclasses override non-Map-mode to O(log N).
     *
     * @param keyNodeEntryOrPredicate - The key, node, or entry to get the value for.
     * @param [startNode=this._root] - The node to start searching from (if not in Map mode).
@@ -2495,6 +2690,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2555,6 +2757,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2603,6 +2812,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2660,6 +2876,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2744,6 +2967,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -2805,6 +3035,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3282,6 +3519,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3334,6 +3578,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3390,6 +3641,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -3471,6 +3729,13 @@ var BinaryTree = class _BinaryTree extends IterableEntryBase {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4287,6 +4552,20 @@ var BST = class extends BinaryTree {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4617,6 +4896,27 @@ var BST = class extends BinaryTree {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -4738,6 +5038,20 @@ var BST = class extends BinaryTree {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5032,6 +5346,13 @@ var BST = class extends BinaryTree {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5101,6 +5422,13 @@ var BST = class extends BinaryTree {
     
     
     
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5216,6 +5544,20 @@ var BST = class extends BinaryTree {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -5283,12 +5625,11 @@ var BST = class extends BinaryTree {
    */
   deleteWhere(keyNodeEntryOrPredicate, onlyOne = false, startNode = this._root, iterationType = this.iterationType) {
     const toDelete = this.search(keyNodeEntryOrPredicate, onlyOne, (node) => node, startNode, iterationType);
-    let results = [];
+    let deleted = false;
     for (const node of toDelete) {
-      const deleteInfo = this.delete(node);
-      results = results.concat(deleteInfo);
+      if (this.delete(node)) deleted = true;
     }
-    return results;
+    return deleted;
   }
   /**
    * (Protected) Creates the default comparator function for keys that don't have a custom comparator.
@@ -6116,6 +6457,34 @@ var AVLTree = class extends BST {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -6240,6 +6609,27 @@ var AVLTree = class extends BST {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -6269,13 +6659,13 @@ var AVLTree = class extends BST {
   *     console.log(avl.size); // 6;
     */
   delete(keyNodeOrEntry) {
-    const deletedResults = super.delete(keyNodeOrEntry);
+    const deletedResults = this._deleteInternal(keyNodeOrEntry);
     for (const { needBalanced } of deletedResults) {
       if (needBalanced) {
         this._balancePath(needBalanced);
       }
     }
-    return deletedResults;
+    return deletedResults.length > 0;
   }
   /**
     * Rebuilds the tree to be perfectly balanced.
@@ -6329,6 +6719,20 @@ var AVLTree = class extends BST {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -6459,6 +6863,27 @@ var AVLTree = class extends BST {
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+