data-structure-typed 1.19.3 → 1.19.4

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

@@ -0,0 +1,297 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import {BST, BSTNode} from './bst';
+import type {AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BinaryTreeNodeId} from '../types';
+import {IAVLTree, IAVLTreeNode} from '../interfaces';
+
+export class AVLTreeNode<T = any, NEIGHBOR extends AVLTreeNode<T, NEIGHBOR> = AVLTreeNodeNested<T>> extends BSTNode<T, NEIGHBOR> implements IAVLTreeNode<T, NEIGHBOR> {
+}
+
+export class AVLTree<N extends AVLTreeNode<N['val'], N> = AVLTreeNode> extends BST<N> implements IAVLTree<N> {
+    /**
+     * This is a constructor function for an AVL tree data structure in TypeScript.
+     * @param {AVLTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
+     * constructor of the AVLTree class. It allows you to customize the behavior of the AVL tree by providing different
+     * options.
+     */
+    constructor(options?: AVLTreeOptions) {
+        super(options);
+    }
+
+    /**
+     * The function creates a new AVL tree node with the given id and value.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is used to uniquely
+     * identify each node in the tree.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the node. It represents the value
+     * that will be stored in the node.
+     * @returns a new AVLTreeNode object with the specified id and value.
+     */
+    override createNode(id: BinaryTreeNodeId, val?: N['val']): N {
+        return new AVLTreeNode<N['val'], N>(id, val) as N;
+    }
+
+    /**
+     * The function overrides the add method of a binary tree node and balances the tree after inserting a new node.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that we want to add.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the node being added. It is of type
+     * `N['val']`, which means it should be of the same type as the `val` property of the nodes in the binary tree.
+     * @returns The method is returning the inserted node, or null or undefined if the insertion was not successful.
+     */
+    override add(id: BinaryTreeNodeId, val?: N['val']): N | null | undefined {
+        const inserted = super.add(id, val);
+        if (inserted) this.balancePath(inserted);
+        return inserted;
+    }
+
+    /**
+     * The function overrides the remove method of the Binary Search Tree class, performs the removal operation, and
+     * then balances the tree if necessary.
+     * @param {BinaryTreeNodeId} id - The `id` parameter represents the identifier of the binary tree node that needs to be
+     * removed from the AVL tree.
+     * @param {boolean} [isUpdateAllLeftSum] - The `isUpdateAllLeftSum` parameter is an optional boolean parameter that
+     * determines whether the left sum of all nodes in the AVL tree should be updated after removing a node. If
+     * `isUpdateAllLeftSum` is set to `true`, the left sum of all nodes will be recalculated.
+     * @returns The method is returning an array of `AVLTreeDeleted<N>` objects.
+     */
+    override remove(id: BinaryTreeNodeId, isUpdateAllLeftSum?: boolean): BinaryTreeDeletedResult<N>[] {
+        const deletedResults = super.remove(id, isUpdateAllLeftSum);
+        for (const {needBalanced} of deletedResults) {
+            if (needBalanced) {
+                this.balancePath(needBalanced);
+            }
+        }
+        return deletedResults;
+    }
+
+    /**
+     * The balance factor of a given AVL tree node is calculated by subtracting the height of its left subtree from the
+     * height of its right subtree.
+     * @param node - The parameter "node" is of type N, which represents a node in an AVL tree.
+     * @returns The balance factor of the given AVL tree node.
+     */
+    balanceFactor(node: N): number {
+        if (!node.right) // node has no right subtree
+            return -node.height;
+        else if (!node.left) // node has no left subtree
+            return +node.height;
+        else
+            return node.right.height - node.left.height;
+    }
+
+    /**
+     * The function updates the height of a node in an AVL tree based on the heights of its left and right subtrees.
+     * @param node - The parameter `node` is an AVLTreeNode object, which represents a node in an AVL tree.
+     */
+    updateHeight(node: N): void {
+        if (!node.left && !node.right) // node is a leaf
+            node.height = 0;
+        else if (!node.left) {
+            // node has no left subtree
+            const rightHeight = node.right ? node.right.height : 0;
+            node.height = 1 + rightHeight;
+        } else if (!node.right) // node has no right subtree
+            node.height = 1 + node.left.height;
+        else
+            node.height = 1 + Math.max(node.right.height, node.left.height);
+    }
+
+    /**
+     * The `balancePath` function balances the AVL tree by performing appropriate rotations based on the balance factor of
+     * each node in the path from the given node to the root.
+     * @param node - The `node` parameter is an AVLTreeNode object, which represents a node in an AVL tree.
+     */
+    balancePath(node: N): void {
+        const path = this.getPathToRoot(node);
+        for (let i = path.length - 1; i >= 0; i--) {
+            const A = path[i];
+            this.updateHeight(A);
+            switch (this.balanceFactor(A)) {
+                case -2:
+                    if (A && A.left) {
+                        if (this.balanceFactor(A.left) <= 0) {
+                            this.balanceLL(A); // Perform LL rotation
+                        } else {
+                            this.balanceLR(A); // Perform LR rotation
+                        }
+                    }
+                    break;
+                case +2:
+                    if (A && A.right) {
+                        if (this.balanceFactor(A.right) >= 0) {
+                            this.balanceRR(A); // Perform RR rotation
+                        } else {
+                            this.balanceRL(A); // Perform RL rotation
+                        }
+                    }
+            }
+        }
+    }
+
+    /**
+     * The `balanceLL` function performs a left-left rotation on an AVL tree to balance it.
+     * @param A - The parameter A is an AVLTreeNode object.
+     */
+    balanceLL(A: N): void {
+        const parentOfA = A.parent;
+        const B = A.left; // A is left-heavy and B is left-heavy
+        A.parent = B;
+        if (B && B.right) {
+            B.right.parent = A;
+        }
+        if (B) B.parent = parentOfA;
+        if (A === this.root) {
+            if (B) this._setRoot(B);
+        } else {
+            if (parentOfA?.left === A) {
+                parentOfA.left = B;
+            } else {
+                if (parentOfA) parentOfA.right = B;
+            }
+        }
+
+        if (B) {
+            A.left = B.right; // Make T2 the left subtree of A
+            B.right = A; // Make A the left child of B
+        }
+        this.updateHeight(A);
+        if (B) this.updateHeight(B);
+    }
+
+    /**
+     * The `balanceLR` function performs a left-right rotation to balance an AVL tree.
+     * @param A - A is an AVLTreeNode object.
+     */
+    balanceLR(A: N): void {
+        const parentOfA = A.parent;
+        const B = A.left; // A is left-heavy
+        let C = null;
+        if (B) {
+            C = B.right;// B is right-heavy
+        }
+        if (A) A.parent = C;
+        if (B) B.parent = C;
+
+        if (C) {
+            if (C.left) {
+                C.left.parent = B;
+            }
+            if (C.right) {
+                C.right.parent = A;
+            }
+            C.parent = parentOfA;
+        }
+
+        if (A === this.root) {
+            if (C) this._setRoot(C);
+        } else {
+            if (parentOfA) {
+                if (parentOfA.left === A) {
+                    parentOfA.left = C;
+                } else {
+                    parentOfA.right = C;
+                }
+            }
+        }
+
+        if (C) {
+            A.left = C.right; // Make T3 the left subtree of A
+            if (B) B.right = C.left; // Make T2 the right subtree of B
+            C.left = B;
+            C.right = A;
+        }
+
+        this.updateHeight(A); // Adjust heights
+        B && this.updateHeight(B);
+        C && this.updateHeight(C);
+    }
+
+    /**
+     * The `balanceRR` function performs a right-right rotation on an AVL tree to balance it.
+     * @param A - The parameter A is an AVLTreeNode object.
+     */
+    balanceRR(A: N): void {
+        const parentOfA = A.parent;
+        const B = A.right; // A is right-heavy and B is right-heavy
+        A.parent = B;
+        if (B) {
+            if (B.left) {
+                B.left.parent = A;
+            }
+            B.parent = parentOfA;
+        }
+
+        if (A === this.root) {
+            if (B) this._setRoot(B);
+        } else {
+            if (parentOfA) {
+                if (parentOfA.left === A) {
+                    parentOfA.left = B;
+                } else {
+                    parentOfA.right = B;
+                }
+            }
+        }
+
+        if (B) {
+            A.right = B.left; // Make T2 the right subtree of A
+            B.left = A;
+        }
+        this.updateHeight(A);
+        B && this.updateHeight(B);
+    }
+
+    /**
+     * The `balanceRL` function performs a right-left rotation to balance an AVL tree.
+     * @param A - A is an AVLTreeNode object.
+     */
+    balanceRL(A: N): void {
+        const parentOfA = A.parent;
+        const B = A.right; // A is right-heavy
+        let C = null;
+        if (B) {
+            C = B.left; // B is left-heavy
+        }
+
+        A.parent = C;
+        if (B) B.parent = C;
+
+        if (C) {
+            if (C.left) {
+                C.left.parent = A;
+            }
+            if (C.right) {
+                C.right.parent = B;
+            }
+            C.parent = parentOfA;
+        }
+
+
+        if (A === this.root) {
+            if (C) this._setRoot(C);
+        } else {
+            if (parentOfA) {
+                if (parentOfA.left === A) {
+                    parentOfA.left = C;
+                } else {
+                    parentOfA.right = C;
+                }
+            }
+        }
+
+        if (C) A.right = C.left; // Make T2 the right subtree of A
+        if (B && C) B.left = C.right; // Make T3 the left subtree of B
+        if (C) C.left = A;
+        if (C) C.right = B;
+
+        this.updateHeight(A); // Adjust heights
+        B && this.updateHeight(B);
+        C && this.updateHeight(C);
+    }
+}
+
+

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

@@ -0,0 +1,3 @@
+export class BTree {
+
+}

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

@@ -0,0 +1,78 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export class BinaryIndexedTree {
+
+    /**
+     * The constructor initializes an array with a specified length and fills it with zeros.
+     * @param {number} n - The parameter `n` represents the size of the array that will be used to store the sum tree. The
+     * sum tree is a binary tree data structure used to efficiently calculate the sum of a range of elements in an array.
+     * The size of the sum tree array is `n + 1` because
+     */
+    constructor(n: number) {
+        this._sumTree = new Array<number>(n + 1).fill(0);
+    }
+
+    private _sumTree: number[];
+
+    get sumTree(): number[] {
+        return this._sumTree;
+    }
+
+    static lowBit(x: number) {
+        return x & (-x);
+    }
+
+    /**
+     * The update function updates the values in a binary indexed tree by adding a delta value to the specified index and
+     * its ancestors.
+     * @param {number} i - The parameter `i` represents the index of the element in the `_sumTree` array that needs to be
+     * updated.
+     * @param {number} delta - The "delta" parameter represents the change in value that needs to be added to the element
+     * at index "i" in the "_sumTree" array.
+     */
+    update(i: number, delta: number) {
+        while (i < this._sumTree.length) {
+            this._sumTree[i] += delta;
+            i += BinaryIndexedTree.lowBit(i);
+        }
+    }
+
+    /**
+     * The function calculates the prefix sum of an array using a binary indexed tree.
+     * @param {number} i - The parameter "i" in the function "getPrefixSum" represents the index of the element in the
+     * array for which we want to calculate the prefix sum.
+     * @returns The function `getPrefixSum` returns the prefix sum of the elements in the binary indexed tree up to index
+     * `i`.
+     */
+    getPrefixSum(i: number) {
+        let sum = 0;
+        while (i > 0) {
+            sum += this._sumTree[i];
+            i -= BinaryIndexedTree.lowBit(i);
+        }
+        return sum;
+    }
+
+    /**
+     * The function `getRangeSum` calculates the sum of a range of numbers in an array.
+     * @param {number} start - The start parameter is the starting index of the range for which we want to calculate the
+     * sum.
+     * @param {number} end - The "end" parameter represents the ending index of the range for which we want to calculate
+     * the sum.
+     * @returns the sum of the elements in the range specified by the start and end indices.
+     */
+    getRangeSum(start: number, end: number): number {
+        if (!(0 <= start && start <= end && end <= this._sumTree.length))
+            throw 'Index out of bounds';
+        return this.getPrefixSum(end) - this.getPrefixSum(start);
+    }
+
+    protected _setSumTree(value: number[]) {
+        this._sumTree = value;
+    }
+}

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

@@ -0,0 +1,40 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+
+import type {BinaryTreeNodeId, BinaryTreeNodeNested, BinaryTreeOptions} from '../types';
+import {AbstractBinaryTree, AbstractBinaryTreeNode} from './abstract-binary-tree';
+import {IBinaryTree, IBinaryTreeNode} from '../interfaces/binary-tree';
+
+export class BinaryTreeNode<T = any, NEIGHBOR extends BinaryTreeNode<T, NEIGHBOR> = BinaryTreeNodeNested<T>> extends AbstractBinaryTreeNode<T, NEIGHBOR> implements IBinaryTreeNode<T, NEIGHBOR> {
+
+}
+
+export class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTreeNode> extends AbstractBinaryTree<N> implements IBinaryTree<N> {
+
+    /**
+     * This is a constructor function for a binary tree class that takes an optional options parameter.
+     * @param {BinaryTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
+     * constructor of the `BinaryTree` class. It allows you to customize the behavior of the binary tree by providing
+     * different configuration options.
+     */
+    constructor(options?: BinaryTreeOptions) {
+        super(options);
+    }
+
+    /**
+     * The function creates a new binary tree node with an optional value.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is of type
+     * `BinaryTreeNodeId`, which represents the unique identifier for each node in the binary tree.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the node. It represents the value
+     * stored in the node.
+     * @returns a new instance of a BinaryTreeNode with the specified id and value.
+     */
+    createNode(id: BinaryTreeNodeId, val?: N['val']): N {
+        return new BinaryTreeNode<N['val'], N>(id, val) as N;
+    }
+}