undirected-graph-typed 1.53.6 → 1.53.8

package/dist/data-structures/binary-tree/bst.js

@@ -4,6 +4,7 @@ exports.BST = exports.BSTNode = void 0;
 const binary_tree_1 = require("./binary-tree");
 const queue_1 = require("../queue");
 const utils_1 = require("../../utils");
+const common_1 = require("../../common");
 class BSTNode extends binary_tree_1.BinaryTreeNode {
     constructor(key, value) {
         super(key, value);
@@ -58,6 +59,62 @@ exports.BSTNode = BSTNode;
  * 5. Logarithmic Operations: Ideal operations like insertion, deletion, and searching are O(log n) time-efficient.
  * 6. Balance Variability: Can become unbalanced; special types maintain balance.
  * 7. No Auto-Balancing: Standard BSTs don't automatically balance themselves.
+ * @example
+ * // Merge 3 sorted datasets
+ *     const dataset1 = new BST<number, string>([
+ *       [1, 'A'],
+ *       [7, 'G']
+ *     ]);
+ *     const dataset2 = [
+ *       [2, 'B'],
+ *       [6, 'F']
+ *     ];
+ *     const dataset3 = new BST<number, string>([
+ *       [3, 'C'],
+ *       [5, 'E'],
+ *       [4, 'D']
+ *     ]);
+ *
+ *     // Merge datasets into a single BinarySearchTree
+ *     const merged = new BST<number, string>(dataset1);
+ *     merged.addMany(dataset2);
+ *     merged.merge(dataset3);
+ *
+ *     // Verify merged dataset is in sorted order
+ *     console.log([...merged.values()]); // ['A', 'B', 'C', 'D', 'E', 'F', 'G']
+ * @example
+ * // Find elements in a range
+ *     const bst = new BST<number>([10, 5, 15, 3, 7, 12, 18]);
+ *     console.log(bst.search(new Range(5, 10))); // [10, 5, 7]
+ *     console.log(bst.rangeSearch([4, 12], node => node.key.toString())); // ['10', '12', '5', '7']
+ *     console.log(bst.search(new Range(4, 12, true, false))); // [10, 5, 7]
+ *     console.log(bst.rangeSearch([15, 20])); // [15, 18]
+ *     console.log(bst.search(new Range(15, 20, false))); // [18]
+ * @example
+ * // Find lowest common ancestor
+ *     const bst = new BST<number>([20, 10, 30, 5, 15, 25, 35, 3, 7, 12, 18]);
+ *
+ *     // LCA helper function
+ *     const findLCA = (num1: number, num2: number): number | undefined => {
+ *       const path1 = bst.getPathToRoot(num1);
+ *       const path2 = bst.getPathToRoot(num2);
+ *       // Find the first common ancestor
+ *       return findFirstCommon(path1, path2);
+ *     };
+ *
+ *     function findFirstCommon(arr1: number[], arr2: number[]): number | undefined {
+ *       for (const num of arr1) {
+ *         if (arr2.indexOf(num) !== -1) {
+ *           return num;
+ *         }
+ *       }
+ *       return undefined;
+ *     }
+ *
+ *     // Assertions
+ *     console.log(findLCA(3, 10)); // 7
+ *     console.log(findLCA(5, 35)); // 15
+ *     console.log(findLCA(20, 30)); // 25
  */
 class BST extends binary_tree_1.BinaryTree {
     /**
@@ -71,21 +128,33 @@ class BST extends binary_tree_1.BinaryTree {
     constructor(keysNodesEntriesOrRaws = [], options) {
         super([], options);
         this._root = undefined;
-        this._DEFAULT_COMPARATOR = (a, b) => {
+        this._isReverse = false;
+        this._comparator = (a, b) => {
+            if ((0, utils_1.isComparable)(a) && (0, utils_1.isComparable)(b)) {
+                if (a > b)
+                    return 1;
+                if (a < b)
+                    return -1;
+                return 0;
+            }
+            if (this._extractComparable) {
+                if (this._extractComparable(a) > this._extractComparable(b))
+                    return 1;
+                if (this._extractComparable(a) < this._extractComparable(b))
+                    return -1;
+                return 0;
+            }
             if (typeof a === 'object' || typeof b === 'object') {
-                throw TypeError(`When comparing object types, a custom comparator must be defined in the constructor's options parameter.`);
+                throw TypeError(`When comparing object types, a custom extractComparable must be defined in the constructor's options parameter.`);
             }
-            if (a > b)
-                return 1;
-            if (a < b)
-                return -1;
             return 0;
         };
-        this._comparator = this._DEFAULT_COMPARATOR;
         if (options) {
-            const { comparator } = options;
-            if (comparator)
-                this._comparator = comparator;
+            const { extractComparable, isReverse } = options;
+            if (typeof extractComparable === 'function')
+                this._extractComparable = extractComparable;
+            if (isReverse !== undefined)
+                this._isReverse = isReverse;
         }
         if (keysNodesEntriesOrRaws)
             this.addMany(keysNodesEntriesOrRaws);
@@ -97,6 +166,14 @@ class BST extends binary_tree_1.BinaryTree {
     get root() {
         return this._root;
     }
+    /**
+     * The above function is a getter method in TypeScript that returns the value of the private property
+     * `_isReverse`.
+     * @returns The `isReverse` property of the object, which is a boolean value.
+     */
+    get isReverse() {
+        return this._isReverse;
+    }
     /**
      * The function creates a new BSTNode with the given key and value and returns it.
      * @param {K} key - The key parameter is of type K, which represents the type of the key for the node
@@ -116,7 +193,7 @@ class BST extends binary_tree_1.BinaryTree {
      * @returns a new instance of the BST class with the provided options.
      */
     createTree(options) {
-        return new BST([], Object.assign({ iterationType: this.iterationType, isMapMode: this._isMapMode, comparator: this._comparator, toEntryFn: this._toEntryFn }, options));
+        return new BST([], Object.assign({ iterationType: this.iterationType, isMapMode: this._isMapMode, extractComparable: this._extractComparable, toEntryFn: this._toEntryFn, isReverse: this._isReverse }, options));
     }
     /**
      * The function overrides a method and converts a key, value pair or entry or raw element to a node.
@@ -127,8 +204,8 @@ class BST extends binary_tree_1.BinaryTree {
      * value associated with a key in a key-value pair.
      * @returns either a NODE object or undefined.
      */
-    keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value) {
-        const [node, entryValue] = super.keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
+    _keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value) {
+        const [node, entryValue] = super._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
         if (node === null)
             return [undefined, undefined];
         return [node, value !== null && value !== void 0 ? value : entryValue];
@@ -167,11 +244,11 @@ class BST extends binary_tree_1.BinaryTree {
      * @param {any} key - The `key` parameter is a value that will be checked to determine if it is of
      * type `K`.
      * @returns The `override isKey(key: any): key is K` function is returning a boolean value based on
-     * the result of the `isComparable` function with the condition `this.comparator !==
+     * the result of the `isComparable` function with the condition `this._compare !==
      * this._DEFAULT_COMPARATOR`.
      */
     isKey(key) {
-        return (0, utils_1.isComparable)(key, this.comparator !== this._DEFAULT_COMPARATOR);
+        return (0, utils_1.isComparable)(key, this._extractComparable !== undefined);
     }
     /**
      * Time Complexity: O(log n)
@@ -185,7 +262,7 @@ class BST extends binary_tree_1.BinaryTree {
      * @returns a boolean value.
      */
     add(keyNodeEntryOrRaw, value) {
-        const [newNode, newValue] = this.keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
+        const [newNode, newValue] = this._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
         if (newNode === undefined)
             return false;
         if (this._root === undefined) {
@@ -197,13 +274,13 @@ class BST extends binary_tree_1.BinaryTree {
         }
         let current = this._root;
         while (current !== undefined) {
-            if (this.comparator(current.key, newNode.key) === 0) {
+            if (this._compare(current.key, newNode.key) === 0) {
                 this._replaceNode(current, newNode);
                 if (this._isMapMode)
                     this._setValue(current.key, newValue);
                 return true;
             }
-            else if (this.comparator(current.key, newNode.key) > 0) {
+            else if (this._compare(current.key, newNode.key) > 0) {
                 if (current.left === undefined) {
                     current.left = newNode;
                     if (this._isMapMode)
@@ -290,7 +367,7 @@ class BST extends binary_tree_1.BinaryTree {
                 keyB = b;
             }
             if (keyA !== undefined && keyA !== null && keyB !== undefined && keyB !== null) {
-                return this.comparator(keyA, keyB);
+                return this._compare(keyA, keyB);
             }
             return 0;
         });
@@ -328,30 +405,47 @@ class BST extends binary_tree_1.BinaryTree {
         }
         return inserted;
     }
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
+     * The `merge` function overrides the base class method by adding elements from another
+     * binary search tree.
+     * @param anotherTree - `anotherTree` is an instance of a Binary Search Tree (BST) with key type `K`,
+     * value type `V`, return type `R`, node type `NODE`, and tree type `TREE`.
+     */
+    merge(anotherTree) {
+        this.addMany(anotherTree, [], false);
+    }
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(k + log n)
      *
-     * The function `getNodes` in TypeScript overrides the base class method to retrieve nodes based on a
-     * given keyNodeEntryRawOrPredicate and iteration type.
-     * @param {BTNRep<K, V, NODE> | R | NodePredicate<NODE>} keyNodeEntryRawOrPredicate - The `keyNodeEntryRawOrPredicate`
-     * parameter in the `getNodes` method is used to filter the nodes that will be returned. It can be a
-     * key, a node, an entry, or a custom keyNodeEntryRawOrPredicate function that determines whether a node should be
-     * included in the result.
-     * @param [onlyOne=false] - The `onlyOne` parameter in the `getNodes` method is a boolean flag that
-     * determines whether to return only the first node that matches the keyNodeEntryRawOrPredicate (`true`) or all nodes
-     * that match the keyNodeEntryRawOrPredicate (`false`). If `onlyOne` is set to `true`, the method will stop iterating
-     * and
-     * @param {BTNRep<K, V, NODE> | R} startNode - The `startNode` parameter in the
-     * `getNodes` method is used to specify the starting point for traversing the tree when searching for
-     * nodes that match a given keyNodeEntryRawOrPredicate. It represents the root node of the subtree where the search
-     * should begin. If not explicitly provided, the default value for `begin
-     * @param {IterationType} iterationType - The `iterationType` parameter in the `getNodes` method
-     * specifies the type of iteration to be performed when traversing the nodes of a binary tree. It can
-     * have two possible values:
-     * @returns The `getNodes` method returns an array of nodes that satisfy the given keyNodeEntryRawOrPredicate.
+     * The function `search` in TypeScript overrides the search behavior in a binary tree structure based
+     * on specified criteria.
+     * @param {BTNRep<K, V, NODE> | R | NodePredicate<NODE>} keyNodeEntryRawOrPredicate - The
+     * `keyNodeEntryRawOrPredicate` parameter in the `override search` method can accept one of the
+     * following types:
+     * @param [onlyOne=false] - The `onlyOne` parameter is a boolean flag that determines whether the
+     * search should stop after finding the first matching node. If `onlyOne` is set to `true`, the
+     * search will return as soon as a matching node is found. If `onlyOne` is set to `false`, the
+     * @param {C} callback - The `callback` parameter in the `override search` function is a function
+     * that will be called on each node that matches the search criteria. It is of type `C`, which
+     * extends `NodeCallback<NODE>`. The callback function should accept a node of type `NODE` as its
+     * argument and
+     * @param {BTNRep<K, V, NODE> | R} startNode - The `startNode` parameter in the `override search`
+     * method represents the node from which the search operation will begin. It is the starting point
+     * for searching within the tree data structure. The method ensures that the `startNode` is a valid
+     * node before proceeding with the search operation. If the `
+     * @param {IterationType} iterationType - The `iterationType` parameter in the `override search`
+     * function determines the type of iteration to be used during the search operation. It can have two
+     * possible values:
+     * @returns The `override search` method returns an array of values that match the search criteria
+     * specified by the input parameters. The method performs a search operation on a binary tree
+     * structure based on the provided key, predicate, and other options. The search results are
+     * collected in an array and returned as the output of the method.
      */
-    getNodes(keyNodeEntryRawOrPredicate, onlyOne = false, startNode = this._root, iterationType = this.iterationType) {
+    search(keyNodeEntryRawOrPredicate, onlyOne = false, callback = this._DEFAULT_NODE_CALLBACK, startNode = this._root, iterationType = this.iterationType) {
         if (keyNodeEntryRawOrPredicate === undefined)
             return [];
         if (keyNodeEntryRawOrPredicate === null)
@@ -359,28 +453,60 @@ class BST extends binary_tree_1.BinaryTree {
         startNode = this.ensureNode(startNode);
         if (!startNode)
             return [];
-        const callback = this._ensurePredicate(keyNodeEntryRawOrPredicate);
+        let predicate;
+        const isRange = this.isRange(keyNodeEntryRawOrPredicate);
+        // Set predicate based on parameter type
+        if (isRange) {
+            predicate = node => keyNodeEntryRawOrPredicate.isInRange(node.key, this._comparator);
+        }
+        else {
+            predicate = this._ensurePredicate(keyNodeEntryRawOrPredicate);
+        }
+        const isToLeftByRange = (cur) => {
+            if (isRange) {
+                const range = keyNodeEntryRawOrPredicate;
+                const leftS = this.isReverse ? range.high : range.low;
+                const leftI = this.isReverse ? range.includeHigh : range.includeLow;
+                return (leftI && this._compare(cur.key, leftS) >= 0) || (!leftI && this._compare(cur.key, leftS) > 0);
+            }
+            return false;
+        };
+        const isToRightByRange = (cur) => {
+            if (isRange) {
+                const range = keyNodeEntryRawOrPredicate;
+                const rightS = this.isReverse ? range.low : range.high;
+                const rightI = this.isReverse ? range.includeLow : range.includeLow;
+                return (rightI && this._compare(cur.key, rightS) <= 0) || (!rightI && this._compare(cur.key, rightS) < 0);
+            }
+            return false;
+        };
         const ans = [];
         if (iterationType === 'RECURSIVE') {
             const dfs = (cur) => {
-                if (callback(cur)) {
-                    ans.push(cur);
+                if (predicate(cur)) {
+                    ans.push(callback(cur));
                     if (onlyOne)
                         return;
                 }
                 if (!this.isRealNode(cur.left) && !this.isRealNode(cur.right))
                     return;
-                if (!this._isPredicate(keyNodeEntryRawOrPredicate)) {
-                    const benchmarkKey = this._getKey(keyNodeEntryRawOrPredicate);
+                if (isRange) {
+                    if (this.isRealNode(cur.left) && isToLeftByRange(cur))
+                        dfs(cur.left);
+                    if (this.isRealNode(cur.right) && isToRightByRange(cur))
+                        dfs(cur.right);
+                }
+                else if (!this._isPredicate(keyNodeEntryRawOrPredicate)) {
+                    const benchmarkKey = this._extractKey(keyNodeEntryRawOrPredicate);
                     if (this.isRealNode(cur.left) &&
                         benchmarkKey !== null &&
                         benchmarkKey !== undefined &&
-                        this.comparator(cur.key, benchmarkKey) > 0)
+                        this._compare(cur.key, benchmarkKey) > 0)
                         dfs(cur.left);
                     if (this.isRealNode(cur.right) &&
                         benchmarkKey !== null &&
                         benchmarkKey !== undefined &&
-                        this.comparator(cur.key, benchmarkKey) < 0)
+                        this._compare(cur.key, benchmarkKey) < 0)
                         dfs(cur.right);
                 }
                 else {
@@ -396,22 +522,28 @@ class BST extends binary_tree_1.BinaryTree {
             const stack = [startNode];
             while (stack.length > 0) {
                 const cur = stack.pop();
-                if (callback(cur)) {
-                    ans.push(cur);
+                if (predicate(cur)) {
+                    ans.push(callback(cur));
                     if (onlyOne)
                         return ans;
                 }
-                if (!this._isPredicate(keyNodeEntryRawOrPredicate)) {
-                    const benchmarkKey = this._getKey(keyNodeEntryRawOrPredicate);
+                if (isRange) {
+                    if (this.isRealNode(cur.left) && isToLeftByRange(cur))
+                        stack.push(cur.left);
+                    if (this.isRealNode(cur.right) && isToRightByRange(cur))
+                        stack.push(cur.right);
+                }
+                else if (!this._isPredicate(keyNodeEntryRawOrPredicate)) {
+                    const benchmarkKey = this._extractKey(keyNodeEntryRawOrPredicate);
                     if (this.isRealNode(cur.right) &&
                         benchmarkKey !== null &&
                         benchmarkKey !== undefined &&
-                        this.comparator(cur.key, benchmarkKey) < 0)
+                        this._compare(cur.key, benchmarkKey) < 0)
                         stack.push(cur.right);
                     if (this.isRealNode(cur.left) &&
                         benchmarkKey !== null &&
                         benchmarkKey !== undefined &&
-                        this.comparator(cur.key, benchmarkKey) > 0)
+                        this._compare(cur.key, benchmarkKey) > 0)
                         stack.push(cur.left);
                 }
                 else {
@@ -424,6 +556,31 @@ class BST extends binary_tree_1.BinaryTree {
         }
         return ans;
     }
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(n)
+     *
+     * The `rangeSearch` function searches for nodes within a specified range in a binary search tree.
+     * @param {Range<K> | [K, K]} range - The `range` parameter in the `rangeSearch` function can be
+     * either a `Range` object or an array of two elements representing the range boundaries.
+     * @param {C} callback - The `callback` parameter in the `rangeSearch` function is a callback
+     * function that is used to process each node that is found within the specified range during the
+     * search operation. It is of type `NodeCallback<NODE>`, where `NODE` is the type of nodes in the
+     * data structure.
+     * @param {BTNRep<K, V, NODE> | R} startNode - The `startNode` parameter in the `rangeSearch`
+     * function represents the node from which the search for nodes within the specified range will
+     * begin. It is the starting point for the range search operation.
+     * @param {IterationType} iterationType - The `iterationType` parameter in the `rangeSearch` function
+     * is used to specify the type of iteration to be performed during the search operation. It has a
+     * default value of `this.iterationType`, which suggests that it is likely a property of the class or
+     * object that the `rangeSearch`
+     * @returns The `rangeSearch` function is returning the result of calling the `search` method with
+     * the specified parameters.
+     */
+    rangeSearch(range, callback = this._DEFAULT_NODE_CALLBACK, startNode = this._root, iterationType = this.iterationType) {
+        const searchRange = range instanceof common_1.Range ? range : new common_1.Range(range[0], range[1]);
+        return this.search(searchRange, false, callback, startNode, iterationType);
+    }
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(1)
@@ -448,22 +605,6 @@ class BST extends binary_tree_1.BinaryTree {
         var _a;
         return (_a = this.getNodes(keyNodeEntryRawOrPredicate, true, startNode, iterationType)[0]) !== null && _a !== void 0 ? _a : undefined;
     }
-    /**
-     * Time Complexity: O(log n)
-     * Space Complexity: O(1)
-     *
-     * The function `getNodeByKey` returns a node with a specific key from a tree data structure.
-     * @param {K} key - The key parameter is the value used to search for a specific node in the tree. It
-     * is typically a unique identifier or a value that can be used to determine the position of the node
-     * in the tree structure.
-     * @param {IterationType} [iterationType=ITERATIVE] - The `iterationType` parameter is an optional
-     * parameter that specifies the type of iteration to be used when searching for a node in the tree.
-     * It has a default value of `'ITERATIVE'`.
-     * @returns The method is returning a NODE object or undefined.
-     */
-    getNodeByKey(key, iterationType = this.iterationType) {
-        return this.getNode(key, this._root, iterationType);
-    }
     /**
      * Time complexity: O(n)
      * Space complexity: O(n)
@@ -559,9 +700,10 @@ class BST extends binary_tree_1.BinaryTree {
         const targetKey = targetNodeEnsured.key;
         if (iterationType === 'RECURSIVE') {
             const dfs = (cur) => {
-                const compared = this.comparator(cur.key, targetKey);
+                const compared = this._compare(cur.key, targetKey);
                 if (Math.sign(compared) === lesserOrGreater)
                     ans.push(callback(cur));
+                // TODO here can be optimized to O(log n)
                 if (this.isRealNode(cur.left))
                     dfs(cur.left);
                 if (this.isRealNode(cur.right))
@@ -575,7 +717,7 @@ class BST extends binary_tree_1.BinaryTree {
             while (queue.size > 0) {
                 const cur = queue.shift();
                 if (this.isRealNode(cur)) {
-                    const compared = this.comparator(cur.key, targetKey);
+                    const compared = this._compare(cur.key, targetKey);
                     if (Math.sign(compared) === lesserOrGreater)
                         ans.push(callback(cur));
                     if (this.isRealNode(cur.left))
@@ -705,6 +847,14 @@ class BST extends binary_tree_1.BinaryTree {
     get comparator() {
         return this._comparator;
     }
+    /**
+     * This function returns the value of the `_extractComparable` property.
+     * @returns The method `extractComparable()` is being returned, which is a getter method for the
+     * `_extractComparable` property.
+     */
+    get extractComparable() {
+        return this._extractComparable;
+    }
     /**
      * The function sets the root of a tree-like structure and updates the parent property of the new
      * root.
@@ -716,5 +866,8 @@ class BST extends binary_tree_1.BinaryTree {
         }
         this._root = v;
     }
+    _compare(a, b) {
+        return this._isReverse ? -this._comparator(a, b) : this._comparator(a, b);
+    }
 }
 exports.BST = BST;

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

@@ -3,6 +3,6 @@ export * from './bst';
 export * from './binary-indexed-tree';
 export * from './segment-tree';
 export * from './avl-tree';
-export * from './rb-tree';
+export * from './red-black-tree';
 export * from './avl-tree-multi-map';
 export * from './tree-multi-map';

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

@@ -19,6 +19,6 @@ __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("./red-black-tree"), exports);
 __exportStar(require("./avl-tree-multi-map"), exports);
 __exportStar(require("./tree-multi-map"), exports);

package/dist/data-structures/binary-tree/{rb-tree.d.ts → red-black-tree.d.ts}

@@ -26,6 +26,59 @@ export declare class RedBlackTreeNode<K = any, V = any, NODE extends RedBlackTre
      */
     set color(value: RBTNColor);
 }
+/**
+ * 1. Efficient self-balancing, but not completely balanced. Compared with AVLTree, the addition and deletion efficiency is high but the query efficiency is slightly lower.
+ * 2. It is BST itself. Compared with Heap which is not completely ordered, RedBlackTree is completely ordered.
+ * @example
+ * // Find elements in a range
+ *     const bst = new RedBlackTree<number>([10, 5, 15, 3, 7, 12, 18]);
+ *     console.log(bst.search(new Range(5, 10))); // [5, 10, 7]
+ *     console.log(bst.search(new Range(4, 12))); // [5, 10, 12, 7]
+ *     console.log(bst.search(new Range(15, 20))); // [15, 18]
+ * @example
+ * // using Red-Black Tree as a price-based index for stock data
+ *     // Define the structure of individual stock records
+ *     interface StockRecord {
+ *       price: number; // Stock price (key for indexing)
+ *       symbol: string; // Stock ticker symbol
+ *       volume: number; // Trade volume
+ *     }
+ *
+ *     // Simulate stock market data as it might come from an external feed
+ *     const marketStockData: StockRecord[] = [
+ *       { price: 142.5, symbol: 'AAPL', volume: 1000000 },
+ *       { price: 335.2, symbol: 'MSFT', volume: 800000 },
+ *       { price: 3285.04, symbol: 'AMZN', volume: 500000 },
+ *       { price: 267.98, symbol: 'META', volume: 750000 },
+ *       { price: 234.57, symbol: 'GOOGL', volume: 900000 }
+ *     ];
+ *
+ *     // Extend the stock record type to include metadata for database usage
+ *     type StockTableRecord = StockRecord & { lastUpdated: Date };
+ *
+ *     // Create a Red-Black Tree to index stock records by price
+ *     // Simulates a database index with stock price as the key for quick lookups
+ *     const priceIndex = new RedBlackTree<number, StockTableRecord, StockRecord>(marketStockData, {
+ *       toEntryFn: stockRecord => [
+ *         stockRecord.price, // Use stock price as the key
+ *         {
+ *           ...stockRecord,
+ *           lastUpdated: new Date() // Add a timestamp for when the record was indexed
+ *         }
+ *       ]
+ *     });
+ *
+ *     // Query the stock with the highest price
+ *     const highestPricedStock = priceIndex.getRightMost();
+ *     console.log(priceIndex.get(highestPricedStock)?.symbol); // 'AMZN' // Amazon has the highest price
+ *
+ *     // Query stocks within a specific price range (200 to 400)
+ *     const stocksInRange = priceIndex.rangeSearch(
+ *       [200, 400], // Price range
+ *       node => priceIndex.get(node)?.symbol // Extract stock symbols for the result
+ *     );
+ *     console.log(stocksInRange); // ['GOOGL', 'MSFT', 'META']
+ */
 export declare class RedBlackTree<K = any, V = any, R = object, NODE extends RedBlackTreeNode<K, V, NODE> = RedBlackTreeNode<K, V, RedBlackTreeNodeNested<K, V>>, TREE extends RedBlackTree<K, V, R, NODE, TREE> = RedBlackTree<K, V, R, NODE, RedBlackTreeNested<K, V, R, NODE>>> extends BST<K, V, R, NODE, TREE> implements IBinaryTree<K, V, R, NODE, TREE> {
     /**
      * This is the constructor function for a Red-Black Tree data structure in TypeScript.

package/dist/data-structures/binary-tree/{rb-tree.js → red-black-tree.js}

@@ -34,6 +34,59 @@ class RedBlackTreeNode extends bst_1.BSTNode {
     }
 }
 exports.RedBlackTreeNode = RedBlackTreeNode;
+/**
+ * 1. Efficient self-balancing, but not completely balanced. Compared with AVLTree, the addition and deletion efficiency is high but the query efficiency is slightly lower.
+ * 2. It is BST itself. Compared with Heap which is not completely ordered, RedBlackTree is completely ordered.
+ * @example
+ * // Find elements in a range
+ *     const bst = new RedBlackTree<number>([10, 5, 15, 3, 7, 12, 18]);
+ *     console.log(bst.search(new Range(5, 10))); // [5, 10, 7]
+ *     console.log(bst.search(new Range(4, 12))); // [5, 10, 12, 7]
+ *     console.log(bst.search(new Range(15, 20))); // [15, 18]
+ * @example
+ * // using Red-Black Tree as a price-based index for stock data
+ *     // Define the structure of individual stock records
+ *     interface StockRecord {
+ *       price: number; // Stock price (key for indexing)
+ *       symbol: string; // Stock ticker symbol
+ *       volume: number; // Trade volume
+ *     }
+ *
+ *     // Simulate stock market data as it might come from an external feed
+ *     const marketStockData: StockRecord[] = [
+ *       { price: 142.5, symbol: 'AAPL', volume: 1000000 },
+ *       { price: 335.2, symbol: 'MSFT', volume: 800000 },
+ *       { price: 3285.04, symbol: 'AMZN', volume: 500000 },
+ *       { price: 267.98, symbol: 'META', volume: 750000 },
+ *       { price: 234.57, symbol: 'GOOGL', volume: 900000 }
+ *     ];
+ *
+ *     // Extend the stock record type to include metadata for database usage
+ *     type StockTableRecord = StockRecord & { lastUpdated: Date };
+ *
+ *     // Create a Red-Black Tree to index stock records by price
+ *     // Simulates a database index with stock price as the key for quick lookups
+ *     const priceIndex = new RedBlackTree<number, StockTableRecord, StockRecord>(marketStockData, {
+ *       toEntryFn: stockRecord => [
+ *         stockRecord.price, // Use stock price as the key
+ *         {
+ *           ...stockRecord,
+ *           lastUpdated: new Date() // Add a timestamp for when the record was indexed
+ *         }
+ *       ]
+ *     });
+ *
+ *     // Query the stock with the highest price
+ *     const highestPricedStock = priceIndex.getRightMost();
+ *     console.log(priceIndex.get(highestPricedStock)?.symbol); // 'AMZN' // Amazon has the highest price
+ *
+ *     // Query stocks within a specific price range (200 to 400)
+ *     const stocksInRange = priceIndex.rangeSearch(
+ *       [200, 400], // Price range
+ *       node => priceIndex.get(node)?.symbol // Extract stock symbols for the result
+ *     );
+ *     console.log(stocksInRange); // ['GOOGL', 'MSFT', 'META']
+ */
 class RedBlackTree extends bst_1.BST {
     /**
      * This is the constructor function for a Red-Black Tree data structure in TypeScript.
@@ -83,7 +136,7 @@ class RedBlackTree extends bst_1.BST {
      * @returns a new instance of a RedBlackTree object.
      */
     createTree(options) {
-        return new RedBlackTree([], Object.assign({ iterationType: this.iterationType, isMapMode: this._isMapMode, comparator: this._comparator, toEntryFn: this._toEntryFn }, options));
+        return new RedBlackTree([], Object.assign({ iterationType: this.iterationType, isMapMode: this._isMapMode, extractComparable: this._extractComparable, toEntryFn: this._toEntryFn }, options));
     }
     /**
      * Time Complexity: O(1)
@@ -160,7 +213,7 @@ class RedBlackTree extends bst_1.BST {
      * returns true. If the node cannot be added or updated, the method returns false.
      */
     add(keyNodeEntryOrRaw, value) {
-        const [newNode, newValue] = this.keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
+        const [newNode, newValue] = this._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
         if (!this.isRealNode(newNode))
             return false;
         const insertStatus = this._insert(newNode);
@@ -303,7 +356,7 @@ class RedBlackTree extends bst_1.BST {
         let parent = undefined;
         while (this.isRealNode(current)) {
             parent = current;
-            const compared = this.comparator(node.key, current.key);
+            const compared = this._compare(node.key, current.key);
             if (compared < 0) {
                 current = (_a = current.left) !== null && _a !== void 0 ? _a : this.NIL;
             }

package/dist/data-structures/binary-tree/tree-multi-map.d.ts

@@ -7,7 +7,7 @@
  */
 import type { BinaryTreeDeleteResult, BSTNOptKeyOrNode, BTNRep, IterationType, RBTNColor, TreeMultiMapNested, TreeMultiMapNodeNested, TreeMultiMapOptions } from '../../types';
 import { IBinaryTree } from '../../interfaces';
-import { RedBlackTree, RedBlackTreeNode } from './rb-tree';
+import { RedBlackTree, RedBlackTreeNode } from './red-black-tree';
 export declare class TreeMultiMapNode<K = any, V = any, NODE extends TreeMultiMapNode<K, V, NODE> = TreeMultiMapNodeNested<K, V>> extends RedBlackTreeNode<K, V, NODE> {
     /**
      * The constructor function initializes a Red-Black Tree node with a key, value, count, and color.
@@ -96,7 +96,7 @@ export declare class TreeMultiMap<K = any, V = any, R = object, NODE extends Tre
      * times the key-value pair should be added to the data structure. If not provided, it defaults to 1.
      * @returns either a NODE object or undefined.
      */
-    keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V, count?: number): [NODE | undefined, V | undefined];
+    protected _keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V, count?: number): [NODE | undefined, V | undefined];
     /**
      * The function checks if the input is an instance of the TreeMultiMapNode class.
      * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The parameter