graph-typed 1.53.6 → 1.53.8

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

@@ -5,9 +5,10 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BSTNested, BSTNodeNested, BSTNOptKeyOrNode, BSTOptions, BTNRep, Comparator, CP, DFSOrderPattern, IterationType, NodeCallback, NodePredicate, OptNode } from '../../types';
+import type { BSTNested, BSTNodeNested, BSTNOptKeyOrNode, BSTOptions, BTNRep, Comparable, Comparator, CP, DFSOrderPattern, IterationType, NodeCallback, NodePredicate, OptNode } from '../../types';
 import { BinaryTree, BinaryTreeNode } from './binary-tree';
 import { IBinaryTree } from '../../interfaces';
+import { Range } from '../../common';
 export declare class BSTNode<K = any, V = any, NODE extends BSTNode<K, V, NODE> = BSTNodeNested<K, V>> extends BinaryTreeNode<K, V, NODE> {
     parent?: NODE;
     constructor(key: K, value?: V);
@@ -45,6 +46,62 @@ export declare class BSTNode<K = any, V = any, NODE extends BSTNode<K, V, NODE>
  * 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
  */
 export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V, NODE> = BSTNode<K, V, BSTNodeNested<K, V>>, TREE extends BST<K, V, R, NODE, TREE> = BST<K, V, R, NODE, BSTNested<K, V, R, NODE>>> extends BinaryTree<K, V, R, NODE, TREE> implements IBinaryTree<K, V, R, NODE, TREE> {
     /**
@@ -62,6 +119,13 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * @returns The `_root` property of the object, which is of type `NODE` or `undefined`.
      */
     get root(): OptNode<NODE>;
+    protected _isReverse: boolean;
+    /**
+     * 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(): boolean;
     /**
      * 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
@@ -88,7 +152,7 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * value associated with a key in a key-value pair.
      * @returns either a NODE object or undefined.
      */
-    keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V): [OptNode<NODE>, V | undefined];
+    protected _keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V): [OptNode<NODE>, V | undefined];
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(log n)
@@ -118,7 +182,7 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * @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: any): key is K;
@@ -156,30 +220,67 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * successfully inserted into the data structure.
      */
     addMany(keysNodesEntriesOrRaws: Iterable<R | BTNRep<K, V, NODE>>, values?: Iterable<V | undefined>, isBalanceAdd?: boolean, iterationType?: IterationType): boolean[];
+    /**
+     * 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: BST<K, V, R, NODE, TREE>): void;
     /**
      * 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: BTNRep<K, V, NODE> | R | NodePredicate<NODE>, onlyOne?: boolean, startNode?: BTNRep<K, V, NODE> | R, iterationType?: IterationType): NODE[];
+    search<C extends NodeCallback<NODE>>(keyNodeEntryRawOrPredicate: BTNRep<K, V, NODE> | R | NodePredicate<NODE> | Range<K>, onlyOne?: boolean, callback?: C, startNode?: BTNRep<K, V, NODE> | R, iterationType?: IterationType): ReturnType<C>[];
+    /**
+     * 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<C extends NodeCallback<NODE>>(range: Range<K> | [K, K], callback?: C, startNode?: BTNRep<K, V, NODE> | R, iterationType?: IterationType): ReturnType<C>[];
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(1)
@@ -201,20 +302,6 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * returns the first node found or `undefined` if no node is found.
      */
     getNode(keyNodeEntryRawOrPredicate: BTNRep<K, V, NODE> | R | NodePredicate<NODE>, startNode?: R | BSTNOptKeyOrNode<K, NODE>, iterationType?: IterationType): OptNode<NODE>;
-    /**
-     * 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: K, iterationType?: IterationType): OptNode<NODE>;
     /**
      * Time complexity: O(n)
      * Space complexity: O(n)
@@ -321,17 +408,24 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * @returns a boolean value.
      */
     isAVLBalanced(iterationType?: IterationType): boolean;
-    protected _DEFAULT_COMPARATOR: (a: K, b: K) => number;
     protected _comparator: Comparator<K>;
     /**
      * The function returns the value of the _comparator property.
      * @returns The `_comparator` property is being returned.
      */
     get comparator(): Comparator<K>;
+    protected _extractComparable?: (key: K) => Comparable;
+    /**
+     * 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(): ((key: K) => Comparable) | undefined;
     /**
      * The function sets the root of a tree-like structure and updates the parent property of the new
      * root.
      * @param {OptNode<NODE>} v - v is a parameter of type NODE or undefined.
      */
     protected _setRoot(v: OptNode<NODE>): void;
+    protected _compare(a: K, b: K): number;
 }