data-structure-typed 1.40.0-rc → 1.41.0

package/lib/data-structures/binary-tree/avl-tree.d.ts

@@ -1,94 +0,0 @@
-/**
- * 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, BinaryTreeNodeKey } from '../../types';
-import { IAVLTree, IAVLTreeNode } from '../../interfaces';
-export declare class AVLTreeNode<V = any, NEIGHBOR extends AVLTreeNode<V, NEIGHBOR> = AVLTreeNodeNested<V>> extends BSTNode<V, NEIGHBOR> implements IAVLTreeNode<V, NEIGHBOR> {
-    height: number;
-    constructor(key: BinaryTreeNodeKey, val?: V);
-}
-export declare 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);
-    /**
-     * The `swapLocation` function swaps the location of two nodes in a binary tree.
-     * @param {N} srcNode - The source node that you want to swap with the destination node.
-     * @param {N} destNode - The `destNode` parameter represents the destination node where the values from `srcNode` will
-     * be swapped to.
-     * @returns The `destNode` is being returned.
-     */
-    swapLocation(srcNode: N, destNode: N): N;
-    /**
-     * The function creates a new AVL tree node with the given key and value.
-     * @param {BinaryTreeNodeKey} key - The `key` 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 key and value.
-     */
-    createNode(key: BinaryTreeNodeKey, val?: N['val']): N;
-    /**
-     * The function overrides the add method of a binary tree node and balances the tree after inserting a new node.
-     * @param {BinaryTreeNodeKey} key - The `key` 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.
-     */
-    add(key: BinaryTreeNodeKey, val?: N['val']): N | null | undefined;
-    /**
-     * The function overrides the remove method of a binary tree and performs additional operations to balance the tree after
-     * deletion.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter represents the identifier of the binary tree node that needs to be
-     * removed.
-     * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
-     */
-    remove(key: BinaryTreeNodeKey): BinaryTreeDeletedResult<N>[];
-    /**
-     * 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.
-     */
-    protected _balanceFactor(node: N): number;
-    /**
-     * 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.
-     */
-    protected _updateHeight(node: N): void;
-    /**
-     * 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.
-     */
-    protected _balancePath(node: N): void;
-    /**
-     * The `_balanceLL` function performs a left-left rotation on an AVL tree to balance it.
-     * @param A - The parameter A is an AVLTreeNode object.
-     */
-    protected _balanceLL(A: N): void;
-    /**
-     * The `_balanceLR` function performs a left-right rotation to balance an AVL tree.
-     * @param A - A is an AVLTreeNode object.
-     */
-    protected _balanceLR(A: N): void;
-    /**
-     * The `_balanceRR` function performs a right-right rotation on an AVL tree to balance it.
-     * @param A - The parameter A is an AVLTreeNode object.
-     */
-    protected _balanceRR(A: N): void;
-    /**
-     * The `_balanceRL` function performs a right-left rotation to balance an AVL tree.
-     * @param A - A is an AVLTreeNode object.
-     */
-    protected _balanceRL(A: N): void;
-}

package/lib/data-structures/binary-tree/avl-tree.js

@@ -1,330 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-import { BST, BSTNode } from './bst';
-export class AVLTreeNode extends BSTNode {
-    constructor(key, val) {
-        super(key, val);
-        this.height = 0;
-    }
-}
-export class AVLTree extends BST {
-    /**
-     * 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) {
-        super(options);
-    }
-    /**
-     * The `swapLocation` function swaps the location of two nodes in a binary tree.
-     * @param {N} srcNode - The source node that you want to swap with the destination node.
-     * @param {N} destNode - The `destNode` parameter represents the destination node where the values from `srcNode` will
-     * be swapped to.
-     * @returns The `destNode` is being returned.
-     */
-    swapLocation(srcNode, destNode) {
-        const { key, val, height } = destNode;
-        const tempNode = this.createNode(key, val);
-        if (tempNode) {
-            tempNode.height = height;
-            destNode.key = srcNode.key;
-            destNode.val = srcNode.val;
-            destNode.height = srcNode.height;
-            srcNode.key = tempNode.key;
-            srcNode.val = tempNode.val;
-            srcNode.height = tempNode.height;
-        }
-        return destNode;
-    }
-    /**
-     * The function creates a new AVL tree node with the given key and value.
-     * @param {BinaryTreeNodeKey} key - The `key` 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 key and value.
-     */
-    createNode(key, val) {
-        return new AVLTreeNode(key, val);
-    }
-    /**
-     * The function overrides the add method of a binary tree node and balances the tree after inserting a new node.
-     * @param {BinaryTreeNodeKey} key - The `key` 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.
-     */
-    add(key, val) {
-        // TODO support node as a param
-        const inserted = super.add(key, val);
-        if (inserted)
-            this._balancePath(inserted);
-        return inserted;
-    }
-    /**
-     * The function overrides the remove method of a binary tree and performs additional operations to balance the tree after
-     * deletion.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter represents the identifier of the binary tree node that needs to be
-     * removed.
-     * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
-     */
-    remove(key) {
-        const deletedResults = super.remove(key);
-        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) {
-        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) {
-        if (!node.left && !node.right)
-            node.height = 0;
-        else if (!node.left) {
-            const rightHeight = node.right ? node.right.height : 0;
-            node.height = 1 + rightHeight;
-        }
-        else if (!node.right)
-            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) {
-        const path = this.getPathToRoot(node, false); // first O(log n) + O(log n)
-        for (let i = 0; i < path.length; i++) {
-            // second O(log n)
-            const A = path[i];
-            // Update Heights: After inserting a node, backtrack from the insertion point to the root node, updating the height of each node along the way.
-            this._updateHeight(A); // first O(1)
-            // Check Balance: Simultaneously with height updates, check if each node violates the balance property of an AVL tree.
-            // Balance Restoration: If a balance issue is discovered after inserting a node, it requires balance restoration operations. Balance restoration includes four basic cases where rotation operations need to be performed to fix the balance:
-            switch (this._balanceFactor(A) // second O(1)
-            ) {
-                case -2:
-                    if (A && A.left) {
-                        if (this._balanceFactor(A.left) <= 0) {
-                            // second O(1)
-                            // Left Rotation (LL Rotation): When the inserted node is in the left subtree of the left subtree, causing an imbalance.
-                            this._balanceLL(A);
-                        }
-                        else {
-                            // Left-Right Rotation (LR Rotation): When the inserted node is in the right subtree of the left subtree, causing an imbalance.
-                            this._balanceLR(A);
-                        }
-                    }
-                    break;
-                case +2:
-                    if (A && A.right) {
-                        if (this._balanceFactor(A.right) >= 0) {
-                            // Right Rotation (RR Rotation): When the inserted node is in the right subtree of the right subtree, causing an imbalance.
-                            this._balanceRR(A);
-                        }
-                        else {
-                            // Right-Left Rotation (RL Rotation): When the inserted node is in the left subtree of the right subtree, causing an imbalance.
-                            this._balanceRL(A);
-                        }
-                    }
-            }
-            // TODO So far, no sure if this is necessary that Recursive Repair: Once rotation operations are executed, it may cause imbalance issues at higher levels of the tree. Therefore, you need to recursively check and repair imbalance problems upwards until you reach the root node.
-        }
-    }
-    /**
-     * 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) {
-        const parentOfA = A.parent;
-        const B = A.left;
-        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 === null || parentOfA === void 0 ? void 0 : parentOfA.left) === A) {
-                parentOfA.left = B;
-            }
-            else {
-                if (parentOfA)
-                    parentOfA.right = B;
-            }
-        }
-        if (B) {
-            A.left = B.right;
-            B.right = A;
-        }
-        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) {
-        const parentOfA = A.parent;
-        const B = A.left;
-        let C = null;
-        if (B) {
-            C = B.right;
-        }
-        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;
-            if (B)
-                B.right = C.left;
-            C.left = B;
-            C.right = A;
-        }
-        this._updateHeight(A);
-        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) {
-        const parentOfA = A.parent;
-        const B = A.right;
-        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;
-            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) {
-        const parentOfA = A.parent;
-        const B = A.right;
-        let C = null;
-        if (B) {
-            C = B.left;
-        }
-        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;
-        if (B && C)
-            B.left = C.right;
-        if (C)
-            C.left = A;
-        if (C)
-            C.right = B;
-        this._updateHeight(A);
-        B && this._updateHeight(B);
-        C && this._updateHeight(C);
-    }
-}

package/lib/data-structures/binary-tree/b-tree.d.ts

@@ -1,2 +0,0 @@
-export declare class BTree {
-}

package/lib/data-structures/binary-tree/b-tree.js

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

package/lib/data-structures/binary-tree/binary-indexed-tree.d.ts

@@ -1,46 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare 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);
-    private _sumTree;
-    get sumTree(): number[];
-    static lowBit(x: number): number;
-    /**
-     * 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): void;
-    /**
-     * 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): number;
-    /**
-     * 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;
-    protected _setSumTree(value: number[]): void;
-}

package/lib/data-structures/binary-tree/binary-indexed-tree.js

@@ -1,69 +0,0 @@
-/**
- * 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) {
-        this._sumTree = new Array(n + 1).fill(0);
-    }
-    get sumTree() {
-        return this._sumTree;
-    }
-    static lowBit(x) {
-        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, delta) {
-        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) {
-        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, end) {
-        if (!(0 <= start && start <= end && end <= this._sumTree.length))
-            throw 'Index out of bounds';
-        return this.getPrefixSum(end) - this.getPrefixSum(start);
-    }
-    _setSumTree(value) {
-        this._sumTree = value;
-    }
-}

package/lib/data-structures/binary-tree/binary-tree.d.ts

@@ -1,31 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-import type { BinaryTreeNodeKey, BinaryTreeNodeNested, BinaryTreeOptions } from '../../types';
-import { AbstractBinaryTree, AbstractBinaryTreeNode } from './abstract-binary-tree';
-import { IBinaryTree, IBinaryTreeNode } from '../../interfaces';
-export declare class BinaryTreeNode<V = any, NEIGHBOR extends BinaryTreeNode<V, NEIGHBOR> = BinaryTreeNodeNested<V>> extends AbstractBinaryTreeNode<V, NEIGHBOR> implements IBinaryTreeNode<V, NEIGHBOR> {
-    constructor(key: BinaryTreeNodeKey, val?: V);
-}
-export declare 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);
-    /**
-     * The function creates a new binary tree node with an optional value.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter is the identifier for the binary tree node. It is of type
-     * `BinaryTreeNodeKey`, 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 key and value.
-     */
-    createNode(key: BinaryTreeNodeKey, val?: N['val']): N;
-}

package/lib/data-structures/binary-tree/binary-tree.js

@@ -1,35 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-import { AbstractBinaryTree, AbstractBinaryTreeNode } from './abstract-binary-tree';
-export class BinaryTreeNode extends AbstractBinaryTreeNode {
-    constructor(key, val) {
-        super(key, val);
-    }
-}
-export class BinaryTree extends AbstractBinaryTree {
-    /**
-     * 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) {
-        super(options);
-    }
-    /**
-     * The function creates a new binary tree node with an optional value.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter is the identifier for the binary tree node. It is of type
-     * `BinaryTreeNodeKey`, 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 key and value.
-     */
-    createNode(key, val) {
-        return new BinaryTreeNode(key, val);
-    }
-}