deque-typed 1.53.7 → 1.53.9

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

@@ -113,6 +113,9 @@ class BinaryTree extends base_1.IterableEntryBase {
         return this._toEntryFn;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function creates a new binary tree node with a specified key and optional value.
      * @param {K} key - The `key` parameter is the key of the node being created in the binary tree.
      * @param {V} [value] - The `value` parameter in the `createNode` function is optional, meaning it is
@@ -125,57 +128,22 @@ class BinaryTree extends base_1.IterableEntryBase {
         return new BinaryTreeNode(key, this._isMapMode ? undefined : value);
     }
     /**
-     * The function creates a binary tree with the specified options.
-     * @param [options] - The `options` parameter in the `createTree` function is an optional parameter
-     * that allows you to provide partial configuration options for creating a binary tree. It is of type
-     * `Partial<BinaryTreeOptions<K, V, R>>`, which means you can pass in an object containing a subset
-     * of properties
-     * @returns A new instance of a binary tree with the specified options is being returned.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `createTree` function creates a new binary tree based on the provided options.
+     * @param [options] - The `options` parameter in the `createTree` method is of type
+     * `BinaryTreeOptions<K, V, R>`. This type likely contains configuration options for creating a
+     * binary tree, such as the iteration type, whether the tree is in map mode, and functions for
+     * converting entries.
+     * @returns The `createTree` method is returning an instance of the `BinaryTree` class with the
+     * provided options. The method is creating a new `BinaryTree` object with an empty array as the
+     * initial data, and then setting various options such as `iterationType`, `isMapMode`, and
+     * `toEntryFn` based on the current object's properties and the provided `options`. Finally, it
      */
     createTree(options) {
         return new BinaryTree([], Object.assign({ iterationType: this.iterationType, isMapMode: this._isMapMode, toEntryFn: this._toEntryFn }, options));
     }
-    /**
-     * The function `keyValueNodeEntryRawToNodeAndValue` converts various input types into a node object
-     * or returns null.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The
-     * `keyValueNodeEntryRawToNodeAndValue` function takes in a parameter `keyNodeEntryOrRaw`, which
-     * can be of type `BTNRep<K, V, NODE>` or `R`. This parameter represents either a key, a
-     * node, an entry
-     * @param {V} [value] - The `value` parameter in the `keyValueNodeEntryRawToNodeAndValue` function is
-     * an optional parameter of type `V`. It represents the value associated with the key in the node
-     * being created. If a `value` is provided, it will be used when creating the node. If
-     * @returns The `keyValueNodeEntryRawToNodeAndValue` function returns an optional node
-     * (`OptNodeOrNull<NODE>`) based on the input parameters provided. The function checks the type of the
-     * input parameter (`keyNodeEntryOrRaw`) and processes it accordingly to return a node or null
-     * value.
-     */
-    keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value) {
-        if (keyNodeEntryOrRaw === undefined)
-            return [undefined, undefined];
-        if (keyNodeEntryOrRaw === null)
-            return [null, undefined];
-        if (this.isNode(keyNodeEntryOrRaw))
-            return [keyNodeEntryOrRaw, value];
-        if (this.isEntry(keyNodeEntryOrRaw)) {
-            const [key, entryValue] = keyNodeEntryOrRaw;
-            if (key === undefined)
-                return [undefined, undefined];
-            else if (key === null)
-                return [null, undefined];
-            const finalValue = value !== null && value !== void 0 ? value : entryValue;
-            return [this.createNode(key, finalValue), finalValue];
-        }
-        if (this.isRaw(keyNodeEntryOrRaw)) {
-            const [key, entryValue] = this._toEntryFn(keyNodeEntryOrRaw);
-            const finalValue = value !== null && value !== void 0 ? value : entryValue;
-            if (this.isKey(key))
-                return [this.createNode(key, finalValue), finalValue];
-        }
-        if (this.isKey(keyNodeEntryOrRaw))
-            return [this.createNode(keyNodeEntryOrRaw, value), value];
-        return [undefined, undefined];
-    }
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(log n)
@@ -346,7 +314,7 @@ class BinaryTree extends base_1.IterableEntryBase {
      * key was found and the node was replaced instead of inserted.
      */
     add(keyNodeEntryOrRaw, value) {
-        const [newNode, newValue] = this.keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
+        const [newNode, newValue] = this._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
         if (newNode === undefined)
             return false;
         // If the tree is empty, directly set the new node as the root node
@@ -1499,7 +1467,7 @@ class BinaryTree extends base_1.IterableEntryBase {
         const newTree = this.createTree();
         let index = 0;
         for (const [key, value] of this) {
-            if (predicate.call(thisArg, value, key, index++, this)) {
+            if (predicate.call(thisArg, key, value, index++, this)) {
                 newTree.add([key, value]);
             }
         }
@@ -1509,34 +1477,29 @@ class BinaryTree extends base_1.IterableEntryBase {
      * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
-     * The `map` function iterates over key-value pairs in a tree data structure, applies a callback
-     * function to each value, and returns a new tree with the updated values.
-     * @param callback - The `callback` parameter in the `map` method is a function that will be called
-     * on each entry in the tree. It takes four arguments:
-     * @param {any} [thisArg] - The `thisArg` parameter in the `map` function is an optional parameter
-     * that specifies the value to be passed as `this` when executing the callback function. If provided,
-     * the `thisArg` value will be used as the `this` value within the callback function. If `thisArg
-     * @returns The `map` method is returning a new tree with the entries modified by the provided
-     * callback function. Each entry in the original tree is passed to the callback function, and the
-     * result of the callback function is added to the new tree.
+     * The `map` function in TypeScript creates a new BinaryTree by applying a callback function to each
+     * entry in the original BinaryTree.
+     * @param callback - A function that will be called for each entry in the current binary tree. It
+     * takes the key, value (which can be undefined), and an array containing the mapped key and value as
+     * arguments.
+     * @param [options] - The `options` parameter in the `map` method is of type `BinaryTreeOptions<MK,
+     * MV, MR>`. It is an optional parameter that allows you to specify additional options for the binary
+     * tree being created during the mapping process. These options could include things like custom
+     * comparators, initial
+     * @param {any} [thisArg] - The `thisArg` parameter in the `map` method is used to specify the value
+     * of `this` when executing the `callback` function. It allows you to set the context (value of
+     * `this`) within the callback function. If `thisArg` is provided, it will be passed
+     * @returns The `map` function is returning a new `BinaryTree` instance filled with entries that are
+     * the result of applying the provided `callback` function to each entry in the original tree.
      */
-    map(callback, thisArg) {
-        const newTree = this.createTree();
+    map(callback, options, thisArg) {
+        const newTree = new BinaryTree([], options);
         let index = 0;
         for (const [key, value] of this) {
-            newTree.add([key, callback.call(thisArg, value, key, index++, this)]);
+            newTree.add(callback.call(thisArg, key, value, index++, this));
         }
         return newTree;
     }
-    // // TODO Type error, need to return a TREE<NV> that is a value type only for callback function.
-    // // map<NV>(callback: (entry: [K, V | undefined], tree: this) => NV) {
-    // //   const newTree = this.createTree();
-    // //   for (const [key, value] of this) {
-    // //     newTree.add(key, callback([key, value], this));
-    // //   }
-    // //   return newTree;
-    // // }
-    //
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -1568,7 +1531,7 @@ class BinaryTree extends base_1.IterableEntryBase {
         if (opts.isShowRedBlackNIL)
             output += `S for Sentinel Node(NIL)\n`;
         const display = (root) => {
-            const [lines, , ,] = this._displayAux(root, opts);
+            const [lines, ,] = this._displayAux(root, opts);
             let paragraph = '';
             for (const line of lines) {
                 paragraph += line + '\n';
@@ -1596,6 +1559,47 @@ class BinaryTree extends base_1.IterableEntryBase {
     print(options, startNode = this._root) {
         console.log(this.toVisual(startNode, options));
     }
+    /**
+     * The function `keyValueNodeEntryRawToNodeAndValue` converts various input types into a node object
+     * or returns null.
+     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The
+     * `keyValueNodeEntryRawToNodeAndValue` function takes in a parameter `keyNodeEntryOrRaw`, which
+     * can be of type `BTNRep<K, V, NODE>` or `R`. This parameter represents either a key, a
+     * node, an entry
+     * @param {V} [value] - The `value` parameter in the `keyValueNodeEntryRawToNodeAndValue` function is
+     * an optional parameter of type `V`. It represents the value associated with the key in the node
+     * being created. If a `value` is provided, it will be used when creating the node. If
+     * @returns The `keyValueNodeEntryRawToNodeAndValue` function returns an optional node
+     * (`OptNodeOrNull<NODE>`) based on the input parameters provided. The function checks the type of the
+     * input parameter (`keyNodeEntryOrRaw`) and processes it accordingly to return a node or null
+     * value.
+     */
+    _keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value) {
+        if (keyNodeEntryOrRaw === undefined)
+            return [undefined, undefined];
+        if (keyNodeEntryOrRaw === null)
+            return [null, undefined];
+        if (this.isNode(keyNodeEntryOrRaw))
+            return [keyNodeEntryOrRaw, value];
+        if (this.isEntry(keyNodeEntryOrRaw)) {
+            const [key, entryValue] = keyNodeEntryOrRaw;
+            if (key === undefined)
+                return [undefined, undefined];
+            else if (key === null)
+                return [null, undefined];
+            const finalValue = value !== null && value !== void 0 ? value : entryValue;
+            return [this.createNode(key, finalValue), finalValue];
+        }
+        if (this.isRaw(keyNodeEntryOrRaw)) {
+            const [key, entryValue] = this._toEntryFn(keyNodeEntryOrRaw);
+            const finalValue = value !== null && value !== void 0 ? value : entryValue;
+            if (this.isKey(key))
+                return [this.createNode(key, finalValue), finalValue];
+        }
+        if (this.isKey(keyNodeEntryOrRaw))
+            return [this.createNode(keyNodeEntryOrRaw, value), value];
+        return [undefined, undefined];
+    }
     /**
      * Time complexity: O(n)
      * Space complexity: O(n)

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

@@ -5,7 +5,7 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BSTNested, BSTNodeNested, BSTNOptKeyOrNode, BSTOptions, BTNRep, Comparable, Comparator, CP, DFSOrderPattern, IterationType, NodeCallback, NodePredicate, OptNode } from '../../types';
+import { BSTNodeNested, BSTNOptKeyOrNode, BSTOptions, BTNRep, Comparable, Comparator, CP, DFSOrderPattern, EntryCallback, IterationType, NodeCallback, NodePredicate, OptNode } from '../../types';
 import { BinaryTree, BinaryTreeNode } from './binary-tree';
 import { IBinaryTree } from '../../interfaces';
 import { Range } from '../../common';
@@ -47,32 +47,48 @@ export declare class BSTNode<K = any, V = any, NODE extends BSTNode<K, V, NODE>
  * 6. Balance Variability: Can become unbalanced; special types maintain balance.
  * 7. No Auto-Balancing: Standard BSTs don't automatically balance themselves.
  * @example
- * // Find kth smallest element
- *     // Create a BST with some elements
- *     const bst = new BST<number>([5, 3, 7, 1, 4, 6, 8]);
- *     const sortedKeys = bst.dfs(node => node.key, 'IN');
+ * // 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']
+ *     ]);
  *
- *     // Helper function to find kth smallest
- *     const findKthSmallest = (k: number): number | undefined => {
- *       return sortedKeys[k - 1];
- *     };
+ *     // Merge datasets into a single BinarySearchTree
+ *     const merged = new BST<number, string>(dataset1);
+ *     merged.addMany(dataset2);
+ *     merged.merge(dataset3);
  *
- *     // Assertions
- *     console.log(findKthSmallest(1)); // 1
- *     console.log(findKthSmallest(3)); // 4
- *     console.log(findKthSmallest(7)); // 8
+ *     // 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.search(new Range(4, 12))); // [10, 12, 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(15, 20))); // [15, 18]
+ *     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) {
@@ -82,20 +98,12 @@ export declare class BSTNode<K = any, V = any, NODE extends BSTNode<K, V, NODE>
  *       return undefined;
  *     }
  *
- *     // 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);
- *     };
- *
  *     // 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> {
+export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V, NODE> = BSTNode<K, V, BSTNodeNested<K, V>>> extends BinaryTree<K, V, R, NODE> implements IBinaryTree<K, V, R, NODE> {
     /**
      * This is the constructor function for a Binary Search Tree class in TypeScript.
      * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter is an
@@ -118,6 +126,19 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * @returns The `isReverse` property of the object, which is a boolean value.
      */
     get isReverse(): boolean;
+    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 _specifyComparable?: (key: K) => Comparable;
+    /**
+     * This function returns the value of the `_specifyComparable` property.
+     * @returns The method `specifyComparable()` is being returned, which is a getter method for the
+     * `_specifyComparable` property.
+     */
+    get specifyComparable(): ((key: K) => Comparable) | undefined;
     /**
      * 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
@@ -128,23 +149,17 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      */
     createNode(key: K, value?: V): NODE;
     /**
-     * The function creates a new binary search tree with the specified options.
-     * @param [options] - The `options` parameter is an optional object that allows you to customize the
-     * behavior of the `createTree` method. It accepts a partial `BSTOptions` object, which has the
-     * following properties:
-     * @returns a new instance of the BST class with the provided options.
-     */
-    createTree(options?: BSTOptions<K, V, R>): TREE;
-    /**
-     * The function overrides a method and converts a key, value pair or entry or raw element to a node.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - A variable that can be of
-     * type R or BTNRep<K, V, NODE>. 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.
-     * @returns either a NODE object or undefined.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `createTree` function in TypeScript overrides the default options with the provided options to
+     * create a new Binary Search Tree.
+     * @param [options] - The `options` parameter in the `createTree` method is an optional object that
+     * can contain the following properties:
+     * @returns A new instance of a Binary Search Tree (BST) is being returned with the specified options
+     * and properties inherited from the current instance.
      */
-    keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V): [OptNode<NODE>, V | undefined];
+    createTree(options?: BSTOptions<K, V, R>): BST<K, V, R, BSTNode<K, V, BSTNodeNested<K, V>>>;
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(log n)
@@ -221,7 +236,7 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * @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;
+    merge(anotherTree: this): void;
     /**
      * Time Complexity: O(log n)
      * Space Complexity: O(k + log n)
@@ -251,6 +266,28 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * collected in an array and returned as the output of the method.
      */
     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)
@@ -378,19 +415,17 @@ export declare class BST<K = any, V = any, R = object, NODE extends BSTNode<K, V
      * @returns a boolean value.
      */
     isAVLBalanced(iterationType?: IterationType): boolean;
-    protected _comparator: Comparator<K>;
+    map<MK, MV, MR>(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: BSTOptions<MK, MV, MR>, thisArg?: any): BST<MK, MV, MR, BSTNode<MK, MV, BSTNodeNested<MK, MV>>>;
     /**
-     * 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.
+     * The function overrides a method and converts a key, value pair or entry or raw element to a node.
+     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - A variable that can be of
+     * type R or BTNRep<K, V, NODE>. 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.
+     * @returns either a NODE object or undefined.
      */
-    get extractComparable(): ((key: K) => Comparable) | undefined;
+    protected _keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw: BTNRep<K, V, NODE> | R, value?: V): [OptNode<NODE>, V | undefined];
     /**
      * The function sets the root of a tree-like structure and updates the parent property of the new
      * root.