data-structure-typed 2.5.3 → 2.6.1

package/src/data-structures/binary-tree/avl-tree.ts

@@ -5,7 +5,6 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-
 import { BST } from './bst';
 import type {
   AVLTreeOptions,
@@ -122,7 +121,7 @@ export class AVLTreeNode<K = any, V = any> {
    *
    * @returns The node's color.
    */
-  /* istanbul ignore next -- inherited field, used by RedBlackTree subclass */  /* istanbul ignore next -- inherited field, not used by AVLTree */
+  /* istanbul ignore next -- inherited field, used by RedBlackTree subclass */ /* istanbul ignore next -- inherited field, not used by AVLTree */
   get color(): RBTNColor {
     return this._color;
   }
@@ -140,6 +139,7 @@ export class AVLTreeNode<K = any, V = any> {
    *
    * @returns The subtree node count.
    */
+
   /* istanbul ignore next -- inherited field, not used by AVLTree */
   get count(): number {
     return this._count;
@@ -160,13 +160,11 @@ export class AVLTreeNode<K = any, V = any> {
     if (!this.parent) {
       return this.left || this.right ? 'ROOT' : 'ISOLATED';
     }
-
     if (this.parent.left === this) {
       return this.left || this.right ? 'ROOT_LEFT' : 'LEFT';
     } else if (this.parent.right === this) {
       return this.left || this.right ? 'ROOT_RIGHT' : 'RIGHT';
     }
-
     /* istanbul ignore next -- defensive: unreachable if tree structure is correct */
     return 'MAL_NODE';
   }
@@ -359,160 +357,12 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    * @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.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Set a key-value pair
- *  const avl = new AVLTree<number, string>();
- *     avl.set(1, 'one');
- *     avl.set(2, 'two');
- *     console.log(avl.get(1)); // 'one';
+   * @example
+   * // Set a key-value pair
+   *  const avl = new AVLTree<number, string>();
+   *     avl.set(1, 'one');
+   *     avl.set(2, 'two');
+   *     console.log(avl.get(1)); // 'one';
    */
   override set(
     keyNodeOrEntry: K | AVLTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined,
@@ -531,129 +381,12 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    *
    * @param keyNodeOrEntry - The node to delete.
    * @returns An array containing deletion results.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Remove nodes and verify structure
- *  const avl = new AVLTree<number>([5, 3, 7, 1, 4, 6, 8]);
- *     avl.delete(3);
- *     console.log(avl.has(3)); // false;
- *     console.log(avl.size); // 6;
+   * @example
+   * // Remove nodes and verify structure
+   *  const avl = new AVLTree<number>([5, 3, 7, 1, 4, 6, 8]);
+   *     avl.delete(3);
+   *     console.log(avl.has(3)); // false;
+   *     console.log(avl.size); // 6;
    */
   override delete(
     keyNodeOrEntry: K | AVLTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined
@@ -675,90 +408,20 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    *
    * @param [iterationType=this.iterationType] - The traversal method for the initial node export.
    * @returns True if successful, false if the tree was empty.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Rebalance the tree
- *  const avl = new AVLTree<number>();
- *     // Insert in sorted order (worst case for BST)
- *     for (let i = 1; i <= 7; i++) avl.add(i);
- *     console.log(avl.isAVLBalanced()); // false;
- *     avl.perfectlyBalance();
- *     console.log(avl.isAVLBalanced()); // true;
+   * @example
+   * // Rebalance the tree
+   *  const avl = new AVLTree<number>();
+   *     // Insert in sorted order (worst case for BST)
+   *     for (let i = 1; i <= 7; i++) avl.add(i);
+   *     console.log(avl.isAVLBalanced()); // false;
+   *     avl.perfectlyBalance();
+   *     console.log(avl.isAVLBalanced()); // true;
    */
   override perfectlyBalance(iterationType: IterationType = this.iterationType): boolean {
     const nodes = this.dfs(node => node, 'IN', false, this._root, iterationType);
     const n = nodes.length;
     if (n === 0) return false;
-
     this._clearNodes();
-
     // Build balanced tree from sorted array
     const build = (l: number, r: number, parent?: AVLTreeNode<K, V>): AVLTreeNode<K, V> | undefined => {
       if (l > r) return undefined;
@@ -767,14 +430,12 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
       root.left = build(l, m - 1, root);
       root.right = build(m + 1, r, root);
       root.parent = parent;
-
       // Update height during the build
       const lh = root.left ? (root.left as AVLTreeNode<K, V>).height : -1;
       const rh = root.right ? (root.right as AVLTreeNode<K, V>).height : -1;
       root.height = Math.max(lh, rh) + 1;
       return root;
     };
-
     const newRoot = build(0, n - 1, undefined);
     this._setRoot(newRoot);
     this._size = n;
@@ -792,117 +453,15 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    * @param [options] - Options for the new AVLTree.
    * @param [thisArg] - `this` context for the callback.
    * @returns A new, mapped AVLTree.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Transform to new tree
- *  const avl = new AVLTree<number, number>([[1, 10], [2, 20], [3, 30]]);
- *     const doubled = avl.map((value, key) => [key, (value ?? 0) * 2] as [number, number]);
- *     console.log([...doubled.values()]); // [20, 40, 60];
+   * @example
+   * // Transform to new tree
+   *  const avl = new AVLTree<number, number>([
+   *       [1, 10],
+   *       [2, 20],
+   *       [3, 30]
+   *     ]);
+   *     const doubled = avl.map((value, key) => [key, (value ?? 0) * 2] as [number, number]);
+   *     console.log([...doubled.values()]); // [20, 40, 60];
    */
   override map<MK = K, MV = V, MR = any>(
     callback: EntryCallback<K, V | undefined, [MK, MV]>,
@@ -910,7 +469,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
     thisArg?: unknown
   ): AVLTree<MK, MV, MR> {
     const out = this._createLike<MK, MV, MR>([], options);
-
     let index = 0;
     // Iterates in-order
     for (const [key, value] of this) {
@@ -970,25 +528,20 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
   ): AVLTreeNode<K, V> | undefined {
     const srcNodeEnsured = this.ensureNode(srcNode);
     const destNodeEnsured = this.ensureNode(destNode);
-
     if (srcNodeEnsured && destNodeEnsured) {
       const { key, value, height } = destNodeEnsured;
       const tempNode = this.createNode(key, value);
-
       if (tempNode) {
         tempNode.height = height;
-
         // Copy src to dest
         destNodeEnsured.key = srcNodeEnsured.key;
         if (!this._isMapMode) destNodeEnsured.value = srcNodeEnsured.value;
         destNodeEnsured.height = srcNodeEnsured.height;
-
         // Copy temp (original dest) to src
         srcNodeEnsured.key = tempNode.key;
         if (!this._isMapMode) srcNodeEnsured.value = tempNode.value;
         srcNodeEnsured.height = tempNode.height;
       }
-
       return destNodeEnsured;
     }
     /* istanbul ignore next -- defensive: srcNode/destNode are always valid when called internally */
@@ -1034,7 +587,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
       B.right.parent = A;
     }
     if (B) B.parent = parentOfA;
-
     // Update parent's child pointer
     if (A === this.root) {
       if (B) this._setRoot(B);
@@ -1045,7 +597,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
         if (parentOfA) parentOfA.right = B;
       }
     }
-
     // Perform rotation
     if (B) {
       A.left = B.right;
@@ -1072,7 +623,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
     }
     if (A && C !== null) A.parent = C;
     if (B && C !== null) B.parent = C;
-
     if (C) {
       if (C.left) {
         if (B !== null) C.left.parent = B;
@@ -1082,7 +632,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
       }
       C.parent = parentOfA;
     }
-
     // Update parent's child pointer
     if (A === this.root) {
       if (C) this._setRoot(C);
@@ -1095,7 +644,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
         }
       }
     }
-
     // Perform rotation
     if (C) {
       A.left = C.right;
@@ -1103,7 +651,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
       C.left = B;
       C.right = A;
     }
-
     this._updateHeight(A);
     if (B) this._updateHeight(B);
     if (C) this._updateHeight(C);
@@ -1128,7 +675,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
       }
       B.parent = parentOfA;
     }
-
     // Update parent's child pointer
     if (A === this.root) {
       if (B) this._setRoot(B);
@@ -1141,7 +687,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
         }
       }
     }
-
     // Perform rotation
     if (B) {
       A.right = B.left;
@@ -1166,10 +711,8 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
     if (B) {
       C = B.left; // The "middle" node
     }
-
     if (C !== null) A.parent = C;
     if (B && C !== null) B.parent = C;
-
     if (C) {
       if (C.left) {
         C.left.parent = A;
@@ -1179,7 +722,6 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
       }
       C.parent = parentOfA;
     }
-
     // Update parent's child pointer
     if (A === this.root) {
       if (C) this._setRoot(C);
@@ -1192,13 +734,11 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
         }
       }
     }
-
     // Perform rotation
     if (C) A.right = C.left;
     if (B && C) B.left = C.right;
     if (C) C.left = A;
     if (C) C.right = B;
-
     this._updateHeight(A);
     if (B) this._updateHeight(B);
     if (C) this._updateHeight(C);
@@ -1217,14 +757,12 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
     // Get the path from the node to the root.
     node = this.ensureNode(node);
     const path = this.getPathToRoot(node, node => node, false);
-
     // Iterate up the path (from node to root)
     for (let i = 0; i < path.length; i++) {
       const A = path[i];
       if (A) {
         this._updateHeight(A);
         this._updateCount(A);
-
         // Check the balance factor
         switch (this._balanceFactor(A)) {
           case -2: // Left-heavy