min-heap-typed 1.38.4 → 1.38.6

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

@@ -8,6 +8,7 @@
 import { BST, BSTNode } from './bst';
 import type { AVLTreeNodeNested, AVLTreeOptions, BinaryTreeDeletedResult, BinaryTreeNodeKey } from '../../types';
 import { IBinaryTree } from '../../interfaces';
+import { MapCallback } from '../../types';
 export declare class AVLTreeNode<V = any, FAMILY extends AVLTreeNode<V, FAMILY> = AVLTreeNodeNested<V>> extends BSTNode<V, FAMILY> {
     height: number;
     constructor(key: BinaryTreeNodeKey, val?: V);
@@ -43,11 +44,16 @@ export declare class AVLTree<N extends AVLTreeNode<N['val'], N> = AVLTreeNode> e
     /**
      * The function overrides the delete method of a binary tree and balances the tree after deleting a
      * node if necessary.
-     * @param {N | BinaryTreeNodeKey} nodeOrKey - The `nodeOrKey` parameter can be either a node object
-     * (`N`) or a key value (`BinaryTreeNodeKey`).
+     * @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`
      * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
      */
-    delete(nodeOrKey: N | BinaryTreeNodeKey): BinaryTreeDeletedResult<N>[];
+    delete<C extends MapCallback<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

@@ -57,12 +57,17 @@ 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 {N | BinaryTreeNodeKey} nodeOrKey - The `nodeOrKey` parameter can be either a node object
-     * (`N`) or a key value (`BinaryTreeNodeKey`).
+     * @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`
      * @returns The method is returning an array of `BinaryTreeDeletedResult<N>` objects.
      */
-    delete(nodeOrKey) {
-        const deletedResults = super.delete(nodeOrKey);
+    delete(identifier, callback = this._defaultCallbackByKey) {
+        const deletedResults = super.delete(identifier, callback);
         for (const { needBalanced } of deletedResults) {
             if (needBalanced) {
                 this._balancePath(needBalanced);

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

@@ -6,7 +6,7 @@
  * @license MIT License
  */
 import type { BFSCallback, BinaryTreeNodeKey, BinaryTreeNodeNested, BinaryTreeOptions, MapCallback } from '../../types';
-import { BinaryTreeDeletedResult, DFSOrderPattern, FamilyPosition, IterationType } from '../../types';
+import { BinaryTreeDeletedResult, DefaultMapCallback, DFSOrderPattern, FamilyPosition, IterationType } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 /**
  * Represents a node in a binary tree.
@@ -132,32 +132,25 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * @returns The method is returning a boolean value.
      */
     refill(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], data?: N[] | Array<N['val']>): 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.
-     * @param {N | BinaryTreeNodeKey} nodeOrKey - The `nodeOrKey` parameter can be either a node (`N`) or
-     * 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.
-     */
-    delete(nodeOrKey: N | BinaryTreeNodeKey): BinaryTreeDeletedResult<N>[];
+    delete<C extends MapCallback<N>>(identifier: ReturnType<C> | N): BinaryTreeDeletedResult<N>[];
+    delete<C extends MapCallback<N>>(identifier: ReturnType<C> | N, 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 {N | BinaryTreeNodeKey | null} distNode - The `distNode` parameter represents the node
+     * @param {BinaryTreeNodeKey | 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 {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter represents the
+     * @param {BinaryTreeNodeKey | 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: N | BinaryTreeNodeKey | null, beginRoot?: N | BinaryTreeNodeKey | null): number;
+    getDepth(distNode: BinaryTreeNodeKey | N | null, beginRoot?: BinaryTreeNodeKey | N | null): number;
     /**
      * The `getHeight` function calculates the maximum height of a binary tree using either recursive or
      * iterative approach.
-     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter represents the
+     * @param {BinaryTreeNodeKey | 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
      * node is specified. If `
@@ -166,7 +159,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * possible values:
      * @returns the height of the binary tree.
      */
-    getHeight(beginRoot?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): number;
+    getHeight(beginRoot?: BinaryTreeNodeKey | N | null, iterationType?: IterationType): number;
     /**
      * The `getMinHeight` function calculates the minimum height of a binary tree using either a
      * recursive or iterative approach.
@@ -186,62 +179,21 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * @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 {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` 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 `nodeProperty` 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 nodeProperty. 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 MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(nodeProperty: BinaryTreeNodeKey | N, 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} nodeProperty - The `nodeProperty` 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 MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(nodeProperty: BinaryTreeNodeKey | N, 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} nodeProperty - The `nodeProperty` 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 MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(nodeProperty: BinaryTreeNodeKey | N, callback?: C, beginRoot?: N | null, iterationType?: IterationType): N | null;
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N): N[];
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C): N[];
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N, onlyOne: boolean): N[];
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C, onlyOne: boolean): N[];
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C, onlyOne: boolean, beginRoot: N | null): N[];
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C, onlyOne: boolean, beginRoot: N | null, iterationType: IterationType): N[];
+    has<C extends MapCallback<N>>(identifier: ReturnType<C> | N): boolean;
+    has<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C): boolean;
+    has<C extends MapCallback<N>>(identifier: ReturnType<C> | N, beginRoot: N | null): boolean;
+    has<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C, beginRoot: N | null): boolean;
+    get<C extends MapCallback<N>>(identifier: ReturnType<C> | N): N | null;
+    get<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C): N | null;
+    get<C extends MapCallback<N>>(identifier: ReturnType<C> | N, beginRoot: N | null): N | null;
+    get<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C, beginRoot: N | null): N | null;
+    get<C extends MapCallback<N>>(identifier: ReturnType<C> | N, callback: C, beginRoot: N | null, 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.
@@ -256,7 +208,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
     /**
      * The function `getLeftMost` returns the leftmost node in a binary tree, either using recursive or
      * iterative traversal.
-     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter is the starting point
+     * @param {BinaryTreeNodeKey | 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.
      * @param iterationType - The `iterationType` parameter is used to determine the type of iteration to
@@ -264,7 +216,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * @returns The function `getLeftMost` returns the leftmost node (`N`) in a binary tree. If there is
      * no leftmost node, it returns `null`.
      */
-    getLeftMost(beginRoot?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): N | null;
+    getLeftMost(beginRoot?: BinaryTreeNodeKey | N | null, iterationType?: IterationType): N | null;
     /**
      * The function `getRightMost` returns the rightmost node in a binary tree, either recursively or
      * iteratively.
@@ -303,14 +255,14 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * 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 {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter is the starting point
+     * @param {BinaryTreeNodeKey | 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 `MapCallbackReturn<N>`.
      */
-    subTreeTraverse<C extends MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(callback?: C, beginRoot?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): ReturnType<C>[];
+    subTreeTraverse<C extends MapCallback<N>>(callback?: C, beginRoot?: BinaryTreeNodeKey | 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.
@@ -326,7 +278,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * iteration used in the depth-first search algorithm. It can have two possible values:
      * @returns The function `dfs` returns an array of `MapCallbackReturn<N>` values.
      */
-    dfs<C extends MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
+    dfs<C extends MapCallback<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.
@@ -334,7 +286,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * breadth-first search. It takes a node of type `N` as its argument and returns a value of type
      * `BFSCallbackReturn<N>`. The default value for this parameter is `this._defaultCallbackByKey
      * @param {boolean} [withLevel=false] - The `withLevel` parameter is a boolean flag that determines
-     * whether or not to include the level of each node in the callback function. If `withLevel` is set
+     * whether to include the level of each node in the callback function. If `withLevel` is set
      * to `true`, the level of each node will be passed as an argument to the callback function. If
      * `withLevel` is
      * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the breadth-first
@@ -365,7 +317,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * `beginRoot` is `null`, an empty array will be returned.
      * @returns The `morris` function returns an array of `MapCallbackReturn<N>` values.
      */
-    morris<C extends MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null): ReturnType<C>[];
+    morris<C extends MapCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null): ReturnType<C>[];
     /**
      * Swap the data of two nodes in the binary tree.
      * @param {N} srcNode - The source node to swap.
@@ -380,7 +332,7 @@ export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTr
      * 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: (node: N) => number;
+    protected _defaultCallbackByKey: DefaultMapCallback<N>;
     /**
      * 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

@@ -64,35 +64,16 @@ class BinaryTreeNode {
      */
     get familyPosition() {
         const that = this;
-        if (that.parent) {
-            if (that.parent.left === that) {
-                if (that.left || that.right) {
-                    return types_1.FamilyPosition.ROOT_LEFT;
-                }
-                else {
-                    return types_1.FamilyPosition.LEFT;
-                }
-            }
-            else if (that.parent.right === that) {
-                if (that.left || that.right) {
-                    return types_1.FamilyPosition.ROOT_RIGHT;
-                }
-                else {
-                    return types_1.FamilyPosition.RIGHT;
-                }
-            }
-            else {
-                return types_1.FamilyPosition.MAL_NODE;
-            }
+        if (!this.parent) {
+            return this.left || this.right ? types_1.FamilyPosition.ROOT : types_1.FamilyPosition.ISOLATED;
         }
-        else {
-            if (that.left || that.right) {
-                return types_1.FamilyPosition.ROOT;
-            }
-            else {
-                return types_1.FamilyPosition.ISOLATED;
-            }
+        if (this.parent.left === that) {
+            return this.left || this.right ? types_1.FamilyPosition.ROOT_LEFT : types_1.FamilyPosition.LEFT;
         }
+        else if (this.parent.right === that) {
+            return this.left || this.right ? types_1.FamilyPosition.ROOT_RIGHT : types_1.FamilyPosition.RIGHT;
+        }
+        return types_1.FamilyPosition.MAL_NODE;
     }
 }
 exports.BinaryTreeNode = BinaryTreeNode;
@@ -210,7 +191,8 @@ class BinaryTree {
         else {
             return;
         }
-        const existNode = keyOrNode ? this.get(keyOrNode, this._defaultCallbackByKey) : undefined;
+        const key = typeof keyOrNode === 'number' ? keyOrNode : keyOrNode ? keyOrNode.key : undefined;
+        const existNode = key !== undefined ? this.get(key, this._defaultCallbackByKey) : undefined;
         if (this.root) {
             if (existNode) {
                 existNode.val = val;
@@ -244,21 +226,16 @@ class BinaryTree {
      */
     addMany(keysOrNodes, values) {
         // TODO not sure addMany not be run multi times
-        const inserted = [];
-        for (let i = 0; i < keysOrNodes.length; i++) {
-            const keyOrNode = keysOrNodes[i];
+        return keysOrNodes.map((keyOrNode, i) => {
             if (keyOrNode instanceof BinaryTreeNode) {
-                inserted.push(this.add(keyOrNode.key, keyOrNode.val));
-                continue;
+                return this.add(keyOrNode.key, keyOrNode.val);
             }
             if (keyOrNode === null) {
-                inserted.push(this.add(null));
-                continue;
+                return this.add(null);
             }
             const val = values === null || values === void 0 ? void 0 : values[i];
-            inserted.push(this.add(keyOrNode, val));
-        }
-        return inserted;
+            return this.add(keyOrNode, val);
+        });
     }
     /**
      * The `refill` function clears the binary tree and adds multiple nodes with the given IDs or nodes and optional data.
@@ -276,16 +253,24 @@ 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.
-     * @param {N | BinaryTreeNodeKey} nodeOrKey - The `nodeOrKey` parameter can be either a node (`N`) or
      * 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(nodeOrKey) {
+    delete(identifier, callback = this._defaultCallbackByKey) {
         const bstDeletedResult = [];
         if (!this.root)
             return bstDeletedResult;
-        const curr = typeof nodeOrKey === 'number' ? this.get(nodeOrKey) : nodeOrKey;
+        if (identifier instanceof BinaryTreeNode)
+            callback = (node => node);
+        const curr = this.get(identifier, callback);
         if (!curr)
             return bstDeletedResult;
         const parent = (curr === null || curr === void 0 ? void 0 : curr.parent) ? curr.parent : null;
@@ -327,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 {N | BinaryTreeNodeKey | null} distNode - The `distNode` parameter represents the node
+     * @param {BinaryTreeNodeKey | 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 {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter represents the
+     * @param {BinaryTreeNodeKey | 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.
@@ -354,7 +339,7 @@ class BinaryTree {
     /**
      * The `getHeight` function calculates the maximum height of a binary tree using either recursive or
      * iterative approach.
-     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter represents the
+     * @param {BinaryTreeNodeKey | 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
      * node is specified. If `
@@ -464,15 +449,15 @@ class BinaryTree {
     /**
      * The function `getNodes` returns an array of nodes that match a given node property, using either
      * recursive or iterative traversal.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is either a
+     * @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 `nodeProperty` parameter to determine if the node should be
+     * 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 nodeProperty. If set to true, the function will return an array with
+     * 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
@@ -482,13 +467,15 @@ class BinaryTree {
      * traverse the binary tree. It can have two possible values:
      * @returns The function `getNodes` returns an array of nodes (`N[]`).
      */
-    getNodes(nodeProperty, callback = this._defaultCallbackByKey, onlyOne = false, beginRoot = this.root, iterationType = this.iterationType) {
+    getNodes(identifier, callback = this._defaultCallbackByKey, onlyOne = false, beginRoot = this.root, iterationType = this.iterationType) {
         if (!beginRoot)
             return [];
+        if (identifier instanceof BinaryTreeNode)
+            callback = (node => node);
         const ans = [];
         if (iterationType === types_1.IterationType.RECURSIVE) {
             const _traverse = (cur) => {
-                if (callback(cur) === nodeProperty) {
+                if (callback(cur) === identifier) {
                     ans.push(cur);
                     if (onlyOne)
                         return;
@@ -505,7 +492,7 @@ class BinaryTree {
             while (queue.size > 0) {
                 const cur = queue.shift();
                 if (cur) {
-                    if (callback(cur) === nodeProperty) {
+                    if (callback(cur) === identifier) {
                         ans.push(cur);
                         if (onlyOne)
                             return ans;
@@ -519,7 +506,7 @@ class BinaryTree {
     }
     /**
      * The function checks if a binary tree has a node with a given property or key.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is the key or value of
+     * @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
@@ -534,13 +521,15 @@ class BinaryTree {
      * performed when searching for nodes in the binary tree. It can have one of the following values:
      * @returns a boolean value.
      */
-    has(nodeProperty, callback = this._defaultCallbackByKey, beginRoot = this.root, iterationType = this.iterationType) {
+    has(identifier, callback = this._defaultCallbackByKey, beginRoot = this.root, iterationType = this.iterationType) {
+        if (identifier instanceof BinaryTreeNode)
+            callback = (node => node);
         // TODO may support finding node by value equal
-        return this.getNodes(nodeProperty, callback, true, beginRoot, iterationType).length > 0;
+        return this.getNodes(identifier, callback, true, beginRoot, iterationType).length > 0;
     }
     /**
      * The function `get` returns the first node in a binary tree that matches the given property or key.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is the key or value of
+     * @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
@@ -553,10 +542,12 @@ class BinaryTree {
      * 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(nodeProperty, callback = this._defaultCallbackByKey, beginRoot = this.root, iterationType = this.iterationType) {
+    get(identifier, callback = this._defaultCallbackByKey, beginRoot = this.root, iterationType = this.iterationType) {
         var _a;
+        if (identifier instanceof BinaryTreeNode)
+            callback = (node => node);
         // TODO may support finding node by value equal
-        return (_a = this.getNodes(nodeProperty, callback, true, beginRoot, iterationType)[0]) !== null && _a !== void 0 ? _a : null;
+        return (_a = this.getNodes(identifier, callback, true, beginRoot, iterationType)[0]) !== null && _a !== void 0 ? _a : null;
     }
     /**
      * The function `getPathToRoot` returns an array of nodes starting from a given node and traversing
@@ -583,7 +574,7 @@ class BinaryTree {
     /**
      * The function `getLeftMost` returns the leftmost node in a binary tree, either using recursive or
      * iterative traversal.
-     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter is the starting point
+     * @param {BinaryTreeNodeKey | 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.
      * @param iterationType - The `iterationType` parameter is used to determine the type of iteration to
@@ -707,7 +698,7 @@ 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 {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter is the starting point
+     * @param {BinaryTreeNodeKey | 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
@@ -831,7 +822,7 @@ class BinaryTree {
      * breadth-first search. It takes a node of type `N` as its argument and returns a value of type
      * `BFSCallbackReturn<N>`. The default value for this parameter is `this._defaultCallbackByKey
      * @param {boolean} [withLevel=false] - The `withLevel` parameter is a boolean flag that determines
-     * whether or not to include the level of each node in the callback function. If `withLevel` is set
+     * whether to include the level of each node in the callback function. If `withLevel` is set
      * to `true`, the level of each node will be passed as an argument to the callback function. If
      * `withLevel` is
      * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the breadth-first

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

@@ -43,7 +43,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
     /**
      * The `addMany` function is used to efficiently add multiple nodes to a binary search tree while
      * maintaining balance.
-     * @param {[BinaryTreeNodeKey | N, N['val']][]} arr - The `arr` parameter in the `addMany` function
+     * @param {[BinaryTreeNodeKey | 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
      * `null
@@ -57,7 +57,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
     /**
      * The function returns the first node in the binary tree that matches the given node property and
      * callback.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is used to specify the
+     * @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 (`MapCallback<N>`) that determines
      * whether a node matches the desired property.
@@ -72,7 +72,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
      * @returns either the first node that matches the given nodeProperty and callback, or null if no
      * matching node is found.
      */
-    get<C extends MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(nodeProperty: BinaryTreeNodeKey | N, callback?: C, beginRoot?: N | null, iterationType?: IterationType): N | null;
+    get<C extends MapCallback<N>>(identifier: ReturnType<C> | N, 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
@@ -92,7 +92,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
     /**
      * The function `getNodes` retrieves nodes from a binary tree based on a given node property or key,
      * using either recursive or iterative traversal.
-     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter represents the property
+     * @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
      * generic type `N`.
      * @param callback - The `callback` parameter is a function that takes a node as input and returns a
@@ -110,7 +110,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
      * traverse the binary tree. It can have one of the following values:
      * @returns an array of nodes (N[]).
      */
-    getNodes<C extends MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(nodeProperty: BinaryTreeNodeKey | N, callback?: C, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
+    getNodes<C extends MapCallback<N>>(identifier: ReturnType<C> | N, 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,7 +120,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
      * @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 {N | BinaryTreeNodeKey | null} targetNode - The `targetNode` parameter in the
+     * @param {BinaryTreeNodeKey | 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
@@ -128,7 +128,7 @@ export declare class BST<N extends BSTNode<N['val'], N> = BSTNode> extends Binar
      * done recursively or iteratively. It can have two possible values:
      * @returns The function `lesserOrGreaterTraverse` returns an array of `MapCallbackReturn<N>`.
      */
-    lesserOrGreaterTraverse<C extends MapCallback<N> = MapCallback<N, BinaryTreeNodeKey>>(callback?: C, lesserOrGreater?: CP, targetNode?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): ReturnType<C>[];
+    lesserOrGreaterTraverse<C extends MapCallback<N>>(callback?: C, lesserOrGreater?: CP, targetNode?: BinaryTreeNodeKey | 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.