min-heap-typed 1.39.1 → 1.39.3

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

@@ -19,7 +19,7 @@ const queue_1 = require("../queue");
 class BinaryTreeNode {
     /**
      * Creates a new instance of BinaryTreeNode.
-     * @param {BinaryTreeNodeKey} key - The key associated with the node.
+     * @param {BTNKey} key - The key associated with the node.
      * @param {V} val - The value stored in the node.
      */
     constructor(key, val) {
@@ -130,7 +130,7 @@ class BinaryTree {
     }
     /**
      * Creates a new instance of BinaryTreeNode with the given key and value.
-     * @param {BinaryTreeNodeKey} key - The key for the new node.
+     * @param {BTNKey} key - The key for the new node.
      * @param {V} val - The value for the new node.
      * @returns {N} - The newly created BinaryTreeNode.
      */
@@ -153,7 +153,7 @@ class BinaryTree {
     }
     /**
      * Add a node with the given key and value to the binary tree.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The key or node to add to the binary tree.
+     * @param {BTNKey | N | null} keyOrNode - The key or node to add to the binary tree.
      * @param {V} val - The value for the new node (optional).
      * @returns {N | null | undefined} - The inserted node, or null if nothing was inserted, or undefined if the operation failed.
      */
@@ -217,7 +217,7 @@ class BinaryTree {
     /**
      * The `addMany` function takes an array of binary tree node IDs or nodes, and optionally an array of corresponding data
      * values, and adds them to the binary tree.
-     * @param {(BinaryTreeNodeKey | null)[] | (N | null)[]} keysOrNodes - An array of BinaryTreeNodeKey or BinaryTreeNode
+     * @param {(BTNKey | null)[] | (N | null)[]} keysOrNodes - An array of BTNKey or BinaryTreeNode
      * objects, or null values.
      * @param {V[]} [values] - The `values` parameter is an optional array of values (`V[]`) that corresponds to
      * the nodes or node IDs being added. It is used to set the value of each node being added. If `values` is not provided,
@@ -239,8 +239,8 @@ class BinaryTree {
     }
     /**
      * The `refill` function clears the binary tree and adds multiple nodes with the given IDs or nodes and optional data.
-     * @param {(BinaryTreeNodeKey | N)[]} keysOrNodes - The `keysOrNodes` parameter is an array that can contain either
-     * `BinaryTreeNodeKey` or `N` values.
+     * @param {(BTNKey | N)[]} keysOrNodes - The `keysOrNodes` parameter is an array that can contain either
+     * `BTNKey` or `N` values.
      * @param {N[] | Array<V>} [data] - The `data` parameter is an optional array of values that will be assigned to
      * the nodes being added. If provided, the length of the `data` array should be equal to the length of the `keysOrNodes`
      * array. Each value in the `data` array will be assigned to the
@@ -253,11 +253,11 @@ class BinaryTree {
     /**
      * The `delete` function removes a node from a binary search tree and returns the deleted node along
      * with the parent node that needs to be balanced.
-     * a key (`BinaryTreeNodeKey`). If it is a key, the function will find the corresponding node in the
+     * a key (`BTNKey`). If it is a key, the function will find the corresponding node in the
      * binary tree.
      * @returns an array of `BinaryTreeDeletedResult<N>` objects.
      * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
      * searching for. It can be a specific key value or any other property of the node.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `identifier` parameter to determine if the node should be
@@ -312,10 +312,10 @@ class BinaryTree {
     /**
      * The function `getDepth` calculates the depth of a given node in a binary tree relative to a
      * specified root node.
-     * @param {BinaryTreeNodeKey | N | null} distNode - The `distNode` parameter represents the node
+     * @param {BTNKey | N | null} distNode - The `distNode` parameter represents the node
      * whose depth we want to find in the binary tree. It can be either a node object (`N`), a key value
-     * of the node (`BinaryTreeNodeKey`), or `null`.
-     * @param {BinaryTreeNodeKey | N | null} beginRoot - The `beginRoot` parameter represents the
+     * of the node (`BTNKey`), or `null`.
+     * @param {BTNKey | N | null} beginRoot - The `beginRoot` parameter represents the
      * starting node from which we want to calculate the depth. It can be either a node object or the key
      * of a node in the binary tree. If no value is provided for `beginRoot`, it defaults to the root
      * node of the binary tree.
@@ -339,9 +339,9 @@ class BinaryTree {
     /**
      * The `getHeight` function calculates the maximum height of a binary tree using either recursive or
      * iterative approach.
-     * @param {BinaryTreeNodeKey | N | null} beginRoot - The `beginRoot` parameter represents the
+     * @param {BTNKey | N | null} beginRoot - The `beginRoot` parameter represents the
      * starting node from which the height of the binary tree is calculated. It can be either a node
-     * object (`N`), a key value of a node in the tree (`BinaryTreeNodeKey`), or `null` if no starting
+     * object (`N`), a key value of a node in the tree (`BTNKey`), or `null` if no starting
      * node is specified. If `
      * @param iterationType - The `iterationType` parameter is used to determine whether to calculate the
      * height of the binary tree using a recursive approach or an iterative approach. It can have two
@@ -450,7 +450,7 @@ class BinaryTree {
      * The function `getNodes` returns an array of nodes that match a given node property, using either
      * recursive or iterative traversal.
      * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
      * searching for. It can be a specific key value or any other property of the node.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `identifier` parameter to determine if the node should be
@@ -506,8 +506,8 @@ class BinaryTree {
     }
     /**
      * The function checks if a binary tree has a node with a given property or key.
-     * @param {BinaryTreeNodeKey | N} identifier - The `identifier` parameter is the key or value of
-     * the node that you want to find in the binary tree. It can be either a `BinaryTreeNodeKey` or a
+     * @param {BTNKey | N} identifier - The `identifier` parameter is the key or value of
+     * the node that you want to find in the binary tree. It can be either a `BTNKey` or a
      * generic type `N`.
      * @param callback - The `callback` parameter is a function that is used to determine whether a node
      * matches the desired criteria. It takes a node as input and returns a boolean value indicating
@@ -529,8 +529,8 @@ class BinaryTree {
     }
     /**
      * The function `get` returns the first node in a binary tree that matches the given property or key.
-     * @param {BinaryTreeNodeKey | N} identifier - The `identifier` parameter is the key or value of
-     * the node that you want to find in the binary tree. It can be either a `BinaryTreeNodeKey` or `N`
+     * @param {BTNKey | N} identifier - The `identifier` parameter is the key or value of
+     * the node that you want to find in the binary tree. It can be either a `BTNKey` or `N`
      * type.
      * @param callback - The `callback` parameter is a function that is used to determine whether a node
      * matches the desired criteria. It takes a node as input and returns a boolean value indicating
@@ -574,9 +574,9 @@ class BinaryTree {
     /**
      * The function `getLeftMost` returns the leftmost node in a binary tree, either using recursive or
      * iterative traversal.
-     * @param {BinaryTreeNodeKey | N | null} beginRoot - The `beginRoot` parameter is the starting point
+     * @param {BTNKey | N | null} beginRoot - The `beginRoot` parameter is the starting point
      * for finding the leftmost node in a binary tree. It can be either a node object (`N`), a key value
-     * of a node (`BinaryTreeNodeKey`), or `null` if the tree is empty.
+     * of a node (`BTNKey`), or `null` if the tree is empty.
      * @param iterationType - The `iterationType` parameter is used to determine the type of iteration to
      * be performed when finding the leftmost node in a binary tree. It can have two possible values:
      * @returns The function `getLeftMost` returns the leftmost node (`N`) in a binary tree. If there is
@@ -698,12 +698,12 @@ class BinaryTree {
      * subtree traversal. It takes a single argument, which is the current node being traversed, and
      * returns a value. The return values from each callback invocation will be collected and returned as
      * an array.
-     * @param {BinaryTreeNodeKey | N | null} beginRoot - The `beginRoot` parameter is the starting point
+     * @param {BTNKey | N | null} beginRoot - The `beginRoot` parameter is the starting point
      * for traversing the subtree. It can be either a node object, a key value of a node, or `null` to
      * start from the root of the tree.
      * @param iterationType - The `iterationType` parameter determines the type of traversal to be
      * performed on the binary tree. It can have two possible values:
-     * @returns The function `subTreeTraverse` returns an array of `ReturnType<OneParamCallback<N>>`.
+     * @returns The function `subTreeTraverse` returns an array of `ReturnType<BTNCallback<N>>`.
      */
     subTreeTraverse(callback = this._defaultCallbackByKey, beginRoot = this.root, iterationType = this.iterationType) {
         if (typeof beginRoot === 'number')
@@ -743,7 +743,7 @@ class BinaryTree {
      * is `null`, an empty array will be returned.
      * @param {IterationType} iterationType - The `iterationType` parameter determines the type of
      * iteration used in the depth-first search algorithm. It can have two possible values:
-     * @returns The function `dfs` returns an array of `ReturnType<OneParamCallback<N>>` values.
+     * @returns The function `dfs` returns an array of `ReturnType<BTNCallback<N>>` values.
      */
     dfs(callback = this._defaultCallbackByKey, pattern = 'in', beginRoot = this.root, iterationType = types_1.IterationType.ITERATIVE) {
         if (!beginRoot)
@@ -820,13 +820,13 @@ class BinaryTree {
      * function on each node.
      * @param callback - The `callback` parameter is a function that will be called for each node in the
      * breadth-first search. It takes a node of type `N` as its argument and returns a value of type
-     * `ReturnType<OneParamCallback<N>>`. The default value for this parameter is `this._defaultCallbackByKey
+     * `ReturnType<BTNCallback<N>>`. The default value for this parameter is `this._defaultCallbackByKey
      * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the breadth-first
      * search. It determines from which node the search will begin. If `beginRoot` is `null`, the search
      * will not be performed and an empty array will be returned.
      * @param iterationType - The `iterationType` parameter determines the type of iteration to be used
      * in the breadth-first search (BFS) algorithm. It can have two possible values:
-     * @returns The function `bfs` returns an array of `ReturnType<OneParamCallback<N>>[]`.
+     * @returns The function `bfs` returns an array of `ReturnType<BTNCallback<N>>[]`.
      */
     bfs(callback = this._defaultCallbackByKey, beginRoot = this.root, iterationType = this.iterationType) {
         if (!beginRoot)
@@ -934,7 +934,7 @@ class BinaryTree {
      * The `morris` function performs a depth-first traversal of a binary tree using the Morris traversal
      * algorithm and returns an array of values obtained by applying a callback function to each node.
      * @param callback - The `callback` parameter is a function that will be called on each node in the
-     * tree. It takes a node of type `N` as input and returns a value of type `ReturnType<OneParamCallback<N>>`. The
+     * tree. It takes a node of type `N` as input and returns a value of type `ReturnType<BTNCallback<N>>`. The
      * default value for this parameter is `this._defaultCallbackByKey`.
      * @param {DFSOrderPattern} [pattern=in] - The `pattern` parameter in the `morris` function
      * determines the order in which the nodes of a binary tree are traversed. It can have one of the
@@ -942,7 +942,7 @@ class BinaryTree {
      * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the Morris
      * traversal. It specifies the root node of the tree from which the traversal should begin. If
      * `beginRoot` is `null`, an empty array will be returned.
-     * @returns The `morris` function returns an array of `ReturnType<OneParamCallback<N>>` values.
+     * @returns The `morris` function returns an array of `ReturnType<BTNCallback<N>>` values.
      */
     morris(callback = this._defaultCallbackByKey, pattern = 'in', beginRoot = this.root) {
         if (beginRoot === null)
@@ -1028,6 +1028,44 @@ class BinaryTree {
         }
         return ans;
     }
+    /**
+     * The above function is an iterator for a binary tree that can be used to traverse the tree in
+     * either an iterative or recursive manner.
+     * @param node - The `node` parameter represents the current node in the binary tree from which the
+     * iteration starts. It is an optional parameter with a default value of `this.root`, which means
+     * that if no node is provided, the iteration will start from the root of the binary tree.
+     * @returns The `*[Symbol.iterator]` method returns a generator object that yields the keys of the
+     * binary tree nodes in a specific order.
+     */
+    *[Symbol.iterator](node = this.root) {
+        if (!node) {
+            return;
+        }
+        if (this.iterationType === types_1.IterationType.ITERATIVE) {
+            const stack = [];
+            let current = node;
+            while (current || stack.length > 0) {
+                while (current) {
+                    stack.push(current);
+                    current = current.left;
+                }
+                current = stack.pop();
+                if (current)
+                    yield current.key;
+                if (current)
+                    current = current.right;
+            }
+        }
+        else {
+            if (node.left) {
+                yield* this[Symbol.iterator](node.left);
+            }
+            yield node.key;
+            if (node.right) {
+                yield* this[Symbol.iterator](node.right);
+            }
+        }
+    }
     /**
      * Swap the data of two nodes in the binary tree.
      * @param {N} srcNode - The source node to swap.

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

@@ -5,12 +5,12 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BinaryTreeNodeKey, BSTComparator, BSTNodeNested, BSTOptions, OneParamCallback } from '../../types';
+import type { BTNKey, BSTComparator, BSTNodeNested, BSTOptions, BTNCallback } from '../../types';
 import { CP, IterationType } from '../../types';
 import { BinaryTree, BinaryTreeNode } from './binary-tree';
 import { IBinaryTree } from '../../interfaces';
 export declare class BSTNode<V = any, N extends BSTNode<V, N> = BSTNodeNested<V>> extends BinaryTreeNode<V, N> {
-    constructor(key: BinaryTreeNodeKey, val?: V);
+    constructor(key: BTNKey, val?: V);
 }
 export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNested<V>>> extends BinaryTree<V, N> implements IBinaryTree<V, N> {
     /**
@@ -22,30 +22,30 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
     constructor(options?: BSTOptions);
     /**
      * The function creates a new binary search tree node with the given key and value.
-     * @param {BinaryTreeNodeKey} key - The key parameter is the key value that will be associated with
+     * @param {BTNKey} key - The key parameter is the key value that will be associated with
      * the new node. It is used to determine the position of the node in the binary search tree.
      * @param [val] - The parameter `val` is an optional value that can be assigned to the node. It
      * represents the value associated with the node in a binary search tree.
      * @returns a new instance of the BSTNode class with the specified key and value.
      */
-    createNode(key: BinaryTreeNodeKey, val?: V): N;
+    createNode(key: BTNKey, val?: V): N;
     /**
      * The `add` function in a binary search tree class inserts a new node with a given key and value
      * into the tree.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
-     * `BinaryTreeNodeKey` (which can be a number or a string), a `BSTNode` object, or `null`.
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
+     * `BTNKey` (which can be a number or a string), a `BSTNode` object, or `null`.
      * @param [val] - The `val` parameter is the value to be assigned to the new node being added to the
      * binary search tree.
      * @returns the inserted node (N) if it was successfully added to the binary search tree. If the node
      * was not added or if the parameters were invalid, it returns null or undefined.
      */
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V): N | null | undefined;
+    add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined;
     /**
      * The `addMany` function is used to efficiently add multiple nodes to a binary search tree while
      * maintaining balance.
-     * @param {[BinaryTreeNodeKey | N, N['val']][]} keysOrNodes - The `arr` parameter in the `addMany` function
+     * @param {[BTNKey | N, N['val']][]} keysOrNodes - The `arr` parameter in the `addMany` function
      * represents an array of keys or nodes that need to be added to the binary search tree. It can be an
-     * array of `BinaryTreeNodeKey` or `N` (which represents the node type in the binary search tree) or
+     * array of `BTNKey` or `N` (which represents the node type in the binary search tree) or
      * `null
      * @param {V[]} data - The values of tree nodes
      * @param {boolean} isBalanceAdd - If true the nodes will be balance inserted in binary search method.
@@ -53,13 +53,13 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
      * It can have two possible values:
      * @returns The `addMany` function returns an array of `N`, `null`, or `undefined` values.
      */
-    addMany(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], data?: V[], isBalanceAdd?: boolean, iterationType?: IterationType): (N | null | undefined)[];
+    addMany(keysOrNodes: (BTNKey | null)[] | (N | null)[], data?: V[], isBalanceAdd?: boolean, iterationType?: IterationType): (N | null | undefined)[];
     /**
      * The function returns the first node in the binary tree that matches the given node property and
      * callback.
      * @param {ReturnType<C> | N} identifier - The `nodeProperty` parameter is used to specify the
      * property of the binary tree node that you want to search for. It can be either a specific key
-     * value (`BinaryTreeNodeKey`) or a custom callback function (`OneParamCallback<N>`) that determines
+     * value (`BTNKey`) or a custom callback function (`BTNCallback<N>`) that determines
      * whether a node matches the desired property.
      * @param callback - The `callback` parameter is a function that is used to determine whether a node
      * matches the desired property. It takes a node as input and returns a boolean value indicating
@@ -72,7 +72,7 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
      * @returns either the first node that matches the given nodeProperty and callback, or null if no
      * matching node is found.
      */
-    get<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback?: C, beginRoot?: N | null, iterationType?: IterationType): N | null;
+    get<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback?: C, beginRoot?: N | null, iterationType?: IterationType): N | null;
     /**
      * The function `lastKey` returns the key of the rightmost node if the comparison result is less
      * than, the key of the leftmost node if the comparison result is greater than, and the key of the
@@ -88,12 +88,12 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
      * the key of the leftmost node if the comparison result is greater than, and the key of the
      * rightmost node otherwise. If no node is found, it returns 0.
      */
-    lastKey(beginRoot?: N | null, iterationType?: IterationType): BinaryTreeNodeKey;
+    lastKey(beginRoot?: N | null, iterationType?: IterationType): BTNKey;
     /**
      * The function `getNodes` retrieves nodes from a binary tree based on a given node property or key,
      * using either recursive or iterative traversal.
      * @param {ReturnType<C> | N} identifier - The `nodeProperty` parameter represents the property
-     * of the binary tree node that you want to search for. It can be either a `BinaryTreeNodeKey` or a
+     * of the binary tree node that you want to search for. It can be either a `BTNKey` or a
      * generic type `N`.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `nodeProperty` parameter to determine if the node should be
@@ -110,7 +110,7 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
      * traverse the binary tree. It can have one of the following values:
      * @returns an array of nodes (N[]).
      */
-    getNodes<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback?: C, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
+    getNodes<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback?: C, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
     /**
      * The `lesserOrGreaterTraverse` function traverses a binary tree and applies a callback function to
      * nodes that have a key value lesser or greater than a target key value.
@@ -120,15 +120,15 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
      * @param {CP} lesserOrGreater - The `lesserOrGreater` parameter is used to determine whether to
      * traverse nodes that are lesser than, greater than, or equal to the `targetNode`. It can take one
      * of the following values:
-     * @param {BinaryTreeNodeKey | N | null} targetNode - The `targetNode` parameter in the
+     * @param {BTNKey | N | null} targetNode - The `targetNode` parameter in the
      * `lesserOrGreaterTraverse` function is used to specify the node from which the traversal should
      * start. It can be either a reference to a specific node (`N`), the key of a node
-     * (`BinaryTreeNodeKey`), or `null` to
+     * (`BTNKey`), or `null` to
      * @param iterationType - The `iterationType` parameter determines whether the traversal should be
      * done recursively or iteratively. It can have two possible values:
-     * @returns The function `lesserOrGreaterTraverse` returns an array of `ReturnType<OneParamCallback<N>>`.
+     * @returns The function `lesserOrGreaterTraverse` returns an array of `ReturnType<BTNCallback<N>>`.
      */
-    lesserOrGreaterTraverse<C extends OneParamCallback<N>>(callback?: C, lesserOrGreater?: CP, targetNode?: BinaryTreeNodeKey | N | null, iterationType?: IterationType): ReturnType<C>[];
+    lesserOrGreaterTraverse<C extends BTNCallback<N>>(callback?: C, lesserOrGreater?: CP, targetNode?: BTNKey | N | null, iterationType?: IterationType): ReturnType<C>[];
     /**
      * Balancing Adjustment:
      * Perfectly Balanced Binary Tree: Since the balance of a perfectly balanced binary tree is already fixed, no additional balancing adjustment is needed. Any insertion or deletion operation will disrupt the perfect balance, often requiring a complete reconstruction of the tree.
@@ -158,10 +158,10 @@ export declare class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNe
     /**
      * The function compares two values using a comparator function and returns whether the first value
      * is greater than, less than, or equal to the second value.
-     * @param {BinaryTreeNodeKey} a - The parameter "a" is of type BinaryTreeNodeKey.
-     * @param {BinaryTreeNodeKey} b - The parameter "b" in the above code represents a BinaryTreeNodeKey.
+     * @param {BTNKey} a - The parameter "a" is of type BTNKey.
+     * @param {BTNKey} b - The parameter "b" in the above code represents a BTNKey.
      * @returns a value of type CP (ComparisonResult). The possible return values are CP.gt (greater
      * than), CP.lt (less than), or CP.eq (equal).
      */
-    protected _compare(a: BinaryTreeNodeKey, b: BinaryTreeNodeKey): CP;
+    protected _compare(a: BTNKey, b: BTNKey): CP;
 }

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

@@ -29,7 +29,7 @@ class BST extends binary_tree_1.BinaryTree {
     }
     /**
      * The function creates a new binary search tree node with the given key and value.
-     * @param {BinaryTreeNodeKey} key - The key parameter is the key value that will be associated with
+     * @param {BTNKey} key - The key parameter is the key value that will be associated with
      * the new node. It is used to determine the position of the node in the binary search tree.
      * @param [val] - The parameter `val` is an optional value that can be assigned to the node. It
      * represents the value associated with the node in a binary search tree.
@@ -41,8 +41,8 @@ class BST extends binary_tree_1.BinaryTree {
     /**
      * The `add` function in a binary search tree class inserts a new node with a given key and value
      * into the tree.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
-     * `BinaryTreeNodeKey` (which can be a number or a string), a `BSTNode` object, or `null`.
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
+     * `BTNKey` (which can be a number or a string), a `BSTNode` object, or `null`.
      * @param [val] - The `val` parameter is the value to be assigned to the new node being added to the
      * binary search tree.
      * @returns the inserted node (N) if it was successfully added to the binary search tree. If the node
@@ -126,9 +126,9 @@ class BST extends binary_tree_1.BinaryTree {
     /**
      * The `addMany` function is used to efficiently add multiple nodes to a binary search tree while
      * maintaining balance.
-     * @param {[BinaryTreeNodeKey | N, N['val']][]} keysOrNodes - The `arr` parameter in the `addMany` function
+     * @param {[BTNKey | N, N['val']][]} keysOrNodes - The `arr` parameter in the `addMany` function
      * represents an array of keys or nodes that need to be added to the binary search tree. It can be an
-     * array of `BinaryTreeNodeKey` or `N` (which represents the node type in the binary search tree) or
+     * array of `BTNKey` or `N` (which represents the node type in the binary search tree) or
      * `null
      * @param {V[]} data - The values of tree nodes
      * @param {boolean} isBalanceAdd - If true the nodes will be balance inserted in binary search method.
@@ -210,7 +210,7 @@ class BST extends binary_tree_1.BinaryTree {
      * callback.
      * @param {ReturnType<C> | N} identifier - The `nodeProperty` parameter is used to specify the
      * property of the binary tree node that you want to search for. It can be either a specific key
-     * value (`BinaryTreeNodeKey`) or a custom callback function (`OneParamCallback<N>`) that determines
+     * value (`BTNKey`) or a custom callback function (`BTNCallback<N>`) that determines
      * whether a node matches the desired property.
      * @param callback - The `callback` parameter is a function that is used to determine whether a node
      * matches the desired property. It takes a node as input and returns a boolean value indicating
@@ -255,7 +255,7 @@ class BST extends binary_tree_1.BinaryTree {
      * The function `getNodes` retrieves nodes from a binary tree based on a given node property or key,
      * using either recursive or iterative traversal.
      * @param {ReturnType<C> | N} identifier - The `nodeProperty` parameter represents the property
-     * of the binary tree node that you want to search for. It can be either a `BinaryTreeNodeKey` or a
+     * of the binary tree node that you want to search for. It can be either a `BTNKey` or a
      * generic type `N`.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `nodeProperty` parameter to determine if the node should be
@@ -337,13 +337,13 @@ class BST extends binary_tree_1.BinaryTree {
      * @param {CP} lesserOrGreater - The `lesserOrGreater` parameter is used to determine whether to
      * traverse nodes that are lesser than, greater than, or equal to the `targetNode`. It can take one
      * of the following values:
-     * @param {BinaryTreeNodeKey | N | null} targetNode - The `targetNode` parameter in the
+     * @param {BTNKey | N | null} targetNode - The `targetNode` parameter in the
      * `lesserOrGreaterTraverse` function is used to specify the node from which the traversal should
      * start. It can be either a reference to a specific node (`N`), the key of a node
-     * (`BinaryTreeNodeKey`), or `null` to
+     * (`BTNKey`), or `null` to
      * @param iterationType - The `iterationType` parameter determines whether the traversal should be
      * done recursively or iteratively. It can have two possible values:
-     * @returns The function `lesserOrGreaterTraverse` returns an array of `ReturnType<OneParamCallback<N>>`.
+     * @returns The function `lesserOrGreaterTraverse` returns an array of `ReturnType<BTNCallback<N>>`.
      */
     lesserOrGreaterTraverse(callback = this._defaultCallbackByKey, lesserOrGreater = types_1.CP.lt, targetNode = this.root, iterationType = this.iterationType) {
         if (typeof targetNode === 'number')
@@ -494,8 +494,8 @@ class BST extends binary_tree_1.BinaryTree {
     /**
      * The function compares two values using a comparator function and returns whether the first value
      * is greater than, less than, or equal to the second value.
-     * @param {BinaryTreeNodeKey} a - The parameter "a" is of type BinaryTreeNodeKey.
-     * @param {BinaryTreeNodeKey} b - The parameter "b" in the above code represents a BinaryTreeNodeKey.
+     * @param {BTNKey} a - The parameter "a" is of type BTNKey.
+     * @param {BTNKey} b - The parameter "b" in the above code represents a BTNKey.
      * @returns a value of type CP (ComparisonResult). The possible return values are CP.gt (greater
      * than), CP.lt (less than), or CP.eq (equal).
      */

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

@@ -1,13 +1,13 @@
-import { BinaryTreeNodeKey, RBColor, RBTreeNodeNested, RBTreeOptions } from '../../types';
+import { BTNKey, RBColor, RBTreeNodeNested, RBTreeOptions } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 import { BST, BSTNode } from './bst';
 export declare class RBTreeNode<V = any, N extends RBTreeNode<V, N> = RBTreeNodeNested<V>> extends BSTNode<V, N> {
-    constructor(key: BinaryTreeNodeKey, val?: V);
+    constructor(key: BTNKey, val?: V);
     private _color;
     get color(): RBColor;
     set color(value: RBColor);
 }
 export declare class RBTree<V, N extends RBTreeNode<V, N> = RBTreeNode<V, RBTreeNodeNested<V>>> extends BST<V, N> implements IBinaryTree<V, N> {
     constructor(options?: RBTreeOptions);
-    createNode(key: BinaryTreeNodeKey, val?: V): N;
+    createNode(key: BTNKey, val?: V): N;
 }

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

@@ -5,15 +5,15 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BinaryTreeNodeKey, TreeMultisetNodeNested, TreeMultisetOptions } from '../../types';
-import { BinaryTreeDeletedResult, IterationType, OneParamCallback } from '../../types';
+import type { BTNKey, TreeMultisetNodeNested, TreeMultisetOptions } from '../../types';
+import { BinaryTreeDeletedResult, IterationType, BTNCallback } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 import { AVLTree, AVLTreeNode } from './avl-tree';
 export declare class TreeMultisetNode<V = any, N extends TreeMultisetNode<V, N> = TreeMultisetNodeNested<V>> extends AVLTreeNode<V, N> {
     count: number;
     /**
      * The constructor function initializes a BinaryTreeNode object with a key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter is of type `BinaryTreeNodeKey` and represents the unique identifier
+     * @param {BTNKey} key - The `key` parameter is of type `BTNKey` and represents the unique identifier
      * of the binary tree node.
      * @param {V} [val] - The `val` parameter is an optional parameter of type `V`. It represents the value of the binary
      * tree node. If no value is provided, it will be `undefined`.
@@ -21,7 +21,7 @@ export declare class TreeMultisetNode<V = any, N extends TreeMultisetNode<V, N>
      * occurs in a binary tree node. It has a default value of 1, which means that if no value is provided for the `count`
      * parameter when creating a new instance of the `BinaryTreeNode` class.
      */
-    constructor(key: BinaryTreeNodeKey, val?: V, count?: number);
+    constructor(key: BTNKey, val?: V, count?: number);
 }
 /**
  * The only distinction between a TreeMultiset and a AVLTree lies in the ability of the former to store duplicate nodes through the utilization of counters.
@@ -38,19 +38,19 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
     get count(): number;
     /**
      * The function creates a new BSTNode with the given key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
+     * @param {BTNKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
      * distinguish one node from another in the tree.
      * @param {N} val - The `val` parameter represents the value that will be stored in the binary search tree node.
      * @param {number} [count] - The "count" parameter is an optional parameter of type number. It represents the number of
      * occurrences of the value in the binary search tree node. If not provided, the count will default to 1.
      * @returns A new instance of the BSTNode class with the specified key, value, and count (if provided).
      */
-    createNode(key: BinaryTreeNodeKey, val?: V, count?: number): N;
+    createNode(key: BTNKey, val?: V, count?: number): N;
     /**
      * The `add` function adds a new node to a binary search tree, updating the count if the key already
      * exists, and balancing the tree if necessary.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
-     * `BinaryTreeNodeKey` (which represents the key of the node to be added), a `N` (which represents a
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
+     * `BTNKey` (which represents the key of the node to be added), a `N` (which represents a
      * node to be added), or `null` (which represents a null node).
      * @param [val] - The `val` parameter represents the value associated with the key that is being
      * added to the binary tree.
@@ -59,7 +59,7 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
      * count is specified, the default count will be 1.
      * @returns The function `add` returns a value of type `N | null | undefined`.
      */
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V, count?: number): N | null | undefined;
+    add(keyOrNode: BTNKey | N | null, val?: V, count?: number): N | null | undefined;
     /**
      * The function adds a new node to a binary tree if there is an available slot in the parent node.
      * @param {N | null} newNode - The `newNode` parameter represents the node that needs to be added to
@@ -72,14 +72,14 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
     /**
      * The `addMany` function adds multiple keys or nodes to a TreeMultiset and returns an array of the
      * inserted nodes.
-     * @param {(BinaryTreeNodeKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
-     * added to the multiset. Each element can be either a BinaryTreeNodeKey or a TreeMultisetNode.
+     * @param {(BTNKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
+     * added to the multiset. Each element can be either a BTNKey or a TreeMultisetNode.
      * @param {V[]} [data] - The `data` parameter is an optional array of values that correspond
      * to the keys or nodes being added to the multiset. It is used to associate additional data with
      * each key or node.
      * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values.
      */
-    addMany(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], data?: V[]): (N | null | undefined)[];
+    addMany(keysOrNodes: (BTNKey | null)[] | (N | null)[], data?: V[]): (N | null | undefined)[];
     /**
      * The `perfectlyBalance` function in TypeScript takes a sorted array of nodes and builds a balanced
      * binary search tree using either a recursive or iterative approach.
@@ -93,7 +93,7 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
      * The `delete` function in a binary search tree deletes a node from the tree and returns the deleted
      * node along with the parent node that needs to be balanced.
      * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
      * searching for. It can be a specific key value or any other property of the node.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `identifier` parameter to determine if the node should be
@@ -105,7 +105,7 @@ export declare class TreeMultiset<V = any, N extends TreeMultisetNode<V, N> = Tr
      * decremented by 1 and
      * @returns The method `delete` returns an array of `BinaryTreeDeletedResult<N>` objects.
      */
-    delete<C extends OneParamCallback<N>>(identifier: ReturnType<C>, callback?: C, ignoreCount?: boolean): BinaryTreeDeletedResult<N>[];
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback?: C, ignoreCount?: boolean): BinaryTreeDeletedResult<N>[];
     /**
      * The clear() function clears the contents of a data structure and sets the count to zero.
      */

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

@@ -6,7 +6,7 @@ const avl_tree_1 = require("./avl-tree");
 class TreeMultisetNode extends avl_tree_1.AVLTreeNode {
     /**
      * The constructor function initializes a BinaryTreeNode object with a key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The `key` parameter is of type `BinaryTreeNodeKey` and represents the unique identifier
+     * @param {BTNKey} key - The `key` parameter is of type `BTNKey` and represents the unique identifier
      * of the binary tree node.
      * @param {V} [val] - The `val` parameter is an optional parameter of type `V`. It represents the value of the binary
      * tree node. If no value is provided, it will be `undefined`.
@@ -39,7 +39,7 @@ class TreeMultiset extends avl_tree_1.AVLTree {
     }
     /**
      * The function creates a new BSTNode with the given key, value, and count.
-     * @param {BinaryTreeNodeKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
+     * @param {BTNKey} key - The key parameter is the unique identifier for the binary tree node. It is used to
      * distinguish one node from another in the tree.
      * @param {N} val - The `val` parameter represents the value that will be stored in the binary search tree node.
      * @param {number} [count] - The "count" parameter is an optional parameter of type number. It represents the number of
@@ -52,8 +52,8 @@ class TreeMultiset extends avl_tree_1.AVLTree {
     /**
      * The `add` function adds a new node to a binary search tree, updating the count if the key already
      * exists, and balancing the tree if necessary.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
-     * `BinaryTreeNodeKey` (which represents the key of the node to be added), a `N` (which represents a
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a
+     * `BTNKey` (which represents the key of the node to be added), a `N` (which represents a
      * node to be added), or `null` (which represents a null node).
      * @param [val] - The `val` parameter represents the value associated with the key that is being
      * added to the binary tree.
@@ -175,8 +175,8 @@ class TreeMultiset extends avl_tree_1.AVLTree {
     /**
      * The `addMany` function adds multiple keys or nodes to a TreeMultiset and returns an array of the
      * inserted nodes.
-     * @param {(BinaryTreeNodeKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
-     * added to the multiset. Each element can be either a BinaryTreeNodeKey or a TreeMultisetNode.
+     * @param {(BTNKey | null)[] | (N | null)[]} keysOrNodes - An array of keys or nodes to be
+     * added to the multiset. Each element can be either a BTNKey or a TreeMultisetNode.
      * @param {V[]} [data] - The `data` parameter is an optional array of values that correspond
      * to the keys or nodes being added to the multiset. It is used to associate additional data with
      * each key or node.
@@ -246,7 +246,7 @@ class TreeMultiset extends avl_tree_1.AVLTree {
      * The `delete` function in a binary search tree deletes a node from the tree and returns the deleted
      * node along with the parent node that needs to be balanced.
      * @param {ReturnType<C>} identifier - The `identifier` parameter is either a
-     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * `BTNKey` or a generic type `N`. It represents the property of the node that we are
      * searching for. It can be a specific key value or any other property of the node.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
      * value. This value is compared with the `identifier` parameter to determine if the node should be