data-structure-typed 1.40.0-rc → 1.41.0

package/dist/mjs/data-structures/binary-tree/index.d.ts

@@ -0,0 +1,7 @@
+export * from './binary-tree';
+export * from './bst';
+export * from './binary-indexed-tree';
+export * from './segment-tree';
+export * from './avl-tree';
+export * from './rb-tree';
+export * from './tree-multiset';

package/dist/mjs/data-structures/binary-tree/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./binary-tree"), exports);
+__exportStar(require("./bst"), exports);
+__exportStar(require("./binary-indexed-tree"), exports);
+__exportStar(require("./segment-tree"), exports);
+__exportStar(require("./avl-tree"), exports);
+__exportStar(require("./rb-tree"), exports);
+__exportStar(require("./tree-multiset"), exports);

package/dist/mjs/data-structures/binary-tree/rb-tree.d.ts

@@ -0,0 +1,97 @@
+export declare class RBTreeNode {
+    key: number;
+    parent: RBTreeNode;
+    left: RBTreeNode;
+    right: RBTreeNode;
+    color: number;
+    constructor();
+}
+export declare class RedBlackTree {
+    constructor();
+    protected _root: RBTreeNode;
+    get root(): RBTreeNode;
+    protected _NIL: RBTreeNode;
+    get NIL(): RBTreeNode;
+    /**
+     * The `insert` function inserts a new node with a given key into a red-black tree and fixes any
+     * violations of the red-black tree properties.
+     * @param {number} key - The key parameter is a number that represents the value to be inserted into
+     * the RBTree.
+     * @returns The function does not explicitly return anything.
+     */
+    insert(key: number): void;
+    /**
+     * The `delete` function in TypeScript is used to remove a node with a specific key from a red-black
+     * tree.
+     * @param {RBTreeNode} node - The `node` parameter is of type `RBTreeNode` and represents the current
+     * node being processed in the delete operation.
+     * @returns The `delete` function does not return anything. It has a return type of `void`.
+     */
+    delete(key: number): void;
+    /**
+     * The function `getNode` is a recursive depth-first search algorithm that searches for a node with a
+     * given key in a red-black tree.
+     * @param {number} key - The key parameter is a number that represents the value we are searching for
+     * in the RBTree.
+     * @param beginRoot - The `beginRoot` parameter is an optional parameter that represents the starting
+     * point for the search in the binary search tree. If no value is provided for `beginRoot`, it
+     * defaults to the root of the binary search tree (`this.root`).
+     * @returns a RBTreeNode.
+     */
+    getNode(key: number, beginRoot?: RBTreeNode): RBTreeNode;
+    /**
+     * The function returns the leftmost node in a red-black tree.
+     * @param {RBTreeNode} node - The parameter "node" is of type RBTreeNode, which represents a node in
+     * a Red-Black Tree.
+     * @returns The leftmost node in the given RBTreeNode.
+     */
+    getLeftMost(node: RBTreeNode): RBTreeNode;
+    /**
+     * The function returns the rightmost node in a red-black tree.
+     * @param {RBTreeNode} node - The parameter "node" is of type RBTreeNode.
+     * @returns the rightmost node in a red-black tree.
+     */
+    getRightMost(node: RBTreeNode): RBTreeNode;
+    /**
+     * The function returns the successor of a given node in a red-black tree.
+     * @param {RBTreeNode} x - RBTreeNode - The node for which we want to find the successor.
+     * @returns the successor of the given RBTreeNode.
+     */
+    getSuccessor(x: RBTreeNode): RBTreeNode;
+    /**
+     * The function returns the predecessor of a given node in a red-black tree.
+     * @param {RBTreeNode} x - The parameter `x` is of type `RBTreeNode`, which represents a node in a
+     * Red-Black Tree.
+     * @returns the predecessor of the given RBTreeNode 'x'.
+     */
+    getPredecessor(x: RBTreeNode): RBTreeNode;
+    /**
+     * The function performs a left rotation on a red-black tree node.
+     * @param {RBTreeNode} x - The parameter `x` is a RBTreeNode object.
+     */
+    protected _leftRotate(x: RBTreeNode): void;
+    /**
+     * The function performs a right rotation on a red-black tree node.
+     * @param {RBTreeNode} x - x is a RBTreeNode, which represents the node that needs to be right
+     * rotated.
+     */
+    protected _rightRotate(x: RBTreeNode): void;
+    /**
+     * The _fixDelete function is used to rebalance the Red-Black Tree after a node deletion.
+     * @param {RBTreeNode} x - The parameter `x` is of type `RBTreeNode`, which represents a node in a
+     * red-black tree.
+     */
+    protected _fixDelete(x: RBTreeNode): void;
+    /**
+     * The function `_rbTransplant` replaces one node in a red-black tree with another node.
+     * @param {RBTreeNode} u - The parameter "u" represents a RBTreeNode object.
+     * @param {RBTreeNode} v - The parameter "v" is a RBTreeNode object.
+     */
+    protected _rbTransplant(u: RBTreeNode, v: RBTreeNode): void;
+    /**
+     * The `_fixInsert` function is used to fix the red-black tree after an insertion operation.
+     * @param {RBTreeNode} k - The parameter `k` is a RBTreeNode object, which represents a node in a
+     * red-black tree.
+     */
+    protected _fixInsert(k: RBTreeNode): void;
+}

package/dist/mjs/data-structures/binary-tree/rb-tree.js

@@ -0,0 +1,393 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedBlackTree = exports.RBTreeNode = void 0;
+const types_1 = require("../../types");
+class RBTreeNode {
+    key = 0;
+    parent;
+    left;
+    right;
+    color = types_1.RBTNColor.BLACK;
+    constructor() {
+        this.parent = null;
+        this.left = null;
+        this.right = null;
+    }
+}
+exports.RBTreeNode = RBTreeNode;
+class RedBlackTree {
+    constructor() {
+        this._NIL = new RBTreeNode();
+        this.NIL.color = types_1.RBTNColor.BLACK;
+        this.NIL.left = null;
+        this.NIL.right = null;
+        this._root = this.NIL;
+    }
+    _root;
+    get root() {
+        return this._root;
+    }
+    _NIL;
+    get NIL() {
+        return this._NIL;
+    }
+    /**
+     * The `insert` function inserts a new node with a given key into a red-black tree and fixes any
+     * violations of the red-black tree properties.
+     * @param {number} key - The key parameter is a number that represents the value to be inserted into
+     * the RBTree.
+     * @returns The function does not explicitly return anything.
+     */
+    insert(key) {
+        const node = new RBTreeNode();
+        node.parent = null;
+        node.key = key;
+        node.left = this.NIL;
+        node.right = this.NIL;
+        node.color = types_1.RBTNColor.RED;
+        let y = null;
+        let x = this.root;
+        while (x !== this.NIL) {
+            y = x;
+            if (node.key < x.key) {
+                x = x.left;
+            }
+            else {
+                x = x.right;
+            }
+        }
+        node.parent = y;
+        if (y === null) {
+            this._root = node;
+        }
+        else if (node.key < y.key) {
+            y.left = node;
+        }
+        else {
+            y.right = node;
+        }
+        if (node.parent === null) {
+            node.color = types_1.RBTNColor.BLACK;
+            return;
+        }
+        if (node.parent.parent === null) {
+            return;
+        }
+        this._fixInsert(node);
+    }
+    /**
+     * The `delete` function in TypeScript is used to remove a node with a specific key from a red-black
+     * tree.
+     * @param {RBTreeNode} node - The `node` parameter is of type `RBTreeNode` and represents the current
+     * node being processed in the delete operation.
+     * @returns The `delete` function does not return anything. It has a return type of `void`.
+     */
+    delete(key) {
+        const helper = (node) => {
+            let z = this.NIL;
+            let x, y;
+            while (node !== this.NIL) {
+                if (node.key === key) {
+                    z = node;
+                }
+                if (node.key <= key) {
+                    node = node.right;
+                }
+                else {
+                    node = node.left;
+                }
+            }
+            if (z === this.NIL) {
+                console.log("Couldn't find key in the tree");
+                return;
+            }
+            y = z;
+            let yOriginalColor = y.color;
+            if (z.left === this.NIL) {
+                x = z.right;
+                this._rbTransplant(z, z.right);
+            }
+            else if (z.right === this.NIL) {
+                x = z.left;
+                this._rbTransplant(z, z.left);
+            }
+            else {
+                y = this.getLeftMost(z.right);
+                yOriginalColor = y.color;
+                x = y.right;
+                if (y.parent === z) {
+                    x.parent = y;
+                }
+                else {
+                    this._rbTransplant(y, y.right);
+                    y.right = z.right;
+                    y.right.parent = y;
+                }
+                this._rbTransplant(z, y);
+                y.left = z.left;
+                y.left.parent = y;
+                y.color = z.color;
+            }
+            if (yOriginalColor === 0) {
+                this._fixDelete(x);
+            }
+        };
+        helper(this.root);
+    }
+    /**
+     * The function `getNode` is a recursive depth-first search algorithm that searches for a node with a
+     * given key in a red-black tree.
+     * @param {number} key - The key parameter is a number that represents the value we are searching for
+     * in the RBTree.
+     * @param beginRoot - The `beginRoot` parameter is an optional parameter that represents the starting
+     * point for the search in the binary search tree. If no value is provided for `beginRoot`, it
+     * defaults to the root of the binary search tree (`this.root`).
+     * @returns a RBTreeNode.
+     */
+    getNode(key, beginRoot = this.root) {
+        const dfs = (node) => {
+            if (node === this.NIL || key === node.key) {
+                return node;
+            }
+            if (key < node.key) {
+                return dfs(node.left);
+            }
+            return dfs(node.right);
+        };
+        return dfs(beginRoot);
+    }
+    /**
+     * The function returns the leftmost node in a red-black tree.
+     * @param {RBTreeNode} node - The parameter "node" is of type RBTreeNode, which represents a node in
+     * a Red-Black Tree.
+     * @returns The leftmost node in the given RBTreeNode.
+     */
+    getLeftMost(node) {
+        while (node.left !== null && node.left !== this.NIL) {
+            node = node.left;
+        }
+        return node;
+    }
+    /**
+     * The function returns the rightmost node in a red-black tree.
+     * @param {RBTreeNode} node - The parameter "node" is of type RBTreeNode.
+     * @returns the rightmost node in a red-black tree.
+     */
+    getRightMost(node) {
+        while (node.right !== null && node.right !== this.NIL) {
+            node = node.right;
+        }
+        return node;
+    }
+    /**
+     * The function returns the successor of a given node in a red-black tree.
+     * @param {RBTreeNode} x - RBTreeNode - The node for which we want to find the successor.
+     * @returns the successor of the given RBTreeNode.
+     */
+    getSuccessor(x) {
+        if (x.right !== this.NIL) {
+            return this.getLeftMost(x.right);
+        }
+        let y = x.parent;
+        while (y !== this.NIL && y !== null && x === y.right) {
+            x = y;
+            y = y.parent;
+        }
+        return y;
+    }
+    /**
+     * The function returns the predecessor of a given node in a red-black tree.
+     * @param {RBTreeNode} x - The parameter `x` is of type `RBTreeNode`, which represents a node in a
+     * Red-Black Tree.
+     * @returns the predecessor of the given RBTreeNode 'x'.
+     */
+    getPredecessor(x) {
+        if (x.left !== this.NIL) {
+            return this.getRightMost(x.left);
+        }
+        let y = x.parent;
+        while (y !== this.NIL && x === y.left) {
+            x = y;
+            y = y.parent;
+        }
+        return y;
+    }
+    /**
+     * The function performs a left rotation on a red-black tree node.
+     * @param {RBTreeNode} x - The parameter `x` is a RBTreeNode object.
+     */
+    _leftRotate(x) {
+        const y = x.right;
+        x.right = y.left;
+        if (y.left !== this.NIL) {
+            y.left.parent = x;
+        }
+        y.parent = x.parent;
+        if (x.parent === null) {
+            this._root = y;
+        }
+        else if (x === x.parent.left) {
+            x.parent.left = y;
+        }
+        else {
+            x.parent.right = y;
+        }
+        y.left = x;
+        x.parent = y;
+    }
+    /**
+     * The function performs a right rotation on a red-black tree node.
+     * @param {RBTreeNode} x - x is a RBTreeNode, which represents the node that needs to be right
+     * rotated.
+     */
+    _rightRotate(x) {
+        const y = x.left;
+        x.left = y.right;
+        if (y.right !== this.NIL) {
+            y.right.parent = x;
+        }
+        y.parent = x.parent;
+        if (x.parent === null) {
+            this._root = y;
+        }
+        else if (x === x.parent.right) {
+            x.parent.right = y;
+        }
+        else {
+            x.parent.left = y;
+        }
+        y.right = x;
+        x.parent = y;
+    }
+    /**
+     * The _fixDelete function is used to rebalance the Red-Black Tree after a node deletion.
+     * @param {RBTreeNode} x - The parameter `x` is of type `RBTreeNode`, which represents a node in a
+     * red-black tree.
+     */
+    _fixDelete(x) {
+        let s;
+        while (x !== this.root && x.color === 0) {
+            if (x === x.parent.left) {
+                s = x.parent.right;
+                if (s.color === 1) {
+                    s.color = types_1.RBTNColor.BLACK;
+                    x.parent.color = types_1.RBTNColor.RED;
+                    this._leftRotate(x.parent);
+                    s = x.parent.right;
+                }
+                if (s.left.color === 0 && s.right.color === 0) {
+                    s.color = types_1.RBTNColor.RED;
+                    x = x.parent;
+                }
+                else {
+                    if (s.right.color === 0) {
+                        s.left.color = types_1.RBTNColor.BLACK;
+                        s.color = types_1.RBTNColor.RED;
+                        this._rightRotate(s);
+                        s = x.parent.right;
+                    }
+                    s.color = x.parent.color;
+                    x.parent.color = types_1.RBTNColor.BLACK;
+                    s.right.color = types_1.RBTNColor.BLACK;
+                    this._leftRotate(x.parent);
+                    x = this.root;
+                }
+            }
+            else {
+                s = x.parent.left;
+                if (s.color === 1) {
+                    s.color = types_1.RBTNColor.BLACK;
+                    x.parent.color = types_1.RBTNColor.RED;
+                    this._rightRotate(x.parent);
+                    s = x.parent.left;
+                }
+                if (s.right.color === 0 && s.right.color === 0) {
+                    s.color = types_1.RBTNColor.RED;
+                    x = x.parent;
+                }
+                else {
+                    if (s.left.color === 0) {
+                        s.right.color = types_1.RBTNColor.BLACK;
+                        s.color = types_1.RBTNColor.RED;
+                        this._leftRotate(s);
+                        s = x.parent.left;
+                    }
+                    s.color = x.parent.color;
+                    x.parent.color = types_1.RBTNColor.BLACK;
+                    s.left.color = types_1.RBTNColor.BLACK;
+                    this._rightRotate(x.parent);
+                    x = this.root;
+                }
+            }
+        }
+        x.color = types_1.RBTNColor.BLACK;
+    }
+    /**
+     * The function `_rbTransplant` replaces one node in a red-black tree with another node.
+     * @param {RBTreeNode} u - The parameter "u" represents a RBTreeNode object.
+     * @param {RBTreeNode} v - The parameter "v" is a RBTreeNode object.
+     */
+    _rbTransplant(u, v) {
+        if (u.parent === null) {
+            this._root = v;
+        }
+        else if (u === u.parent.left) {
+            u.parent.left = v;
+        }
+        else {
+            u.parent.right = v;
+        }
+        v.parent = u.parent;
+    }
+    /**
+     * The `_fixInsert` function is used to fix the red-black tree after an insertion operation.
+     * @param {RBTreeNode} k - The parameter `k` is a RBTreeNode object, which represents a node in a
+     * red-black tree.
+     */
+    _fixInsert(k) {
+        let u;
+        while (k.parent.color === 1) {
+            if (k.parent === k.parent.parent.right) {
+                u = k.parent.parent.left;
+                if (u.color === 1) {
+                    u.color = types_1.RBTNColor.BLACK;
+                    k.parent.color = types_1.RBTNColor.BLACK;
+                    k.parent.parent.color = types_1.RBTNColor.RED;
+                    k = k.parent.parent;
+                }
+                else {
+                    if (k === k.parent.left) {
+                        k = k.parent;
+                        this._rightRotate(k);
+                    }
+                    k.parent.color = types_1.RBTNColor.BLACK;
+                    k.parent.parent.color = types_1.RBTNColor.RED;
+                    this._leftRotate(k.parent.parent);
+                }
+            }
+            else {
+                u = k.parent.parent.right;
+                if (u.color === 1) {
+                    u.color = types_1.RBTNColor.BLACK;
+                    k.parent.color = types_1.RBTNColor.BLACK;
+                    k.parent.parent.color = types_1.RBTNColor.RED;
+                    k = k.parent.parent;
+                }
+                else {
+                    if (k === k.parent.right) {
+                        k = k.parent;
+                        this._leftRotate(k);
+                    }
+                    k.parent.color = types_1.RBTNColor.BLACK;
+                    k.parent.parent.color = types_1.RBTNColor.RED;
+                    this._rightRotate(k.parent.parent);
+                }
+            }
+            if (k === this.root) {
+                break;
+            }
+        }
+        this.root.color = types_1.RBTNColor.BLACK;
+    }
+}
+exports.RedBlackTree = RedBlackTree;

package/dist/mjs/data-structures/binary-tree/segment-tree.d.ts

@@ -0,0 +1,67 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { SegmentTreeNodeVal } from '../../types';
+export declare class SegmentTreeNode {
+    start: number;
+    end: number;
+    value: SegmentTreeNodeVal | null;
+    sum: number;
+    left: SegmentTreeNode | null;
+    right: SegmentTreeNode | null;
+    constructor(start: number, end: number, sum: number, value?: SegmentTreeNodeVal | null);
+}
+export declare class SegmentTree {
+    /**
+     * The constructor initializes the values, start, end, and root properties of an object.
+     * @param {number[]} values - An array of numbers that will be used to build a binary search tree.
+     * @param {number} [start] - The `start` parameter is the index of the first element in the `values` array that should
+     * be included in the range. If no value is provided for `start`, it defaults to 0, which means the range starts from
+     * the beginning of the array.
+     * @param {number} [end] - The "end" parameter is the index of the last element in the "values" array that should be
+     * included in the range. If not provided, it defaults to the index of the last element in the "values" array.
+     */
+    constructor(values: number[], start?: number, end?: number);
+    protected _values: number[];
+    get values(): number[];
+    protected _start: number;
+    get start(): number;
+    protected _end: number;
+    get end(): number;
+    protected _root: SegmentTreeNode | null;
+    get root(): SegmentTreeNode | null;
+    /**
+     * The build function creates a segment tree by recursively dividing the given range into smaller segments and assigning
+     * the sum of values to each segment.
+     * @param {number} start - The `start` parameter represents the starting index of the segment or range for which we are
+     * building the segment tree.
+     * @param {number} end - The "end" parameter represents the ending index of the segment or range for which we want to
+     * build a segment tree.
+     * @returns a SegmentTreeNode object.
+     */
+    build(start: number, end: number): SegmentTreeNode;
+    /**
+     * The function updates the value of a node in a segment tree and recalculates the sum of its children if they exist.
+     * @param {number} index - The index parameter represents the index of the node in the segment tree that needs to be
+     * updated.
+     * @param {number} sum - The `sum` parameter represents the new value that should be assigned to the `sum` property of
+     * the `SegmentTreeNode` at the specified `index`.
+     * @param {SegmentTreeNodeVal} [value] - The `value` parameter is an optional value that can be assigned to the `value`
+     * property of the `SegmentTreeNode` object. It is not currently used in the code, but you can uncomment the line `//
+     * cur.value = value;` and pass a value for `value` in the
+     * @returns The function does not return anything.
+     */
+    updateNode(index: number, sum: number, value?: SegmentTreeNodeVal): void;
+    /**
+     * The function `querySumByRange` calculates the sum of values within a given range in a segment tree.
+     * @param {number} indexA - The starting index of the range for which you want to calculate the sum.
+     * @param {number} indexB - The parameter `indexB` represents the ending index of the range for which you want to
+     * calculate the sum.
+     * @returns The function `querySumByRange` returns a number.
+     */
+    querySumByRange(indexA: number, indexB: number): number;
+}