min-heap-typed 1.39.2 → 1.39.3

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

@@ -6,12 +6,12 @@
  * @license MIT License
  */
 import { BST, BSTNode } from './bst';
-import type { AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BinaryTreeNodeKey } from '../../types';
-import { OneParamCallback } from '../../types';
+import type { AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BTNKey } from '../../types';
+import { BTNCallback } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 export declare class AVLTreeNode<V = any, N extends AVLTreeNode<V, N> = AVLTreeNodeNested<V>> extends BSTNode<V, N> {
     height: number;
-    constructor(key: BinaryTreeNodeKey, val?: V);
+    constructor(key: BTNKey, val?: V);
 }
 export declare class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<V, AVLTreeNodeNested<V>>> extends BST<V, N> implements IBinaryTree<V, N> {
     /**
@@ -23,29 +23,29 @@ export declare class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<
     constructor(options?: AVLTreeOptions);
     /**
      * The function creates a new AVL tree node with the specified 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 is of
      * type `V`, which means it can be any value that is assignable to the `val` property of the
      * node type `N`.
      * @returns a new AVLTreeNode object with the specified key and value.
      */
-    createNode(key: BinaryTreeNodeKey, val?: V): N;
+    createNode(key: BTNKey, val?: V): N;
     /**
      * The function overrides the add method of a binary tree node and balances the tree after inserting
      * a new node.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
-     * `BinaryTreeNodeKey` or a `N` (which represents a node in the binary tree) or `null`.
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
+     * `BTNKey` or a `N` (which represents a node in the binary tree) or `null`.
      * @param [val] - The `val` parameter is the value that you want to assign to the new node that you
      * are adding to the binary search tree.
      * @returns The method is returning the inserted node (`N`), `null`, or `undefined`.
      */
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V): N | null | undefined;
+    add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined;
     /**
      * The function overrides the delete method of a binary tree and balances the tree after deleting a
      * node if necessary.
      * @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
@@ -53,7 +53,7 @@ export declare class AVLTree<V = any, N extends AVLTreeNode<V, N> = AVLTreeNode<
      * `this._defaultCallbackByKey`
      * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
      */
-    delete<C extends OneParamCallback<N>>(identifier: ReturnType<C>, callback?: C): BinaryTreeDeletedResult<N>[];
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback?: C): BinaryTreeDeletedResult<N>[];
     /**
      * The function swaps the key, value, and height properties between two nodes in a binary tree.
      * @param {N} srcNode - The `srcNode` parameter represents the source node that needs to be swapped

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

@@ -28,7 +28,7 @@ class AVLTree extends bst_1.BST {
     }
     /**
      * The function creates a new AVL tree node with the specified 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 is of
      * type `V`, which means it can be any value that is assignable to the `val` property of the
@@ -41,8 +41,8 @@ class AVLTree extends bst_1.BST {
     /**
      * The function overrides the add method of a binary tree node and balances the tree after inserting
      * a new node.
-     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
-     * `BinaryTreeNodeKey` or a `N` (which represents a node in the binary tree) or `null`.
+     * @param {BTNKey | N | null} keyOrNode - The `keyOrNode` parameter can accept either a
+     * `BTNKey` or a `N` (which represents a node in the binary tree) or `null`.
      * @param [val] - The `val` parameter is the value that you want to assign to the new node that you
      * are adding to the binary search tree.
      * @returns The method is returning the inserted node (`N`), `null`, or `undefined`.
@@ -58,7 +58,7 @@ class AVLTree extends bst_1.BST {
      * The function overrides the delete method of a binary tree and balances the tree after deleting a
      * node if necessary.
      * @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

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

@@ -5,7 +5,7 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BinaryTreeNodeKey, BinaryTreeNodeNested, BinaryTreeOptions, OneParamCallback } from '../../types';
+import type { BinaryTreeNodeNested, BinaryTreeOptions, BTNCallback, BTNKey } from '../../types';
 import { BinaryTreeDeletedResult, DFSOrderPattern, FamilyPosition, IterationType } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 /**
@@ -17,7 +17,7 @@ export declare class BinaryTreeNode<V = any, N extends BinaryTreeNode<V, N> = Bi
     /**
      * The key associated with the node.
      */
-    key: BinaryTreeNodeKey;
+    key: BTNKey;
     /**
      * The value stored in the node.
      */
@@ -28,10 +28,10 @@ export declare class BinaryTreeNode<V = any, N extends BinaryTreeNode<V, N> = Bi
     parent: N | null | undefined;
     /**
      * 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: BinaryTreeNodeKey, val?: V);
+    constructor(key: BTNKey, val?: V);
     private _left;
     /**
      * Get the left child node.
@@ -90,11 +90,11 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
     get size(): number;
     /**
      * 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.
      */
-    createNode(key: BinaryTreeNodeKey, val?: V): N;
+    createNode(key: BTNKey, val?: V): N;
     /**
      * Clear the binary tree, removing all nodes.
      */
@@ -106,73 +106,61 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
     isEmpty(): boolean;
     /**
      * 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.
      */
-    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: V): N | null | undefined;
+    add(keyOrNode: BTNKey | N | null, val?: V): N | null | undefined;
     /**
      * 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,
      * the value of the nodes will be `undefined`.
      * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values.
      */
-    addMany(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], values?: V[]): (N | null | undefined)[];
+    addMany(keysOrNodes: (BTNKey | null)[] | (N | null)[], values?: V[]): (N | null | undefined)[];
     /**
      * 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
      * @returns The method is returning a boolean value.
      */
-    refill(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], data?: Array<V>): boolean;
-    /**
-     * 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
-     * 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
-     * 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
-     * included in the result. The `callback` parameter has a default value of
-     * `this._defaultCallbackByKey`, which
-     */
-    delete<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback?: C): BinaryTreeDeletedResult<N>[];
+    refill(keysOrNodes: (BTNKey | null)[] | (N | null)[], data?: Array<V>): boolean;
+    delete<C extends BTNCallback<N, BTNKey>>(identifier: BTNKey, callback?: C): BinaryTreeDeletedResult<N>[];
+    delete<C extends BTNCallback<N, N>>(identifier: N | null, callback?: C): BinaryTreeDeletedResult<N>[];
+    delete<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback: C): BinaryTreeDeletedResult<N>[];
     /**
      * 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.
      * @returns the depth of the `distNode` relative to the `beginRoot`.
      */
-    getDepth(distNode: BinaryTreeNodeKey | N | null, beginRoot?: BinaryTreeNodeKey | N | null): number;
+    getDepth(distNode: BTNKey | N | null, beginRoot?: BTNKey | N | null): number;
     /**
      * 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
      * possible values:
      * @returns the height of the binary tree.
      */
-    getHeight(beginRoot?: BinaryTreeNodeKey | N | null, iterationType?: IterationType): number;
+    getHeight(beginRoot?: BTNKey | N | null, iterationType?: IterationType): number;
     /**
      * The `getMinHeight` function calculates the minimum height of a binary tree using either a
      * recursive or iterative approach.
@@ -192,62 +180,15 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * @returns The method is returning a boolean value.
      */
     isPerfectlyBalanced(beginRoot?: N | null): boolean;
-    /**
-     * 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
-     * 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
-     * included in the result. The `callback` parameter has a default value of
-     * `this._defaultCallbackByKey`, which
-     * @param [onlyOne=false] - A boolean value indicating whether to stop searching after finding the
-     * first node that matches the identifier. If set to true, the function will return an array with
-     * only one element (or an empty array if no matching node is found). If set to false (default), the
-     * function will continue searching for all
-     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node from which the
-     * traversal of the binary tree will begin. It is optional and defaults to the root of the binary
-     * tree.
-     * @param iterationType - The `iterationType` parameter determines the type of iteration used to
-     * traverse the binary tree. It can have two possible values:
-     * @returns The function `getNodes` 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[];
-    /**
-     * 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
-     * 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
-     * whether the node matches the criteria or not. The default callback function
-     * `this._defaultCallbackByKey` is used if no callback function is
-     * @param beginRoot - The `beginRoot` parameter is the starting point for the search. It specifies
-     * the node from which the search should begin. By default, it is set to `this.root`, which means the
-     * search will start from the root node of the binary tree. However, you can provide a different node
-     * as
-     * @param iterationType - The `iterationType` parameter specifies the type of iteration to be
-     * performed when searching for nodes in the binary tree. It can have one of the following values:
-     * @returns a boolean value.
-     */
-    has<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback?: C, beginRoot?: N | null, iterationType?: IterationType): boolean;
-    /**
-     * 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`
-     * 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
-     * whether the node matches the criteria or not. The default callback function
-     * (`this._defaultCallbackByKey`) is used if no callback function is
-     * @param beginRoot - The `beginRoot` parameter is the starting point for the search. It specifies
-     * the root node from which the search should begin.
-     * @param iterationType - The `iterationType` parameter specifies the type of iteration to be
-     * performed when searching for a node in the binary tree. It can have one of the following values:
-     * @returns either the found node (of type N) or null if no node is found.
-     */
-    get<C extends OneParamCallback<N>>(identifier: ReturnType<C> | null, callback?: C, beginRoot?: N | null, iterationType?: IterationType): N | null;
+    getNodes<C extends BTNCallback<N, BTNKey>>(identifier: BTNKey, callback: C, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
+    getNodes<C extends BTNCallback<N, N>>(identifier: N | null, callback: C, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
+    getNodes<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback: C, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
+    has<C extends BTNCallback<N, BTNKey>>(identifier: BTNKey, callback?: C, beginRoot?: N, iterationType?: IterationType): boolean;
+    has<C extends BTNCallback<N, N>>(identifier: N | null, callback?: C, beginRoot?: N, iterationType?: IterationType): boolean;
+    has<C extends BTNCallback<N>>(identifier: ReturnType<C> | null, callback: C, beginRoot?: N, iterationType?: IterationType): boolean;
+    get<C extends BTNCallback<N, BTNKey>>(identifier: BTNKey, callback?: C, beginRoot?: N, iterationType?: IterationType): N | null;
+    get<C extends BTNCallback<N, N>>(identifier: N | null, callback?: C, beginRoot?: N, iterationType?: IterationType): N | null;
+    get<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback: C, beginRoot?: N, iterationType?: IterationType): N | null;
     /**
      * The function `getPathToRoot` returns an array of nodes starting from a given node and traversing
      * up to the root node, with the option to reverse the order of the nodes.
@@ -262,15 +203,15 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
     /**
      * 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
      * no leftmost node, it returns `null`.
      */
-    getLeftMost(beginRoot?: BinaryTreeNodeKey | N | null, iterationType?: IterationType): N | null;
+    getLeftMost(beginRoot?: BTNKey | N | null, iterationType?: IterationType): N | null;
     /**
      * The function `getRightMost` returns the rightmost node in a binary tree, either recursively or
      * iteratively.
@@ -309,14 +250,14 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * 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<C extends OneParamCallback<N>>(callback?: C, beginRoot?: BinaryTreeNodeKey | N | null, iterationType?: IterationType): ReturnType<C>[];
+    subTreeTraverse<C extends BTNCallback<N>>(callback?: C, beginRoot?: BTNKey | N | null, iterationType?: IterationType): ReturnType<C>[];
     /**
      * The `dfs` function performs a depth-first search traversal on a binary tree, executing a callback
      * function on each node according to a specified order pattern.
@@ -330,23 +271,23 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * 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<C extends OneParamCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
+    dfs<C extends BTNCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
     /**
      * The bfs function performs a breadth-first search traversal on a binary tree, executing a callback
      * 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<C extends OneParamCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
+    bfs<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
     /**
      * The `listLevels` function takes a binary tree node and a callback function, and returns an array
      * of arrays representing the levels of the tree.
@@ -362,7 +303,7 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * level in a binary tree. Each inner array contains the return type of the provided callback
      * function `C` applied to the nodes at that level.
      */
-    listLevels<C extends OneParamCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[][];
+    listLevels<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[][];
     /**
      * The function returns the predecessor node of a given node in a binary tree.
      * @param {N} node - The parameter "node" represents a node in a binary tree.
@@ -373,7 +314,7 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * 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
@@ -381,9 +322,9 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * @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<C extends OneParamCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null): ReturnType<C>[];
+    morris<C extends BTNCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null): ReturnType<C>[];
     /**
      * 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.
@@ -393,7 +334,7 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * @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?: N | null): Generator<BinaryTreeNodeKey, void, undefined>;
+    [Symbol.iterator](node?: N | null): Generator<BTNKey, void, undefined>;
     /**
      * Swap the data of two nodes in the binary tree.
      * @param {N} srcNode - The source node to swap.
@@ -408,7 +349,7 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * the tree's structure should be restored to its original state to maintain the tree's integrity.
      * This is because the purpose of the Morris algorithm is to save space rather than permanently alter the tree's shape.
      */
-    protected _defaultCallbackByKey: OneParamCallback<N, BinaryTreeNodeKey>;
+    protected _defaultCallbackByKey: BTNCallback<N, BTNKey>;
     /**
      * The function `_addTo` adds a new node to a binary tree if there is an available position.
      * @param {N | null} newNode - The `newNode` parameter represents the node that you want to add to

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)