min-heap-typed 1.42.8 → 1.42.9

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

@@ -20,6 +20,11 @@ export declare class RedBlackTreeNode<V = any, N extends RedBlackTreeNode<V, N>
  * 5. Black balance: Every path from any node to each of its leaf nodes contains the same number of black nodes.
  */
 export declare class RedBlackTree<V = any, N extends RedBlackTreeNode<V, N> = RedBlackTreeNode<V, RedBlackTreeNodeNested<V>>> extends BST<V, N> implements IBinaryTree<V, N> {
+    /**
+     * The constructor function initializes a Red-Black Tree with an optional set of options.
+     * @param {RBTreeOptions} [options] - The `options` parameter is an optional object that can be
+     * passed to the constructor. It is used to configure the RBTree object with specific options.
+     */
     constructor(options?: RBTreeOptions);
     protected _root: N;
     get root(): N;
@@ -27,6 +32,13 @@ export declare class RedBlackTree<V = any, N extends RedBlackTreeNode<V, N> = Re
     get size(): number;
     NIL: N;
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The `add` function adds a new node to a Red-Black Tree data structure.
      * @param {BTNKey | N | null | undefined} keyOrNode - The `keyOrNode` parameter can be one of the
      * following types:
@@ -37,6 +49,13 @@ export declare class RedBlackTree<V = any, N extends RedBlackTreeNode<V, N> = Re
     add(keyOrNode: BTNKey | N | null | undefined, value?: V): N | undefined;
     createNode(key: BTNKey, value?: V, color?: RBTNColor): N;
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The `delete` function removes a node from a binary tree based on a given identifier and updates
      * the tree accordingly.
      * @param {ReturnType<C> | null | undefined} identifier - The `identifier` parameter is the value
@@ -54,12 +73,26 @@ export declare class RedBlackTree<V = any, N extends RedBlackTreeNode<V, N> = Re
     getNode<C extends BTNCallback<N, N>>(identifier: N | undefined, callback?: C, beginRoot?: N | undefined, iterationType?: IterationType): N | undefined;
     getNode<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback: C, beginRoot?: N | undefined, iterationType?: IterationType): N | undefined;
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The function returns the successor of a given node in a red-black tree.
      * @param {RedBlackTreeNode} x - RedBlackTreeNode - The node for which we want to find the successor.
      * @returns the successor of the given RedBlackTreeNode.
      */
     getSuccessor(x: N): N | undefined;
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The function returns the predecessor of a given node in a red-black tree.
      * @param {RedBlackTreeNode} x - The parameter `x` is of type `RedBlackTreeNode`, which represents a node in a
      * Red-Black Tree.
@@ -69,29 +102,63 @@ export declare class RedBlackTree<V = any, N extends RedBlackTreeNode<V, N> = Re
     clear(): void;
     protected _setRoot(v: N): void;
     /**
-     * The function performs a left rotation on a red-black tree node.
-     * @param {RedBlackTreeNode} x - The parameter `x` is a RedBlackTreeNode object.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function performs a left rotation on a binary tree node.
+     * @param {RedBlackTreeNode} x - The parameter `x` is of type `N`, which likely represents a node in a binary tree.
      */
     protected _leftRotate(x: N): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function performs a right rotation on a red-black tree node.
      * @param {RedBlackTreeNode} x - x is a RedBlackTreeNode, which represents the node that needs to be right
      * rotated.
      */
     protected _rightRotate(x: N): void;
     /**
-     * The _fixDelete function is used to rebalance the Red-Black Tree after a node deletion.
-     * @param {RedBlackTreeNode} x - The parameter `x` is of type `RedBlackTreeNode`, which represents a node in a
-     * red-black tree.
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
+     * The function `_fixDelete` is used to fix the red-black tree after a node deletion.
+     * @param {RedBlackTreeNode} x - The parameter `x` represents a node in a Red-Black Tree (RBT).
      */
     protected _fixDelete(x: N): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `_rbTransplant` replaces one node in a red-black tree with another node.
      * @param {RedBlackTreeNode} u - The parameter "u" represents a RedBlackTreeNode object.
      * @param {RedBlackTreeNode} v - The parameter "v" is a RedBlackTreeNode object.
      */
     protected _rbTransplant(u: N, v: N): void;
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The `_fixInsert` function is used to fix the red-black tree after an insertion operation.
      * @param {RedBlackTreeNode} k - The parameter `k` is a RedBlackTreeNode object, which represents a node in a
      * red-black tree.

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

@@ -26,6 +26,11 @@ exports.RedBlackTreeNode = RedBlackTreeNode;
  * 5. Black balance: Every path from any node to each of its leaf nodes contains the same number of black nodes.
  */
 class RedBlackTree extends bst_1.BST {
+    /**
+     * The constructor function initializes a Red-Black Tree with an optional set of options.
+     * @param {RBTreeOptions} [options] - The `options` parameter is an optional object that can be
+     * passed to the constructor. It is used to configure the RBTree object with specific options.
+     */
     constructor(options) {
         super(options);
         this._size = 0;
@@ -39,6 +44,13 @@ class RedBlackTree extends bst_1.BST {
         return this._size;
     }
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The `add` function adds a new node to a Red-Black Tree data structure.
      * @param {BTNKey | N | null | undefined} keyOrNode - The `keyOrNode` parameter can be one of the
      * following types:
@@ -102,6 +114,13 @@ class RedBlackTree extends bst_1.BST {
         return new RedBlackTreeNode(key, value, color);
     }
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The `delete` function removes a node from a binary tree based on a given identifier and updates
      * the tree accordingly.
      * @param {ReturnType<C> | null | undefined} identifier - The `identifier` parameter is the value
@@ -175,19 +194,29 @@ class RedBlackTree extends bst_1.BST {
         return node !== this.NIL && node !== undefined;
     }
     /**
-     * The function `get` returns the first node in a binary tree that matches the given property or key.
-     * @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
-     * whether the node matches the criteria or not. The default callback function
-     * (`this._defaultOneParamCallback`) 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.
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
+     * The function `getNode` retrieves a single node from a binary tree based on a given identifier and
+     * callback function.
+     * @param {ReturnType<C> | undefined} identifier - The `identifier` parameter is the value used to
+     * identify the node you want to retrieve. It can be of any type that is the return type of the `C`
+     * callback function. If the `identifier` is `undefined`, it means you want to retrieve the first
+     * node that matches the other criteria
+     * @param {C} callback - The `callback` parameter is a function that will be called for each node in
+     * the binary tree. It is used to determine if a node matches the given identifier. The `callback`
+     * function should take a single parameter of type `N` (the type of the nodes in the binary tree) and
+     * @param {BTNKey | N | undefined} beginRoot - The `beginRoot` parameter is the starting point for
+     * searching for a node in a binary tree. It can be either a key value or a node object. If it is not
+     * provided, the search will start from the root of the binary tree.
+     * @param iterationType - The `iterationType` parameter is a variable that determines the type of
+     * iteration to be performed when searching for nodes in the binary tree. It is used in the
+     * `getNodes` method, which is called within the `getNode` method.
+     * @returns a value of type `N`, `null`, or `undefined`.
      */
     getNode(identifier, callback = this._defaultOneParamCallback, beginRoot = this.root, iterationType = this.iterationType) {
         var _a;
@@ -197,6 +226,13 @@ class RedBlackTree extends bst_1.BST {
         return (_a = this.getNodes(identifier, callback, true, beginRoot, iterationType)[0]) !== null && _a !== void 0 ? _a : undefined;
     }
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The function returns the successor of a given node in a red-black tree.
      * @param {RedBlackTreeNode} x - RedBlackTreeNode - The node for which we want to find the successor.
      * @returns the successor of the given RedBlackTreeNode.
@@ -214,6 +250,13 @@ class RedBlackTree extends bst_1.BST {
         return y;
     }
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The function returns the predecessor of a given node in a red-black tree.
      * @param {RedBlackTreeNode} x - The parameter `x` is of type `RedBlackTreeNode`, which represents a node in a
      * Red-Black Tree.
@@ -241,8 +284,15 @@ class RedBlackTree extends bst_1.BST {
         this._root = v;
     }
     /**
-     * The function performs a left rotation on a red-black tree node.
-     * @param {RedBlackTreeNode} x - The parameter `x` is a RedBlackTreeNode object.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function performs a left rotation on a binary tree node.
+     * @param {RedBlackTreeNode} x - The parameter `x` is of type `N`, which likely represents a node in a binary tree.
      */
     _leftRotate(x) {
         if (x.right) {
@@ -267,6 +317,13 @@ class RedBlackTree extends bst_1.BST {
         }
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function performs a right rotation on a red-black tree node.
      * @param {RedBlackTreeNode} x - x is a RedBlackTreeNode, which represents the node that needs to be right
      * rotated.
@@ -294,9 +351,15 @@ class RedBlackTree extends bst_1.BST {
         }
     }
     /**
-     * The _fixDelete function is used to rebalance the Red-Black Tree after a node deletion.
-     * @param {RedBlackTreeNode} x - The parameter `x` is of type `RedBlackTreeNode`, which represents a node in a
-     * red-black tree.
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
+     * The function `_fixDelete` is used to fix the red-black tree after a node deletion.
+     * @param {RedBlackTreeNode} x - The parameter `x` represents a node in a Red-Black Tree (RBT).
      */
     _fixDelete(x) {
         let s;
@@ -363,6 +426,13 @@ class RedBlackTree extends bst_1.BST {
         x.color = types_1.RBTNColor.BLACK;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `_rbTransplant` replaces one node in a red-black tree with another node.
      * @param {RedBlackTreeNode} u - The parameter "u" represents a RedBlackTreeNode object.
      * @param {RedBlackTreeNode} v - The parameter "v" is a RedBlackTreeNode object.
@@ -380,6 +450,13 @@ class RedBlackTree extends bst_1.BST {
         v.parent = u.parent;
     }
     /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
+     * Space Complexity: O(1)
+     *
      * The `_fixInsert` function is used to fix the red-black tree after an insertion operation.
      * @param {RedBlackTreeNode} k - The parameter `k` is a RedBlackTreeNode object, which represents a node in a
      * red-black tree.

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

@@ -47,63 +47,100 @@ export declare class TreeMultimap<V = any, N extends TreeMultimapNode<V, N> = Tr
      */
     createNode(key: BTNKey, value?: 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 {BTNKey | N | undefined} 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 `undefined` (which represents a undefined node).
-     * @param [value] - The `value` parameter represents the value associated with the key that is being
-     * added to the binary tree.
-     * @param [count=1] - The `count` parameter represents the number of occurrences of the key/value
-     * pair that will be added to the binary tree. It has a default value of 1, which means that if no
-     * count is specified, the default count will be 1.
-     * @returns The function `add` returns a value of type `N | undefined | undefined`.
+     * Time Complexity: O(log n) - logarithmic time, where "n" is the number of nodes in the tree. The add method of the superclass (AVLTree) has logarithmic time complexity.
+     * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
+     */
+    /**
+     * Time Complexity: O(log n) - logarithmic time, where "n" is the number of nodes in the tree. The add method of the superclass (AVLTree) has logarithmic time complexity.
+     * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
+     *
+     * The `add` function adds a new node to the tree multimap, updating the count if the key already
+     * exists, and balances the tree if necessary.
+     * @param {BTNKey | N | null | undefined} keyOrNode - The `keyOrNode` parameter can be one of the
+     * following types:
+     * @param {V} [value] - The `value` parameter represents the value associated with the key that is
+     * being added to the tree. It is an optional parameter, so it can be omitted if not needed.
+     * @param [count=1] - The `count` parameter is an optional parameter that specifies the number of
+     * times the key-value pair should be added to the multimap. If not provided, the default value is 1.
+     * @returns a node (`N`) or `undefined`.
      */
     add(keyOrNode: BTNKey | N | null | undefined, value?: V, count?: number): N | undefined;
     /**
-     * The function adds a new node to a binary tree if there is an available slot in the parent node.
-     * @param {N | undefined} newNode - The `newNode` parameter represents the node that needs to be added to
-     * the tree. It can be either a node object (`N`) or `undefined`.
-     * @param {N} parent - The `parent` parameter represents the parent node to which the new node will
-     * be added as a child.
-     * @returns The method `_addTo` returns either the `parent.left`, `parent.right`, or `undefined`.
+     * Time Complexity: O(1) - constant time, as it performs basic pointer assignments.
+     * Space Complexity: O(1) - constant space, as it only uses a constant amount of memory.
+     */
+    /**
+     * Time Complexity: O(1) - constant time, as it performs basic pointer assignments.
+     * Space Complexity: O(1) - constant space, as it only uses a constant amount of memory.
+     *
+     * The function adds a new node to a binary tree, either as the left child or the right child of a
+     * given parent node.
+     * @param {N | undefined} newNode - The `newNode` parameter represents the node that needs to be
+     * added to the binary tree. It can be of type `N` (which represents a node in the binary tree) or
+     * `undefined` if there is no node to add.
+     * @param {BTNKey | N | undefined} parent - The `parent` parameter represents the parent node to
+     * which the new node will be added as a child. It can be either a node object (`N`) or a key value
+     * (`BTNKey`).
+     * @returns The method `_addTo` returns either the `parent.left` or `parent.right` node that was
+     * added, or `undefined` if no node was added.
      */
     protected _addTo(newNode: N | undefined, parent: BTNKey | N | undefined): N | undefined;
     /**
-     * The `addMany` function adds multiple keys or nodes to a TreeMultimap and returns an array of the
-     * inserted nodes.
-     * @param {(BTNKey | undefined)[] | (N | undefined)[]} keysOrNodes - An array of keys or nodes to be
-     * added to the multiset. Each element can be either a BTNKey or a TreeMultimapNode.
-     * @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`, `undefined`, or `undefined` values.
+     * Time Complexity: O(k log n) - logarithmic time for each insertion, where "n" is the number of nodes in the tree, and "k" is the number of keys to be inserted. This is because the method iterates through the keys and calls the add method for each.
+     * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
+     */
+    /**
+     * Time Complexity: O(k log n) - logarithmic time for each insertion, where "n" is the number of nodes in the tree, and "k" is the number of keys to be inserted. This is because the method iterates through the keys and calls the add method for each.
+     * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
+     *
+     * The function `addMany` takes an array of keys or nodes and adds them to the TreeMultimap,
+     * returning an array of the inserted nodes.
+     * @param {(BTNKey | N | undefined)[]} keysOrNodes - An array of keys or nodes. Each element can be
+     * of type BTNKey, N, or undefined.
+     * @param {V[]} [data] - The `data` parameter is an optional array of values that correspond to the
+     * keys or nodes being added. It is used to associate data with each key or node being added to the
+     * TreeMultimap. If provided, the length of the `data` array should be the same as the length of the
+     * @returns The function `addMany` returns an array of nodes (`N`) or `undefined` values.
      */
     addMany(keysOrNodes: (BTNKey | N | undefined)[], data?: V[]): (N | 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.
+     * Time Complexity: O(n log n) - logarithmic time for each insertion, where "n" is the number of nodes in the tree. This is because the method calls the add method for each node.
+     * Space Complexity: O(n) - linear space, as it creates an array to store the sorted nodes.
+     */
+    /**
+     * Time Complexity: O(n log n) - logarithmic time for each insertion, where "n" is the number of nodes in the tree. This is because the method calls the add method for each node.
+     * Space Complexity: O(n) - linear space, as it creates an array to store the sorted nodes.
+     *
+     * The `perfectlyBalance` function takes a sorted array of nodes and builds a balanced binary search
+     * tree using either a recursive or iterative approach.
      * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
-     * type of iteration to use when building a balanced binary search tree. It can have two possible
+     * type of iteration to use when building the balanced binary search tree. It can have two possible
      * values:
      * @returns a boolean value.
      */
     perfectlyBalance(iterationType?: IterationType): boolean;
     /**
-     * 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
-     * `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
-     * included in the result. The `callback` parameter has a default value of
-     * `this._defaultOneParamCallback`
+     * Time Complexity: O(log n) - logarithmic time, where "n" is the number of nodes in the tree. The delete method of the superclass (AVLTree) has logarithmic time complexity.
+     * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
+     */
+    /**
+     * Time Complexity: O(log n) - logarithmic time, where "n" is the number of nodes in the tree. The delete method of the superclass (AVLTree) has logarithmic time complexity.
+     * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
+     *
+     * The `delete` function in TypeScript is used to remove a node from a binary tree, taking into
+     * account the count of the node and balancing the tree if necessary.
+     * @param identifier - The identifier is the value or key that is used to identify the node that
+     * needs to be deleted from the binary tree. It can be of any type that is returned by the callback
+     * function.
+     * @param {C} callback - The `callback` parameter is a function that is used to determine if a node
+     * should be deleted. It is optional and defaults to a default callback function. The `callback`
+     * function takes one parameter, which is the identifier of the node, and returns a value that is
+     * used to identify the node to
      * @param [ignoreCount=false] - A boolean flag indicating whether to ignore the count of the node
      * being deleted. If set to true, the count of the node will not be considered and the node will be
      * deleted regardless of its count. If set to false (default), the count of the node will be
      * decremented by 1 and
-     * @returns The method `delete` returns an array of `BiTreeDeleteResult<N>` objects.
+     * @returns an array of `BiTreeDeleteResult<N>`.
      */
     delete<C extends BTNCallback<N>>(identifier: ReturnType<C>, callback?: C, ignoreCount?: boolean): BiTreeDeleteResult<N>[];
     /**
@@ -111,11 +148,13 @@ export declare class TreeMultimap<V = any, N extends TreeMultimapNode<V, N> = Tr
      */
     clear(): void;
     /**
-     * The function swaps the values of two nodes in a binary tree.
-     * @param {N} srcNode - The source node that needs to be swapped with the destination node.
-     * @param {N} destNode - The `destNode` parameter represents the destination node where the values
-     * from `srcNode` will be swapped into.
-     * @returns The method is returning the `destNode` after swapping its properties with the `srcNode`.
+     * The `_swap` function swaps the key, value, count, and height properties between two nodes.
+     * @param {BTNKey | N | undefined} srcNode - The `srcNode` parameter represents the source node from
+     * which the values will be swapped. It can be of type `BTNKey`, `N`, or `undefined`.
+     * @param {BTNKey | N | undefined} destNode - The `destNode` parameter represents the destination
+     * node where the values from the source node will be swapped to.
+     * @returns either the `destNode` object if both `srcNode` and `destNode` are defined, or `undefined`
+     * if either `srcNode` or `destNode` is undefined.
      */
     protected _swap(srcNode: BTNKey | N | undefined, destNode: BTNKey | N | undefined): N | undefined;
 }