avl-tree-typed 1.51.8 → 1.52.0

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

@@ -50,27 +50,29 @@ exports.AVLTreeNode = AVLTreeNode;
  */
 class AVLTree extends bst_1.BST {
     /**
-     * The constructor function initializes an AVLTree object with optional keysOrNodesOrEntries and options.
-     * @param [keysOrNodesOrEntries] - The `keysOrNodesOrEntries` parameter is an optional iterable of `KeyOrNodeOrEntry<K, V, NODE>`
-     * objects. It represents a collection of nodes that will be added to the AVL tree during
-     * initialization.
-     * @param [options] - The `options` parameter is an optional object that allows you to customize the
-     * behavior of the AVL tree. It is of type `Partial<AVLTreeOptions>`, which means that you can
-     * provide only a subset of the properties defined in the `AVLTreeOptions` interface.
+     * This is a constructor function for an AVLTree class that initializes the tree with keys, nodes,
+     * entries, or raw elements.
+     * @param keysOrNodesOrEntriesOrRawElements - The `keysOrNodesOrEntriesOrRawElements` parameter is an
+     * iterable object that can contain either keys, nodes, entries, or raw elements. These elements will
+     * be used to initialize the AVLTree.
+     * @param [options] - The `options` parameter is an optional object that can be used to customize the
+     * behavior of the AVLTree. It can include properties such as `compareFn` (a function used to compare
+     * keys), `allowDuplicates` (a boolean indicating whether duplicate keys are allowed), and
+     * `nodeBuilder` (
      */
-    constructor(keysOrNodesOrEntries = [], options) {
+    constructor(keysOrNodesOrEntriesOrRawElements = [], options) {
         super([], options);
-        if (keysOrNodesOrEntries)
-            super.addMany(keysOrNodesOrEntries);
+        if (keysOrNodesOrEntriesOrRawElements)
+            super.addMany(keysOrNodesOrEntriesOrRawElements);
     }
     /**
-     * The function creates a new AVL tree node with the specified key and value.
-     * @param {K} 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 [value] - The parameter `value` 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 `value` property of the
-     * node type `NODE`.
-     * @returns a new AVLTreeNode object with the specified key and value.
+     * The function creates a new AVL tree node with the given key and value.
+     * @param {K} key - The key parameter is of type K, which represents the key of the node being
+     * created.
+     * @param {V} [value] - The "value" parameter is an optional parameter of type V. It represents the
+     * value associated with the key in the node being created.
+     * @returns The method is returning a new instance of the AVLTreeNode class, casted as the generic
+     * type NODE.
      */
     createNode(key, value) {
         return new AVLTreeNode(key, value);
@@ -86,12 +88,14 @@ class AVLTree extends bst_1.BST {
         return new AVLTree([], Object.assign({ iterationType: this.iterationType, comparator: this.comparator }, options));
     }
     /**
-     * The function checks if an keyOrNodeOrEntry is an instance of AVLTreeNode.
-     * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter is of type `KeyOrNodeOrEntry<K, V, NODE>`.
-     * @returns a boolean value indicating whether the keyOrNodeOrEntry is an instance of the AVLTreeNode class.
+     * The function checks if the input is an instance of AVLTreeNode.
+     * @param {R | KeyOrNodeOrEntry<K, V, NODE>} keyOrNodeOrEntryOrRawElement - The parameter
+     * `keyOrNodeOrEntryOrRawElement` can be of type `R` or `KeyOrNodeOrEntry<K, V, NODE>`.
+     * @returns a boolean value indicating whether the input parameter `keyOrNodeOrEntryOrRawElement` is
+     * an instance of the `AVLTreeNode` class.
      */
-    isNode(keyOrNodeOrEntry) {
-        return keyOrNodeOrEntry instanceof AVLTreeNode;
+    isNode(keyOrNodeOrEntryOrRawElement) {
+        return keyOrNodeOrEntryOrRawElement instanceof AVLTreeNode;
     }
     /**
      * Time Complexity: O(log n)
@@ -102,20 +106,21 @@ class AVLTree extends bst_1.BST {
      * Time Complexity: O(log n)
      * Space Complexity: O(1)
      *
-     * The function overrides the add method of a binary tree node and balances the tree after inserting
-     * a new node.
-     * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be either a key, a node, or an
-     * entry.
-     * @param {V} [value] - The `value` parameter represents the value associated with the key that is
-     * being added to the binary tree.
-     * @returns The method is returning either the inserted node or undefined.
+     * The function overrides the add method of a class and inserts a key-value pair into a data
+     * structure, then balances the path.
+     * @param {R | KeyOrNodeOrEntry<K, V, NODE>} keyOrNodeOrEntryOrRawElement - The parameter
+     * `keyOrNodeOrEntryOrRawElement` can accept values of type `R`, `KeyOrNodeOrEntry<K, V, NODE>`, or
+     * `RawElement`.
+     * @param {V} [value] - The `value` parameter is an optional value that you want to associate with
+     * the key or node being added to the data structure.
+     * @returns The method is returning a boolean value.
      */
-    add(keyOrNodeOrEntry, value) {
-        if (keyOrNodeOrEntry === null)
+    add(keyOrNodeOrEntryOrRawElement, value) {
+        if (keyOrNodeOrEntryOrRawElement === null)
             return false;
-        const inserted = super.add(keyOrNodeOrEntry, value);
+        const inserted = super.add(keyOrNodeOrEntryOrRawElement, value);
         if (inserted)
-            this._balancePath(keyOrNodeOrEntry);
+            this._balancePath(keyOrNodeOrEntryOrRawElement);
         return inserted;
     }
     /**
@@ -126,16 +131,14 @@ class AVLTree extends bst_1.BST {
      * Time Complexity: O(log n)
      * Space Complexity: O(1)
      *
-     * The function overrides the delete method of a binary tree, performs the deletion, and then
-     * balances the tree if necessary.
+     * The function overrides the delete method of a binary tree class and performs additional operations
+     * to balance the tree after deletion.
      * @param identifier - The `identifier` parameter is the value or condition used to identify the
-     * node(s) to be deleted from the binary tree. It can be of any type and is the return type of the
-     * `callback` function.
-     * @param {C} callback - The `callback` parameter is a function that will be called for each node
-     * that is deleted from the binary tree. It is an optional parameter and if not provided, it will
-     * default to the `_DEFAULT_CALLBACK` function. The `callback` function should have a single
-     * parameter of type `NODE
-     * @returns The method is returning an array of `BinaryTreeDeleteResult<NODE>`.
+     * node(s) to be deleted from the binary tree. It can be of any type that is compatible with the
+     * binary tree's node type.
+     * @param {C} callback - The `callback` parameter is a function that will be used to determine if a
+     * node should be deleted or not. It is optional and has a default value of `this._DEFAULT_CALLBACK`.
+     * @returns The method is returning an array of BinaryTreeDeleteResult<NODE> objects.
      */
     delete(identifier, callback = this._DEFAULT_CALLBACK) {
         const deletedResults = super.delete(identifier, callback);
@@ -147,14 +150,21 @@ class AVLTree extends bst_1.BST {
         return deletedResults;
     }
     /**
-     * The `_swapProperties` function swaps the key, value, and height properties between two nodes in a binary
-     * tree.
-     * @param {K | NODE | undefined} srcNode - The `srcNode` parameter represents the source node that
-     * needs to be swapped with the destination node. It can be of type `K`, `NODE`, or `undefined`.
-     * @param {K | NODE  | 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.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `_swapProperties` function swaps the key, value, and height properties between two nodes in a
+     * binary search tree.
+     * @param {R | BSTNKeyOrNode<K, NODE>} srcNode - The `srcNode` parameter represents either a node
+     * object (`NODE`) or a key-value pair (`R`) that is being swapped with another node.
+     * @param {R | BSTNKeyOrNode<K, NODE>} destNode - The `destNode` parameter is either an instance of
+     * `R` or an instance of `BSTNKeyOrNode<K, NODE>`.
+     * @returns The method is returning the `destNodeEnsured` object if both `srcNodeEnsured` and
+     * `destNodeEnsured` are truthy. Otherwise, it returns `undefined`.
      */
     _swapProperties(srcNode, destNode) {
         const srcNodeEnsured = this.ensureNode(srcNode);
@@ -184,7 +194,8 @@ class AVLTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The function calculates the balance factor of a node in a binary tree.
-     * @param {NODE} node - The parameter "node" represents a node in a binary tree data structure.
+     * @param {NODE} node - The parameter "node" is of type "NODE", which likely represents a node in a
+     * binary tree data structure.
      * @returns the balance factor of a given node. The balance factor is calculated by subtracting the
      * height of the left subtree from the height of the right subtree.
      */
@@ -230,7 +241,7 @@ class AVLTree extends bst_1.BST {
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
-     * The function `_balanceLL` performs a left-left rotation to balance a binary tree.
+     * The `_balanceLL` function performs a left-left rotation to balance a binary search tree.
      * @param {NODE} A - A is a node in a binary tree.
      */
     _balanceLL(A) {
@@ -428,8 +439,8 @@ class AVLTree extends bst_1.BST {
      *
      * The `_balancePath` function is used to update the heights of nodes and perform rotation operations
      * to restore balance in an AVL tree after inserting a node.
-     * @param {NODE} node - The `node` parameter in the `_balancePath` function represents the node in the
-     * AVL tree that needs to be balanced.
+     * @param {R | KeyOrNodeOrEntry<K, V, NODE>} node - The `node` parameter can be of type `R` or
+     * `KeyOrNodeOrEntry<K, V, NODE>`.
      */
     _balancePath(node) {
         node = this.ensureNode(node);
@@ -472,13 +483,21 @@ class AVLTree extends bst_1.BST {
         }
     }
     /**
-     * The function replaces an old node with a new node while preserving the height of the old node.
-     * @param {NODE} oldNode - The `oldNode` parameter is the node that you want to replace with the
-     * `newNode`.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function replaces an old node with a new node and sets the height of the new node to be the
+     * same as the old node.
+     * @param {NODE} oldNode - The `oldNode` parameter represents the node that needs to be replaced in
+     * the data structure.
      * @param {NODE} newNode - The `newNode` parameter is the new node that will replace the `oldNode` in
      * the data structure.
-     * @returns the result of calling the `_replaceNode` method on the superclass, passing in the
-     * `oldNode` and `newNode` as arguments.
+     * @returns The method is returning the result of calling the `_replaceNode` method from the
+     * superclass, with the `oldNode` and `newNode` as arguments.
      */
     _replaceNode(oldNode, newNode) {
         newNode.height = oldNode.height;