priority-queue-typed 1.54.1 → 1.54.3

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

@@ -75,9 +75,9 @@ exports.BSTNode = BSTNode;
  * @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.search(new Range(5, 10))); // [5, 7, 10]
+ *     console.log(bst.rangeSearch([4, 12], node => node.key.toString())); // ['5', '7', '10', '12']
+ *     console.log(bst.search(new Range(4, 12, true, false))); // [5, 7, 10]
  *     console.log(bst.rangeSearch([15, 20])); // [15, 18]
  *     console.log(bst.search(new Range(15, 20, false))); // [18]
  * @example
@@ -111,7 +111,7 @@ class BST extends binary_tree_1.BinaryTree {
      * This TypeScript constructor initializes a binary search tree with optional options and adds
      * elements if provided.
      * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
-     * iterable that can contain elements of type `BTNRep<K, V, BSTNode<K, V>>` or `R`. It is used to
+     * iterable that can contain elements of type `K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  ` or `R`. It is used to
      * initialize the binary search tree with keys, nodes, entries, or raw data.
      * @param [options] - The `options` parameter is an optional object that can contain the following
      * properties:
@@ -195,7 +195,7 @@ class BST extends binary_tree_1.BinaryTree {
      *
      * The function ensures the existence of a node in a data structure and returns it, or undefined if
      * it doesn't exist.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} keyNodeOrEntry - The parameter
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } keyNodeOrEntry - The parameter
      * `keyNodeOrEntry` can accept a value of type `R`, which represents the key, node,
      * entry, or raw element that needs to be ensured in the tree.
      * @param {IterationType} [iterationType=ITERATIVE] - The `iterationType` parameter is an optional
@@ -213,8 +213,8 @@ class BST extends binary_tree_1.BinaryTree {
      * Space Complexity: O(1)
      *
      * The function checks if the input is an instance of the BSTNode class.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} keyNodeOrEntry - The parameter
-     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, BSTNode<K, V>>`.
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  `.
      * @returns a boolean value indicating whether the input parameter `keyNodeOrEntry` is
      * an instance of the `BSTNode` class.
      */
@@ -240,8 +240,8 @@ class BST extends binary_tree_1.BinaryTree {
      * Space Complexity: O(log n)
      *
      * The `add` function in TypeScript adds a new node to a binary search tree based on the key value.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} keyNodeOrEntry - The parameter
-     * `keyNodeOrEntry` can accept a value of type `R` or `BTNRep<K, V, BSTNode<K, V>>`.
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can accept a value of type `R` or `K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  `.
      * @param {V} [value] - The `value` parameter is an optional value that can be associated with the
      * key in the binary search tree. If provided, it will be stored in the node along with the key.
      * @returns a boolean value.
@@ -412,7 +412,7 @@ class BST extends binary_tree_1.BinaryTree {
      *
      * The function `search` in TypeScript overrides the search behavior in a binary tree structure based
      * on specified criteria.
-     * @param {BTNRep<K, V, BSTNode<K, V>> | NodePredicate<BSTNode<K, V>>} keyNodeEntryOrPredicate - The
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined   | NodePredicate<BSTNode<K, V>>} keyNodeEntryOrPredicate - The
      * `keyNodeEntryOrPredicate` 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
@@ -420,9 +420,9 @@ class BST extends binary_tree_1.BinaryTree {
      * 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<BSTNode<K, V>>`. The callback function should accept a node of type `BSTNode<K, V>` as its
+     * extends `NodeCallback<BSTNode<K, V> | null>`. The callback function should accept a node of type `BSTNode<K, V>` as its
      * argument and
-     * @param {BTNRep<K, V, BSTNode<K, V>>} startNode - The `startNode` parameter in the `override search`
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } 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 `
@@ -446,104 +446,54 @@ class BST extends binary_tree_1.BinaryTree {
         const isRange = this.isRange(keyNodeEntryOrPredicate);
         // Set predicate based on parameter type
         if (isRange) {
-            predicate = node => keyNodeEntryOrPredicate.isInRange(node.key, this._comparator);
+            predicate = node => {
+                if (!node)
+                    return false;
+                return keyNodeEntryOrPredicate.isInRange(node.key, this._comparator);
+            };
         }
         else {
             predicate = this._ensurePredicate(keyNodeEntryOrPredicate);
         }
-        const isToLeftByRange = (cur) => {
+        const shouldVisitLeft = (cur) => {
+            if (!cur)
+                return false;
+            if (!this.isRealNode(cur.left))
+                return false;
             if (isRange) {
                 const range = keyNodeEntryOrPredicate;
                 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;
+            if (!isRange && !this._isPredicate(keyNodeEntryOrPredicate)) {
+                const benchmarkKey = this._extractKey(keyNodeEntryOrPredicate);
+                return benchmarkKey !== null && benchmarkKey !== undefined && this._compare(cur.key, benchmarkKey) > 0;
+            }
+            return true;
         };
-        const isToRightByRange = (cur) => {
+        const shouldVisitRight = (cur) => {
+            if (!cur)
+                return false;
+            if (!this.isRealNode(cur.right))
+                return false;
             if (isRange) {
                 const range = keyNodeEntryOrPredicate;
                 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 (predicate(cur)) {
-                    ans.push(callback(cur));
-                    if (onlyOne)
-                        return;
-                }
-                if (!this.isRealNode(cur.left) && !this.isRealNode(cur.right))
-                    return;
-                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(keyNodeEntryOrPredicate)) {
-                    const benchmarkKey = this._extractKey(keyNodeEntryOrPredicate);
-                    if (this.isRealNode(cur.left) &&
-                        benchmarkKey !== null &&
-                        benchmarkKey !== undefined &&
-                        this._compare(cur.key, benchmarkKey) > 0)
-                        dfs(cur.left);
-                    if (this.isRealNode(cur.right) &&
-                        benchmarkKey !== null &&
-                        benchmarkKey !== undefined &&
-                        this._compare(cur.key, benchmarkKey) < 0)
-                        dfs(cur.right);
-                }
-                else {
-                    if (this.isRealNode(cur.left))
-                        dfs(cur.left);
-                    if (this.isRealNode(cur.right))
-                        dfs(cur.right);
-                }
-            };
-            dfs(startNode);
-        }
-        else {
-            const stack = [startNode];
-            while (stack.length > 0) {
-                const cur = stack.pop();
-                if (predicate(cur)) {
-                    ans.push(callback(cur));
-                    if (onlyOne)
-                        return ans;
-                }
-                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(keyNodeEntryOrPredicate)) {
-                    const benchmarkKey = this._extractKey(keyNodeEntryOrPredicate);
-                    if (this.isRealNode(cur.right) &&
-                        benchmarkKey !== null &&
-                        benchmarkKey !== undefined &&
-                        this._compare(cur.key, benchmarkKey) < 0)
-                        stack.push(cur.right);
-                    if (this.isRealNode(cur.left) &&
-                        benchmarkKey !== null &&
-                        benchmarkKey !== undefined &&
-                        this._compare(cur.key, benchmarkKey) > 0)
-                        stack.push(cur.left);
-                }
-                else {
-                    if (this.isRealNode(cur.right))
-                        stack.push(cur.right);
-                    if (this.isRealNode(cur.left))
-                        stack.push(cur.left);
-                }
+            if (!isRange && !this._isPredicate(keyNodeEntryOrPredicate)) {
+                const benchmarkKey = this._extractKey(keyNodeEntryOrPredicate);
+                return benchmarkKey !== null && benchmarkKey !== undefined && this._compare(cur.key, benchmarkKey) < 0;
             }
-        }
-        return ans;
+            return true;
+        };
+        return super._dfs(callback, 'IN', onlyOne, startNode, iterationType, false, shouldVisitLeft, shouldVisitRight, () => true, cur => {
+            if (cur)
+                return predicate(cur);
+            return false;
+        });
     }
     /**
      * Time Complexity: O(log n)
@@ -554,9 +504,9 @@ class BST extends binary_tree_1.BinaryTree {
      * 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<BSTNode<K, V>>`, where `BSTNode<K, V>` is the type of nodes in the
+     * search operation. It is of type `NodeCallback<BSTNode<K, V> | null>`, where `BSTNode<K, V>` is the type of nodes in the
      * data structure.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} startNode - The `startNode` parameter in the `rangeSearch`
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } 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
@@ -575,8 +525,8 @@ class BST extends binary_tree_1.BinaryTree {
      * Space Complexity: O(log n)
      *
      * This function retrieves a node based on a given keyNodeEntryOrPredicate within a binary search tree structure.
-     * @param {BTNRep<K, V, BSTNode<K, V>> | NodePredicate<BSTNode<K, V>>} keyNodeEntryOrPredicate - The `keyNodeEntryOrPredicate`
-     * parameter can be of type `BTNRep<K, V, BSTNode<K, V>>`, `R`, or `NodePredicate<BSTNode<K, V>>`.
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined   | NodePredicate<BSTNode<K, V>>} keyNodeEntryOrPredicate - The `keyNodeEntryOrPredicate`
+     * parameter can be of type `K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  `, `R`, or `NodePredicate<BSTNode<K, V>>`.
      * @param {BSTNOptKeyOrNode<K, BSTNode<K, V>>} startNode - The `startNode` parameter in the `getNode` method
      * is used to specify the starting point for searching nodes in the binary search tree. If no
      * specific starting point is provided, the default value is set to `this._root`, which is the root
@@ -598,24 +548,30 @@ class BST extends binary_tree_1.BinaryTree {
      * Time complexity: O(n)
      * Space complexity: O(n)
      *
-     * The function overrides the depth-first search method and returns an array of the return types of
-     * the callback function.
+     * The function `dfs` in TypeScript overrides the base class method with default parameters and
+     * returns the result of the super class `dfs` method.
      * @param {C} callback - The `callback` parameter is a function that will be called for each node
-     * during the depth-first search traversal. It is an optional parameter and defaults to
-     * `this._DEFAULT_NODE_CALLBACK`. The type `C` represents the type of the callback function.
-     * @param {DFSOrderPattern} [pattern=IN] - The "pattern" parameter in the code snippet refers to the
-     * order in which the Depth-First Search (DFS) algorithm visits the nodes in a tree or graph. It can
-     * take one of the following values:
-     * @param {BTNRep<K, V, BSTNode<K, V>>} startNode - The `startNode` parameter is the starting
-     * point for the depth-first search traversal. It can be either a root node, a key-value pair, or a
-     * node entry. If not specified, the default value is the root of the tree.
-     * @param {IterationType} [iterationType=ITERATIVE] - The `iterationType` parameter specifies the
-     * type of iteration to be used during the Depth-First Search (DFS) traversal. It can have one of the
-     * following values:
-     * @returns The method is returning an array of the return type of the callback function.
+     * visited during the Depth-First Search traversal. It is a generic type `C` that extends the
+     * `NodeCallback` interface for `BSTNode<K, V>`. The default value for `callback` is `this._
+     * @param {DFSOrderPattern} [pattern=IN] - The `pattern` parameter in the `override dfs` method
+     * specifies the order in which the Depth-First Search (DFS) traversal should be performed on the
+     * Binary Search Tree (BST). The possible values for the `pattern` parameter are:
+     * @param {boolean} [onlyOne=false] - The `onlyOne` parameter in the `override dfs` method is a
+     * boolean flag that indicates whether you want to stop the depth-first search traversal after
+     * finding the first matching node or continue searching for all matching nodes. If `onlyOne` is set
+     * to `true`, the traversal will stop after finding
+     * @param {K | BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} startNode -
+     * The `startNode` parameter in the `override dfs` method can be one of the following types:
+     * @param {IterationType} iterationType - The `iterationType` parameter in the `override dfs` method
+     * specifies the type of iteration to be performed during the Depth-First Search (DFS) traversal of a
+     * Binary Search Tree (BST). It is used to determine the order in which nodes are visited during the
+     * traversal. The possible values for `
+     * @returns The `override` function is returning the result of calling the `dfs` method from the
+     * superclass, with the provided arguments `callback`, `pattern`, `onlyOne`, `startNode`, and
+     * `iterationType`. The return type is an array of the return type of the callback function `C`.
      */
-    dfs(callback = this._DEFAULT_NODE_CALLBACK, pattern = 'IN', startNode = this._root, iterationType = this.iterationType) {
-        return super.dfs(callback, pattern, startNode, iterationType);
+    dfs(callback = this._DEFAULT_NODE_CALLBACK, pattern = 'IN', onlyOne = false, startNode = this._root, iterationType = this.iterationType) {
+        return super.dfs(callback, pattern, onlyOne, startNode, iterationType);
     }
     /**
      * Time complexity: O(n)
@@ -626,7 +582,7 @@ class BST extends binary_tree_1.BinaryTree {
      * @param {C} callback - The `callback` parameter is a function that will be called for each node
      * visited during the breadth-first search. It should take a single argument, which is the current
      * node being visited, and it can return a value of any type.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} startNode - The `startNode` parameter is the starting
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } startNode - The `startNode` parameter is the starting
      * point for the breadth-first search. It can be either a root node, a key-value pair, or an entry
      * object. If no value is provided, the default value is the root of the tree.
      * @param {IterationType} iterationType - The `iterationType` parameter is used to specify the type
@@ -644,9 +600,9 @@ class BST extends binary_tree_1.BinaryTree {
      * The function overrides the listLevels method from the superclass and returns an array of arrays
      * containing the results of the callback function applied to each level of the tree.
      * @param {C} callback - The `callback` parameter is a generic type `C` that extends
-     * `NodeCallback<BSTNode<K, V>>`. It represents a callback function that will be called for each node in the
+     * `NodeCallback<BSTNode<K, V> | null>`. It represents a callback function that will be called for each node in the
      * tree during the iteration process.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} startNode - The `startNode` parameter is the starting
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } startNode - The `startNode` parameter is the starting
      * point for listing the levels of the binary tree. It can be either a root node of the tree, a
      * key-value pair representing a node in the tree, or a key representing a node in the tree. If no
      * value is provided, the root of
@@ -670,7 +626,7 @@ class BST extends binary_tree_1.BinaryTree {
      * @param {CP} lesserOrGreater - The `lesserOrGreater` parameter is used to determine whether to
      * traverse nodes that are lesser, greater, or both than the `targetNode`. It accepts the values -1,
      * 0, or 1, where:
-     * @param {BTNRep<K, V, BSTNode<K, V>>} targetNode - The `targetNode` parameter is the node in
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } targetNode - The `targetNode` parameter is the node in
      * the binary tree that you want to start traversing from. It can be specified either by providing
      * the key of the node, the node itself, or an entry containing the key and value of the node. If no
      * `targetNode` is provided,
@@ -741,9 +697,9 @@ class BST extends binary_tree_1.BinaryTree {
                     return;
                 const m = l + Math.floor((r - l) / 2);
                 const midNode = sorted[m];
-                if (this._isMapMode)
+                if (this._isMapMode && midNode !== null)
                     this.add(midNode.key);
-                else
+                else if (midNode !== null)
                     this.add([midNode.key, midNode.value]);
                 buildBalanceBST(l, m - 1);
                 buildBalanceBST(m + 1, r);
@@ -760,9 +716,9 @@ class BST extends binary_tree_1.BinaryTree {
                     if (l <= r) {
                         const m = l + Math.floor((r - l) / 2);
                         const midNode = sorted[m];
-                        if (this._isMapMode)
+                        if (this._isMapMode && midNode !== null)
                             this.add(midNode.key);
-                        else
+                        else if (midNode !== null)
                             this.add([midNode.key, midNode.value]);
                         stack.push([m + 1, r]);
                         stack.push([l, m - 1]);
@@ -875,8 +831,8 @@ class BST extends binary_tree_1.BinaryTree {
      * Space Complexity: O(1)
      *
      * The function overrides a method and converts a key, value pair or entry or raw element to a node.
-     * @param {BTNRep<K, V, BSTNode<K, V>>} keyNodeOrEntry - A variable that can be of
-     * type R or BTNRep<K, V, BSTNode<K, V>>. It represents either a key, a node, an entry, or a raw
+     * @param {K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  } keyNodeOrEntry - A variable that can be of
+     * type R or K |  BSTNode<K, V> | [K | null | undefined, V | undefined] | null | undefined  . It represents either a key, a node, an entry, or a raw
      * element.
      * @param {V} [value] - The `value` parameter is an optional value of type `V`. It represents the
      * value associated with a key in a key-value pair.

package/dist/data-structures/binary-tree/red-black-tree.d.ts

@@ -1,7 +1,8 @@
-import type { BinaryTreeDeleteResult, BTNRep, CRUD, EntryCallback, OptNodeOrNull, RBTNColor, RedBlackTreeOptions } from '../../types';
+import type { BinaryTreeDeleteResult, CRUD, EntryCallback, RBTNColor, RedBlackTreeOptions } from '../../types';
 import { BST, BSTNode } from './bst';
 import { IBinaryTree } from '../../interfaces';
 export declare class RedBlackTreeNode<K = any, V = any> extends BSTNode<K, V> {
+    parent?: RedBlackTreeNode<K, V>;
     /**
      * The constructor initializes a node with a key, value, and color for a Red-Black Tree.
      * @param {K} key - The `key` parameter is a key of type `K` that is used to identify the node in a
@@ -13,24 +14,17 @@ export declare class RedBlackTreeNode<K = any, V = any> extends BSTNode<K, V> {
      * explicitly.
      */
     constructor(key: K, value?: V, color?: RBTNColor);
-    parent?: RedBlackTreeNode<K, V>;
-    _left?: OptNodeOrNull<RedBlackTreeNode<K, V>>;
-    get left(): OptNodeOrNull<RedBlackTreeNode<K, V>>;
-    set left(v: OptNodeOrNull<RedBlackTreeNode<K, V>>);
-    _right?: OptNodeOrNull<RedBlackTreeNode<K, V>>;
-    get right(): OptNodeOrNull<RedBlackTreeNode<K, V>>;
-    set right(v: OptNodeOrNull<RedBlackTreeNode<K, V>>);
+    _left?: RedBlackTreeNode<K, V> | null | undefined;
+    get left(): RedBlackTreeNode<K, V> | null | undefined;
+    set left(v: RedBlackTreeNode<K, V> | null | undefined);
+    _right?: RedBlackTreeNode<K, V> | null | undefined;
+    get right(): RedBlackTreeNode<K, V> | null | undefined;
+    set right(v: RedBlackTreeNode<K, V> | null | undefined);
 }
 /**
  * 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 {
@@ -72,21 +66,21 @@ export declare class RedBlackTreeNode<K = any, V = any> extends BSTNode<K, V> {
  *       [200, 400], // Price range
  *       node => priceIndex.get(node)?.symbol // Extract stock symbols for the result
  *     );
- *     console.log(stocksInRange); // ['GOOGL', 'MSFT', 'META']
+ *     console.log(stocksInRange); // ['GOOGL', 'META', 'MSFT']
  */
 export declare class RedBlackTree<K = any, V = any, R = object, MK = any, MV = any, MR = object> extends BST<K, V, R, MK, MV, MR> implements IBinaryTree<K, V, R, MK, MV, MR> {
     /**
      * This TypeScript constructor initializes a Red-Black Tree with optional keys, nodes, entries, or
      * raw data.
      * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
-     * iterable that can contain either `BTNRep<K, V, RedBlackTreeNode<K, V>>` objects or `R` objects. It
+     * iterable that can contain either `K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined` objects or `R` objects. It
      * is used to initialize the Red-Black Tree with keys, nodes, entries, or
      * @param [options] - The `options` parameter in the constructor is of type `RedBlackTreeOptions<K,
      * V, R>`. It is an optional parameter that allows you to specify additional options for the
      * RedBlackTree class. These options could include configuration settings, behavior customization, or
      * any other parameters that are specific to
      */
-    constructor(keysNodesEntriesOrRaws?: Iterable<BTNRep<K, V, RedBlackTreeNode<K, V>> | R>, options?: RedBlackTreeOptions<K, V, R>);
+    constructor(keysNodesEntriesOrRaws?: Iterable<K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, options?: RedBlackTreeOptions<K, V, R>);
     protected _root: RedBlackTreeNode<K, V> | undefined;
     get root(): RedBlackTreeNode<K, V> | undefined;
     /**
@@ -122,12 +116,12 @@ export declare class RedBlackTree<K = any, V = any, R = object, MK = any, MV = a
      * Space Complexity: O(1)
      *
      * The function checks if the input is an instance of the RedBlackTreeNode class.
-     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The parameter
-     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, RedBlackTreeNode<K, V>>`.
+     * @param {K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined`.
      * @returns a boolean value indicating whether the input parameter `keyNodeOrEntry` is
      * an instance of the `RedBlackTreeNode` class.
      */
-    isNode(keyNodeOrEntry: BTNRep<K, V, RedBlackTreeNode<K, V>>): keyNodeOrEntry is RedBlackTreeNode<K, V>;
+    isNode(keyNodeOrEntry: K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined): keyNodeOrEntry is RedBlackTreeNode<K, V>;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -142,8 +136,8 @@ export declare class RedBlackTree<K = any, V = any, R = object, MK = any, MV = a
      *
      * The function adds a new node to a binary search tree and returns true if the node was successfully
      * added.
-     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The parameter
-     * `keyNodeOrEntry` can accept a value of type `R` or `BTNRep<K, V, RedBlackTreeNode<K, V>>`.
+     * @param {K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can accept a value of type `R` or `K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined`.
      * @param {V} [value] - The `value` parameter is an optional value that you want to associate with
      * the key in the data structure. It represents the value that you want to add or update in the data
      * structure.
@@ -151,14 +145,14 @@ export declare class RedBlackTree<K = any, V = any, R = object, MK = any, MV = a
      * the method returns true. If the node already exists and its value is updated, the method also
      * returns true. If the node cannot be added or updated, the method returns false.
      */
-    add(keyNodeOrEntry: BTNRep<K, V, RedBlackTreeNode<K, V>>, value?: V): boolean;
+    add(keyNodeOrEntry: K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, value?: V): boolean;
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(log n)
      *
      * The function overrides the delete method in a binary tree data structure to remove a node based on
      * a given predicate and maintain the binary search tree properties.
-     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The `keyNodeOrEntry`
+     * @param {K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} keyNodeOrEntry - The `keyNodeOrEntry`
      * parameter in the `override delete` method is used to specify the condition or key based on which a
      * node should be deleted from the binary tree. It can be a key, a node, an entry, or a predicate
      * function that determines which node(s) should be deleted.
@@ -166,7 +160,7 @@ export declare class RedBlackTree<K = any, V = any, R = object, MK = any, MV = a
      * objects. Each object in the array contains information about the deleted node and whether
      * balancing is needed.
      */
-    delete(keyNodeOrEntry: BTNRep<K, V, RedBlackTreeNode<K, V>>): BinaryTreeDeleteResult<RedBlackTreeNode<K, V>>[];
+    delete(keyNodeOrEntry: K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined): BinaryTreeDeleteResult<RedBlackTreeNode<K, V>>[];
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)

package/dist/data-structures/binary-tree/red-black-tree.js

@@ -44,12 +44,6 @@ 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 {
@@ -91,14 +85,14 @@ exports.RedBlackTreeNode = RedBlackTreeNode;
  *       [200, 400], // Price range
  *       node => priceIndex.get(node)?.symbol // Extract stock symbols for the result
  *     );
- *     console.log(stocksInRange); // ['GOOGL', 'MSFT', 'META']
+ *     console.log(stocksInRange); // ['GOOGL', 'META', 'MSFT']
  */
 class RedBlackTree extends bst_1.BST {
     /**
      * This TypeScript constructor initializes a Red-Black Tree with optional keys, nodes, entries, or
      * raw data.
      * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
-     * iterable that can contain either `BTNRep<K, V, RedBlackTreeNode<K, V>>` objects or `R` objects. It
+     * iterable that can contain either `K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined` objects or `R` objects. It
      * is used to initialize the Red-Black Tree with keys, nodes, entries, or
      * @param [options] - The `options` parameter in the constructor is of type `RedBlackTreeOptions<K,
      * V, R>`. It is an optional parameter that allows you to specify additional options for the
@@ -152,8 +146,8 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The function checks if the input is an instance of the RedBlackTreeNode class.
-     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The parameter
-     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, RedBlackTreeNode<K, V>>`.
+     * @param {K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined`.
      * @returns a boolean value indicating whether the input parameter `keyNodeOrEntry` is
      * an instance of the `RedBlackTreeNode` class.
      */
@@ -177,8 +171,8 @@ class RedBlackTree extends bst_1.BST {
      *
      * The function adds a new node to a binary search tree and returns true if the node was successfully
      * added.
-     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The parameter
-     * `keyNodeOrEntry` can accept a value of type `R` or `BTNRep<K, V, RedBlackTreeNode<K, V>>`.
+     * @param {K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can accept a value of type `R` or `K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined`.
      * @param {V} [value] - The `value` parameter is an optional value that you want to associate with
      * the key in the data structure. It represents the value that you want to add or update in the data
      * structure.
@@ -217,7 +211,7 @@ class RedBlackTree extends bst_1.BST {
      *
      * The function overrides the delete method in a binary tree data structure to remove a node based on
      * a given predicate and maintain the binary search tree properties.
-     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The `keyNodeOrEntry`
+     * @param {K | RedBlackTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined} keyNodeOrEntry - The `keyNodeOrEntry`
      * parameter in the `override delete` method is used to specify the condition or key based on which a
      * node should be deleted from the binary tree. It can be a key, a node, an entry, or a predicate
      * function that determines which node(s) should be deleted.