binary-tree-typed 2.5.2 → 2.6.0

package/dist/umd/binary-tree-typed.js

@@ -282,6 +282,35 @@ var binaryTreeTyped = (() => {
       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.
      *
@@ -541,6 +570,16 @@ var binaryTreeTyped = (() => {
       }
       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
@@ -806,6 +845,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -856,6 +902,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -873,6 +926,14 @@ var binaryTreeTyped = (() => {
     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)
@@ -922,6 +983,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -984,6 +1052,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1053,6 +1128,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1112,6 +1194,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1164,6 +1253,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1218,6 +1314,21 @@ var binaryTreeTyped = (() => {
       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)
@@ -1257,6 +1368,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1303,6 +1421,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1372,6 +1497,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1425,6 +1557,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1482,6 +1621,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1960,7 +2106,7 @@ var binaryTreeTyped = (() => {
     }
     /**
       * 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.
@@ -1986,6 +2132,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2008,7 +2161,7 @@ var binaryTreeTyped = (() => {
     }
     /**
       * 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.
@@ -2040,6 +2193,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2146,6 +2306,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2188,6 +2355,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2251,6 +2425,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2270,22 +2451,69 @@ var binaryTreeTyped = (() => {
       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 == null ? void 0 : 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.
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2329,51 +2557,11 @@ var binaryTreeTyped = (() => {
     *     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 == null ? void 0 : 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.
@@ -2422,7 +2610,7 @@ var binaryTreeTyped = (() => {
     }
     /**
       * 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.
@@ -2453,6 +2641,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2478,7 +2673,7 @@ var binaryTreeTyped = (() => {
     }
     /**
       * 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).
@@ -2511,6 +2706,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2572,6 +2774,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2620,6 +2829,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2677,6 +2893,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2761,6 +2984,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2822,6 +3052,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -3299,6 +3536,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -3351,6 +3595,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -3407,6 +3658,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -3488,6 +3746,13 @@ var binaryTreeTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+