avl-tree-typed 2.2.7 → 2.3.0

package/dist/cjs/index.cjs

@@ -1189,9 +1189,9 @@ var BinaryTree = class extends IterableEntryBase {
   iterationType = "ITERATIVE";
   /**
    * Creates an instance of BinaryTree.
-   * @remarks Time O(N * M), where N is the number of items in `keysNodesEntriesOrRaws` and M is the tree size at insertion time (due to O(M) `add` operation). Space O(N) for storing the nodes.
+   * @remarks Time O(N * M), where N is the number of items in `keysNodesEntriesOrRaws` and M is the tree size at insertion time (due to O(M) `set` operation). Space O(N) for storing the nodes.
    *
-   * @param [keysNodesEntriesOrRaws=[]] - An iterable of items to add.
+   * @param [keysNodesEntriesOrRaws=[]] - An iterable of items to set.
    * @param [options] - Configuration options for the tree.
    */
   constructor(keysNodesEntriesOrRaws = [], options) {
@@ -1204,7 +1204,7 @@ var BinaryTree = class extends IterableEntryBase {
       if (typeof toEntryFn === "function") this._toEntryFn = toEntryFn;
       else if (toEntryFn) throw TypeError("toEntryFn must be a function type");
     }
-    if (keysNodesEntriesOrRaws) this.addMany(keysNodesEntriesOrRaws);
+    if (keysNodesEntriesOrRaws) this.setMany(keysNodesEntriesOrRaws);
   }
   _isMapMode = true;
   /**
@@ -1418,10 +1418,20 @@ var BinaryTree = class extends IterableEntryBase {
    * @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).
    *
    * @param keyNodeOrEntry - The key, node, or entry to add.
+   * @returns True if the addition was successful, false otherwise.
+   */
+  add(keyNodeOrEntry) {
+    return this.set(keyNodeOrEntry);
+  }
+  /**
+   * 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).
+   *
+   * @param keyNodeOrEntry - The key, node, or entry to set or update.
    * @param [value] - The value, if providing just a key.
    * @returns True if the addition was successful, false otherwise.
    */
-  add(keyNodeOrEntry, value) {
+  set(keyNodeOrEntry, value) {
     const [newNode, newValue] = this._keyValueNodeOrEntryToNodeAndValue(keyNodeOrEntry, value);
     if (newNode === void 0) return false;
     if (!this._root) {
@@ -1465,25 +1475,24 @@ var BinaryTree = class extends IterableEntryBase {
     return false;
   }
   /**
-   * 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 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).
+   * Adds multiple items to the tree.
+   * @remarks Time O(N * M), where N is the number of items to set and M is the size of the tree at insertion (due to O(M) `set` operation). Space O(M) (from `set`) + O(N) (for the `inserted` array).
    *
-   * @param keyNodeOrEntry - The key, node, or entry to add or update.
-   * @param [value] - The value, if providing just a key.
-   * @returns True if the addition was successful, false otherwise.
+   * @param keysNodesEntriesOrRaws - An iterable of items to set.
+   * @returns An array of booleans indicating the success of each individual `set` operation.
    */
-  set(keyNodeOrEntry, value) {
-    return this.add(keyNodeOrEntry, value);
+  addMany(keysNodesEntriesOrRaws) {
+    return this.setMany(keysNodesEntriesOrRaws);
   }
   /**
-   * Adds multiple items to the tree.
-   * @remarks Time O(N * M), where N is the number of items to add and M is the size of the tree at insertion (due to O(M) `add` operation). Space O(M) (from `add`) + O(N) (for the `inserted` array).
+   * Adds or updates multiple items to the tree.
+   * @remarks Time O(N * M), where N is the number of items to set and M is the size of the tree at insertion (due to O(M) `set` operation). Space O(M) (from `set`) + O(N) (for the `inserted` array).
    *
-   * @param keysNodesEntriesOrRaws - An iterable of items to add.
+   * @param keysNodesEntriesOrRaws - An iterable of items to set or update.
    * @param [values] - An optional parallel iterable of values.
-   * @returns An array of booleans indicating the success of each individual `add` operation.
+   * @returns An array of booleans indicating the success of each individual `set` operation.
    */
-  addMany(keysNodesEntriesOrRaws, values) {
+  setMany(keysNodesEntriesOrRaws, values) {
     const inserted = [];
     let valuesIterator;
     if (values) {
@@ -1498,40 +1507,29 @@ var BinaryTree = class extends IterableEntryBase {
         }
       }
       if (this.isRaw(keyNodeEntryOrRaw)) keyNodeEntryOrRaw = this._toEntryFn(keyNodeEntryOrRaw);
-      inserted.push(this.add(keyNodeEntryOrRaw, value));
+      inserted.push(this.set(keyNodeEntryOrRaw, value));
     }
     return inserted;
   }
   /**
-   * Adds or updates multiple items to the tree.
-   * @remarks Time O(N * M), where N is the number of items to add and M is the size of the tree at insertion (due to O(M) `add` operation). Space O(M) (from `add`) + O(N) (for the `inserted` array).
-   *
-   * @param keysNodesEntriesOrRaws - An iterable of items to add or update.
-   * @param [values] - An optional parallel iterable of values.
-   * @returns An array of booleans indicating the success of each individual `add` operation.
-   */
-  setMany(keysNodesEntriesOrRaws, values) {
-    return this.addMany(keysNodesEntriesOrRaws, values);
-  }
-  /**
-   * Merges another tree into this one by adding all its nodes.
-   * @remarks Time O(N * M), same as `addMany`, where N is the size of `anotherTree` and M is the size of this tree. Space O(M) (from `add`).
+   * Merges another tree into this one by seting all its nodes.
+   * @remarks Time O(N * M), same as `setMany`, where N is the size of `anotherTree` and M is the size of this tree. Space O(M) (from `set`).
    *
    * @param anotherTree - The tree to merge.
    */
   merge(anotherTree) {
-    this.addMany(anotherTree, []);
+    this.setMany(anotherTree, []);
   }
   /**
    * Clears the tree and refills it with new items.
-   * @remarks Time O(N) (for `clear`) + O(N * M) (for `addMany`) = O(N * M). Space O(M) (from `addMany`).
+   * @remarks Time O(N) (for `clear`) + O(N * M) (for `setMany`) = O(N * M). Space O(M) (from `setMany`).
    *
-   * @param keysNodesEntriesOrRaws - An iterable of items to add.
+   * @param keysNodesEntriesOrRaws - An iterable of items to set.
    * @param [values] - An optional parallel iterable of values.
    */
   refill(keysNodesEntriesOrRaws, values) {
     this.clear();
-    this.addMany(keysNodesEntriesOrRaws, values);
+    this.setMany(keysNodesEntriesOrRaws, values);
   }
   /**
    * Deletes a node from the tree.
@@ -2196,7 +2194,7 @@ var BinaryTree = class extends IterableEntryBase {
   }
   /**
    * Clones the tree.
-   * @remarks Time O(N * M), where N is the number of nodes and M is the tree size during insertion (due to `bfs` + `add`, and `add` is O(M)). Space O(N) for the new tree and the BFS queue.
+   * @remarks Time O(N * M), where N is the number of nodes and M is the tree size during insertion (due to `bfs` + `set`, and `set` is O(M)). Space O(N) for the new tree and the BFS queue.
    *
    * @returns A new, cloned instance of the tree.
    */
@@ -2207,7 +2205,7 @@ var BinaryTree = class extends IterableEntryBase {
   }
   /**
    * Creates a new tree containing only the entries that satisfy the predicate.
-   * @remarks Time O(N * M), where N is nodes in this tree, and M is size of the new tree during insertion (O(N) iteration + O(M) `add` for each item). Space O(N) for the new tree.
+   * @remarks Time O(N * M), where N is nodes in this tree, and M is size of the new tree during insertion (O(N) iteration + O(M) `set` for each item). Space O(N) for the new tree.
    *
    * @param predicate - A function to test each [key, value] pair.
    * @param [thisArg] - `this` context for the predicate.
@@ -2216,7 +2214,7 @@ var BinaryTree = class extends IterableEntryBase {
   filter(predicate, thisArg) {
     const out = this._createInstance();
     let i = 0;
-    for (const [k, v] of this) if (predicate.call(thisArg, v, k, i++, this)) out.add([k, v]);
+    for (const [k, v] of this) if (predicate.call(thisArg, v, k, i++, this)) out.set([k, v]);
     return out;
   }
   /**
@@ -2234,7 +2232,7 @@ var BinaryTree = class extends IterableEntryBase {
   map(cb, options, thisArg) {
     const out = this._createLike([], options);
     let i = 0;
-    for (const [k, v] of this) out.add(cb.call(thisArg, v, k, i++, this));
+    for (const [k, v] of this) out.set(cb.call(thisArg, v, k, i++, this));
     return out;
   }
   /**
@@ -2486,18 +2484,18 @@ var BinaryTree = class extends IterableEntryBase {
     return [this.createNode(keyNodeOrEntry, value), value];
   }
   /**
-   * (Protected) Helper for cloning. Performs a BFS and adds all nodes to the new tree.
-   * @remarks Time O(N * M) (O(N) BFS + O(M) `add` for each node).
+   * (Protected) Helper for cloning. Performs a BFS and sets all nodes to the new tree.
+   * @remarks Time O(N * M) (O(N) BFS + O(M) `set` for each node).
    *
    * @param cloned - The new, empty tree instance to populate.
    */
   _clone(cloned) {
     this.bfs(
       (node) => {
-        if (node === null) cloned.add(null);
+        if (node === null) cloned.set(null);
         else {
-          if (this._isMapMode) cloned.add([node.key, this._store.get(node.key)]);
-          else cloned.add([node.key, node.value]);
+          if (this._isMapMode) cloned.set([node.key, this._store.get(node.key)]);
+          else cloned.set([node.key, node.value]);
         }
       },
       this._root,
@@ -2830,7 +2828,7 @@ var BST = class extends BinaryTree {
    * Creates an instance of BST.
    * @remarks Time O(N log N) or O(N^2) depending on `isBalanceAdd` in `addMany` and input order. Space O(N).
    *
-   * @param [keysNodesEntriesOrRaws=[]] - An iterable of items to add.
+   * @param [keysNodesEntriesOrRaws=[]] - An iterable of items to set.
    * @param [options] - Configuration options for the BST, including comparator.
    */
   constructor(keysNodesEntriesOrRaws = [], options) {
@@ -2844,7 +2842,7 @@ var BST = class extends BinaryTree {
     } else {
       this._comparator = this._createDefaultComparator();
     }
-    if (keysNodesEntriesOrRaws) this.addMany(keysNodesEntriesOrRaws);
+    if (keysNodesEntriesOrRaws) this.setMany(keysNodesEntriesOrRaws);
   }
   _root = void 0;
   /**
@@ -3060,11 +3058,11 @@ var BST = class extends BinaryTree {
    * Adds a new node to the BST based on key comparison.
    * @remarks Time O(log N), where H is tree height. O(N) worst-case (unbalanced tree), O(log N) average. Space O(1).
    *
-   * @param keyNodeOrEntry - The key, node, or entry to add.
+   * @param keyNodeOrEntry - The key, node, or entry to set.
    * @param [value] - The value, if providing just a key.
    * @returns True if the addition was successful, false otherwise.
    */
-  add(keyNodeOrEntry, value) {
+  set(keyNodeOrEntry, value) {
     const [newNode, newValue] = this._keyValueNodeOrEntryToNodeAndValue(keyNodeOrEntry, value);
     if (newNode === void 0) return false;
     if (this._root === void 0) {
@@ -3101,24 +3099,24 @@ var BST = class extends BinaryTree {
   }
   /**
    * Adds multiple items to the tree.
-   * @remarks If `isBalanceAdd` is true, sorts the input and builds a balanced tree. Time O(N log N) (due to sort and balanced add).
+   * @remarks If `isBalanceAdd` is true, sorts the input and builds a balanced tree. Time O(N log N) (due to sort and balanced set).
    * If false, adds items one by one. Time O(N * H), which is O(N^2) worst-case.
    * Space O(N) for sorting and recursion/iteration stack.
    *
-   * @param keysNodesEntriesOrRaws - An iterable of items to add.
+   * @param keysNodesEntriesOrRaws - An iterable of items to set.
    * @param [values] - An optional parallel iterable of values.
    * @param [isBalanceAdd=true] - If true, builds a balanced tree from the items.
-   * @param [iterationType=this.iterationType] - The traversal method for balanced add (recursive or iterative).
-   * @returns An array of booleans indicating the success of each individual `add` operation.
+   * @param [iterationType=this.iterationType] - The traversal method for balanced set (recursive or iterative).
+   * @returns An array of booleans indicating the success of each individual `set` operation.
    */
-  addMany(keysNodesEntriesOrRaws, values, isBalanceAdd = true, iterationType = this.iterationType) {
+  setMany(keysNodesEntriesOrRaws, values, isBalanceAdd = true, iterationType = this.iterationType) {
     const inserted = [];
     const valuesIterator = values?.[Symbol.iterator]();
     if (!isBalanceAdd) {
       for (let kve of keysNodesEntriesOrRaws) {
         const val = valuesIterator?.next().value;
         if (this.isRaw(kve)) kve = this._toEntryFn(kve);
-        inserted.push(this.add(kve, val));
+        inserted.push(this.set(kve, val));
       }
       return inserted;
     }
@@ -3146,9 +3144,9 @@ var BST = class extends BinaryTree {
       const { key, value, orgIndex } = arr[mid];
       if (this.isRaw(key)) {
         const entry = this._toEntryFn(key);
-        inserted[orgIndex] = this.add(entry);
+        inserted[orgIndex] = this.set(entry);
       } else {
-        inserted[orgIndex] = this.add(key, value);
+        inserted[orgIndex] = this.set(key, value);
       }
       _dfs(arr.slice(0, mid));
       _dfs(arr.slice(mid + 1));
@@ -3165,9 +3163,9 @@ var BST = class extends BinaryTree {
         const { key, value, orgIndex } = sorted[m];
         if (this.isRaw(key)) {
           const entry = this._toEntryFn(key);
-          inserted[orgIndex] = this.add(entry);
+          inserted[orgIndex] = this.set(entry);
         } else {
-          inserted[orgIndex] = this.add(key, value);
+          inserted[orgIndex] = this.set(key, value);
         }
         stack.push([m + 1, r]);
         stack.push([l, m - 1]);
@@ -3442,7 +3440,7 @@ var BST = class extends BinaryTree {
     const out = this._createLike([], options);
     let index = 0;
     for (const [key, value] of this) {
-      out.add(callback.call(thisArg, value, key, index++, this));
+      out.set(callback.call(thisArg, value, key, index++, this));
     }
     return out;
   }
@@ -3498,7 +3496,6 @@ var BST = class extends BinaryTree {
    */
   _createDefaultComparator() {
     return (a, b) => {
-      debugger;
       if (isComparable(a) && isComparable(b)) {
         if (a > b) return 1;
         if (a < b) return -1;
@@ -4058,14 +4055,14 @@ var AVLTree = class extends BST {
   }
   /**
    * Creates an instance of AVLTree.
-   * @remarks Time O(N log N) (from `addMany` with balanced add). Space O(N).
+   * @remarks Time O(N log N) (from `setMany` with balanced set). Space O(N).
    *
-   * @param [keysNodesEntriesOrRaws=[]] - An iterable of items to add.
+   * @param [keysNodesEntriesOrRaws=[]] - An iterable of items to set.
    * @param [options] - Configuration options for the AVL tree.
    */
   constructor(keysNodesEntriesOrRaws = [], options) {
     super([], options);
-    if (keysNodesEntriesOrRaws) super.addMany(keysNodesEntriesOrRaws);
+    if (keysNodesEntriesOrRaws) super.setMany(keysNodesEntriesOrRaws);
   }
   /**
    * (Protected) Creates a new AVL tree node.
@@ -4089,16 +4086,16 @@ var AVLTree = class extends BST {
     return keyNodeOrEntry instanceof AVLTreeNode;
   }
   /**
-   * Adds a new node to the AVL tree and balances the tree path.
-   * @remarks Time O(log N) (O(H) for BST add + O(H) for `_balancePath`). Space O(H) for path/recursion.
+   * Sets a new node to the AVL tree and balances the tree path.
+   * @remarks Time O(log N) (O(H) for BST set + O(H) for `_balancePath`). Space O(H) for path/recursion.
    *
-   * @param keyNodeOrEntry - The key, node, or entry to add.
+   * @param keyNodeOrEntry - The key, node, or entry to set.
    * @param [value] - The value, if providing just a key.
    * @returns True if the addition was successful, false otherwise.
    */
-  add(keyNodeOrEntry, value) {
+  set(keyNodeOrEntry, value) {
     if (keyNodeOrEntry === null) return false;
-    const inserted = super.add(keyNodeOrEntry, value);
+    const inserted = super.set(keyNodeOrEntry, value);
     if (inserted) this._balancePath(keyNodeOrEntry);
     return inserted;
   }
@@ -4150,7 +4147,7 @@ var AVLTree = class extends BST {
   }
   /**
    * Creates a new AVLTree by mapping each [key, value] pair.
-   * @remarks Time O(N log N) (O(N) iteration + O(log M) `add` for each item into the new tree). Space O(N) for the new tree.
+   * @remarks Time O(N log N) (O(N) iteration + O(log M) `set` for each item into the new tree). Space O(N) for the new tree.
    *
    * @template MK - New key type.
    * @template MV - New value type.
@@ -4164,7 +4161,7 @@ var AVLTree = class extends BST {
     const out = this._createLike([], options);
     let index = 0;
     for (const [key, value] of this) {
-      out.add(callback.call(thisArg, value, key, index++, this));
+      out.set(callback.call(thisArg, value, key, index++, this));
     }
     return out;
   }