min-heap-typed 1.48.4 → 1.48.5

package/src/data-structures/binary-tree/avl-tree.ts

@@ -95,19 +95,22 @@ export class AVLTree<K = any, V = any, N extends AVLTreeNode<K, V, N> = AVLTreeN
    * 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 (BST) has logarithmic time complexity.
    * Space Complexity: O(1) - constant space, as it doesn't use additional data structures that scale with input size.
-   *
+   * 
    * The function overrides the add method of a binary tree node and balances the tree after inserting
    * a new node.
-   * @param keyOrNodeOrEntry - The parameter `keyOrNodeOrEntry` can be either a key, a node, or an
+   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be either a key, a node, or an
    * entry.
-   * @returns The method is returning either the inserted node or `undefined`.
+   * @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.
    */
-  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | undefined {
+  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | undefined {
     if (keyOrNodeOrEntry === null) return undefined;
-    const inserted = super.add(keyOrNodeOrEntry);
+    const inserted = super.add(keyOrNodeOrEntry, value);
     if (inserted) this._balancePath(inserted);
     return inserted;
   }

package/src/data-structures/binary-tree/binary-tree.ts

@@ -19,15 +19,15 @@ import {
   BinaryTreePrintOptions,
   BiTreeDeleteResult,
   DFSOrderPattern,
+  EntryCallback,
   FamilyPosition,
   IterationType,
-  NodeDisplayLayout,
-  PairCallback
+  NodeDisplayLayout
 } from '../../types';
 import { IBinaryTree } from '../../interfaces';
 import { trampoline } from '../../utils';
 import { Queue } from '../queue';
-import { IterablePairBase } from "../base";
+import { IterableEntryBase } from "../base";
 
 /**
  * Represents a node in a binary tree.
@@ -104,7 +104,7 @@ export class BinaryTreeNode<K = any, V = any, N extends BinaryTreeNode<K, V, N>
  * 9. Complete Trees: All levels are fully filled except possibly the last, filled from left to right.
  */
 
-export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = BinaryTreeNode<K, V, BinaryTreeNodeNested<K, V>>, TREE extends BinaryTree<K, V, N, TREE> = BinaryTree<K, V, N, BinaryTreeNested<K, V, N>>> extends IterablePairBase<K, V | undefined>
+export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = BinaryTreeNode<K, V, BinaryTreeNodeNested<K, V>>, TREE extends BinaryTree<K, V, N, TREE> = BinaryTree<K, V, N, BinaryTreeNested<K, V, N>>> extends IterableEntryBase<K, V | undefined>
 
   implements IBinaryTree<K, V, N, TREE> {
   iterationType = IterationType.ITERATIVE
@@ -184,13 +184,14 @@ export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = Bi
   }
 
   /**
-   * The function `exemplarToNode` converts an exemplar of a binary tree node into an actual node
-   * object.
-   * @param exemplar - BTNodeExemplar<K, V,N> - A generic type representing the exemplar parameter of the
-   * function. It can be any type.
-   * @returns a value of type `N` (which represents a node), or `null`, or `undefined`.
+   * The function `exemplarToNode` converts an exemplar object into a node object.
+   * @param exemplar - The `exemplar` parameter is of type `BTNodeExemplar<K, V, N>`.
+   * @param {V} [value] - The `value` parameter is an optional value that can be passed to the
+   * `exemplarToNode` function. It represents the value associated with the exemplar node. If no value
+   * is provided, it will be `undefined`.
+   * @returns a value of type N (node), or null, or undefined.
    */
-  exemplarToNode(exemplar: BTNodeExemplar<K, V, N>): N | null | undefined {
+  exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, value?: V): N | null | undefined {
     if (exemplar === undefined) return;
 
     let node: N | null | undefined;
@@ -208,7 +209,7 @@ export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = Bi
     } else if (this.isNode(exemplar)) {
       node = exemplar;
     } else if (this.isNotNodeInstance(exemplar)) {
-      node = this.createNode(exemplar);
+      node = this.createNode(exemplar, value);
     } else {
       return;
     }
@@ -230,18 +231,21 @@ export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = Bi
    * Space Complexity O(1)
    */
 
+
   /**
    * Time Complexity O(log n) - O(n)
    * Space Complexity O(1)
-   *
-   * The `add` function adds a new node to a binary tree, either by key or by providing a node object.
-   * @param keyOrNodeOrEntry - The parameter `keyOrNodeOrEntry` can be one of the following:
-   * @returns The function `add` returns the inserted node (`N`), `null`, or `undefined`.
+   * 
+   * The `add` function adds a new node to a binary tree, either by creating a new node or replacing an
+   * existing node with the same key.
+   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be one of the following:
+   * @param {V} [value] - The value to be inserted into the binary tree.
+   * @returns The function `add` returns either a node (`N`), `null`, or `undefined`.
    */
-  add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | null | undefined {
+  add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | null | undefined {
 
     let inserted: N | null | undefined;
-    const newNode = this.exemplarToNode(keyOrNodeOrEntry);
+    const newNode = this.exemplarToNode(keyOrNodeOrEntry, value);
     if (newNode === undefined) return;
 
     const _bfs = (root: N, newNode: N | null): N | undefined | null => {
@@ -1775,7 +1779,7 @@ export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = Bi
    * @returns The `filter` method is returning a new tree object that contains the key-value pairs that
    * pass the given predicate function.
    */
-  filter(predicate: PairCallback<K, V | undefined, boolean>, thisArg?: any) {
+  filter(predicate: EntryCallback<K, V | undefined, boolean>, thisArg?: any) {
     const newTree = this.createTree();
     let index = 0;
     for (const [key, value] of this) {
@@ -1806,7 +1810,7 @@ export class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V, N> = Bi
    * will be used as the `this` value when the callback function is called. If you don't pass a value
    * @returns The `map` method is returning a new tree object.
    */
-  map(callback: PairCallback<K, V | undefined, V>, thisArg?: any) {
+  map(callback: EntryCallback<K, V | undefined, V>, thisArg?: any) {
     const newTree = this.createTree();
     let index = 0;
     for (const [key, value] of this) {

package/src/data-structures/binary-tree/bst.ts

@@ -154,13 +154,16 @@ export class BST<K = any, V = any, N extends BSTNode<K, V, N> = BSTNode<K, V, BS
     return exemplar instanceof BSTNode;
   }
 
+
   /**
-   * The function `exemplarToNode` takes an exemplar and returns a corresponding node if the exemplar
-   * is valid, otherwise it returns undefined.
-   * @param exemplar - The `exemplar` parameter is of type `BTNodeExemplar<K, V, N>`.
-   * @returns a variable `node` which is of type `N` or `undefined`.
+   * The function `exemplarToNode` takes an exemplar and returns a node if the exemplar is valid,
+   * otherwise it returns undefined.
+   * @param exemplar - The `exemplar` parameter is of type `BTNodeExemplar<K, V, N>`, where:
+   * @param {V} [value] - The `value` parameter is an optional value that can be passed to the
+   * `exemplarToNode` function. It represents the value associated with the exemplar node.
+   * @returns a node of type N or undefined.
    */
-  override exemplarToNode(exemplar: BTNodeExemplar<K, V, N>): N | undefined {
+  override exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, value?: V): N | undefined {
     let node: N | undefined;
     if (exemplar === null || exemplar === undefined) {
       return;
@@ -174,7 +177,7 @@ export class BST<K = any, V = any, N extends BSTNode<K, V, N> = BSTNode<K, V, BS
         node = this.createNode(key, value);
       }
     } else if (this.isNotNodeInstance(exemplar)) {
-      node = this.createNode(exemplar);
+      node = this.createNode(exemplar, value);
     } else {
       return;
     }
@@ -189,15 +192,17 @@ export class BST<K = any, V = any, N extends BSTNode<K, V, N> = BSTNode<K, V, BS
   /**
    * Time Complexity: O(log n) - Average case for a balanced tree. In the worst case (unbalanced tree), it can be O(n).
    * Space Complexity: O(1) - Constant space is used.
-   *
-   * The `add` function adds a new node to a binary search tree, either by key or by providing a node
-   * object.
-   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be one of the following:
-   * @returns The method returns either the newly added node (`newNode`) or `undefined` if the input
-   * (`keyOrNodeOrEntry`) is null, undefined, or does not match any of the expected types.
+   * 
+   * The `add` function adds a new node to a binary tree, updating the value if the key already exists
+   * or inserting a new node if the key is unique.
+   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can accept three types of values:
+   * @param {V} [value] - The `value` parameter represents the value associated with the key that is
+   * being added to the binary tree.
+   * @returns The method `add` returns either the newly added node (`newNode`) or `undefined` if the
+   * node was not added.
    */
-  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | undefined {
-    const newNode = this.exemplarToNode(keyOrNodeOrEntry);
+  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | undefined {
+    const newNode = this.exemplarToNode(keyOrNodeOrEntry, value);
     if (newNode === undefined) return;
 
     if (this.root === undefined) {

package/src/data-structures/binary-tree/rb-tree.ts

@@ -116,14 +116,14 @@ export class RedBlackTree<K = any, V = any, N extends RedBlackTreeNode<K, V, N>
   }
 
   /**
-   * The function `exemplarToNode` takes an exemplar and returns a node if the exemplar is valid,
-   * otherwise it returns undefined.
-   * @param exemplar - BTNodeExemplar<K, V, N> - A generic type representing an exemplar of a binary tree
-   * node. It can be either a node itself, an entry (key-value pair), a node key, or any other value
-   * that is not a valid exemplar.
-   * @returns a variable `node` which is of type `N | undefined`.
+   * The function `exemplarToNode` takes an exemplar and converts it into a node object if possible.
+   * @param exemplar - The `exemplar` parameter is of type `BTNodeExemplar<K, V, N>`, where:
+   * @param {V} [value] - The `value` parameter is an optional value that can be passed to the
+   * `exemplarToNode` function. It represents the value associated with the exemplar node. If a value
+   * is provided, it will be used when creating the new node. If no value is provided, the new node
+   * @returns a node of type N or undefined.
    */
-  override exemplarToNode(exemplar: BTNodeExemplar<K, V, N>): N | undefined {
+  override exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, value?: V): N | undefined {
     let node: N | undefined;
 
     if (exemplar === null || exemplar === undefined) {
@@ -138,7 +138,7 @@ export class RedBlackTree<K = any, V = any, N extends RedBlackTreeNode<K, V, N>
         node = this.createNode(key, value, RBTNColor.RED);
       }
     } else if (this.isNotNodeInstance(exemplar)) {
-      node = this.createNode(exemplar, undefined, RBTNColor.RED);
+      node = this.createNode(exemplar, value, RBTNColor.RED);
     } else {
       return;
     }
@@ -151,13 +151,19 @@ export class RedBlackTree<K = any, V = any, N extends RedBlackTreeNode<K, V, N>
    */
 
   /**
-   * The function adds a node to a Red-Black Tree data structure.
-   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be one of the following:
-   * @returns The method `add` returns either an instance of `N` (the node that was added) or
-   * `undefined`.
+   * 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 binary search tree and performs necessary rotations and
+   * color changes to maintain the red-black tree properties.
+   * @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 search tree.
+   * @returns The method `add` returns either the newly added node (`N`) or `undefined`.
    */
-  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | undefined {
-    const newNode = this.exemplarToNode(keyOrNodeOrEntry);
+  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | undefined {
+    const newNode = this.exemplarToNode(keyOrNodeOrEntry, value);
     if (newNode === undefined) return;
 
     newNode.left = this.Sentinel;

package/src/data-structures/binary-tree/tree-multimap.ts

@@ -85,15 +85,19 @@ export class TreeMultimap<K = any, V = any, N extends TreeMultimapNode<K, V, N>
     return exemplar instanceof TreeMultimapNode;
   }
 
+
   /**
    * The function `exemplarToNode` converts an exemplar object into a node object.
-   * @param exemplar - The `exemplar` parameter is of type `BTNodeExemplar<K, V, N>`, where `V` represents
-   * the value type and `N` represents the node type.
+   * @param exemplar - The `exemplar` parameter is of type `BTNodeExemplar<K, V, N>`, which means it
+   * can be one of the following:
+   * @param {V} [value] - The `value` parameter is an optional argument that represents the value
+   * associated with the node. It is of type `V`, which can be any data type. If no value is provided,
+   * it defaults to `undefined`.
    * @param [count=1] - The `count` parameter is an optional parameter that specifies the number of
-   * times the node should be created. If not provided, it defaults to 1.
-   * @returns a value of type `N` (the generic type parameter) or `undefined`.
+   * times the value should be added to the node. If not provided, it defaults to 1.
+   * @returns a node of type `N` or `undefined`.
    */
-  override exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, count = 1): N | undefined {
+  override exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, value?: V, count = 1): N | undefined {
     let node: N | undefined;
     if (exemplar === undefined || exemplar === null) {
       return;
@@ -107,7 +111,7 @@ export class TreeMultimap<K = any, V = any, N extends TreeMultimapNode<K, V, N>
         node = this.createNode(key, value, count);
       }
     } else if (this.isNotNodeInstance(exemplar)) {
-      node = this.createNode(exemplar, undefined, count);
+      node = this.createNode(exemplar, value, count);
     } else {
       return;
     }
@@ -122,17 +126,21 @@ export class TreeMultimap<K = any, V = any, N extends TreeMultimapNode<K, V, N>
   /**
    * 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 overrides the base class `add` function to add a new node to the tree multimap
-   * and update the count.
-   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be one of the following:
-   * @param [count=1] - The `count` parameter is an optional parameter that specifies the number of
-   * times the key or node or entry should be added to the multimap. If not provided, the default value
-   * is 1.
-   * @returns either a node (`N`) or `undefined`.
+   * 
+   * The function overrides the add method of a binary tree node and adds a new node to the tree.
+   * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be either a key, a node, or an
+   * entry. It represents the key, node, or entry that you want to add to the binary tree.
+   * @param {V} [value] - The `value` parameter represents the value associated with the key in the
+   * binary tree node. It is an optional parameter, meaning it can be omitted when calling the `add`
+   * method.
+   * @param [count=1] - The `count` parameter represents the number of times the key-value pair should
+   * be added to the binary tree. By default, it is set to 1, meaning that the key-value pair will be
+   * added once. However, you can specify a different value for `count` if you want to add
+   * @returns The method is returning either the newly inserted node or `undefined` if the insertion
+   * was not successful.
    */
-  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, count = 1): N | undefined {
-    const newNode = this.exemplarToNode(keyOrNodeOrEntry, count);
+  override add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V, count = 1): N | undefined {
+    const newNode = this.exemplarToNode(keyOrNodeOrEntry, value, count);
     if (newNode === undefined) return;
 
     const orgNodeCount = newNode?.count || 0;
@@ -190,7 +198,7 @@ export class TreeMultimap<K = any, V = any, N extends TreeMultimapNode<K, V, N>
         if (l > r) return;
         const m = l + Math.floor((r - l) / 2);
         const midNode = sorted[m];
-        this.add([midNode.key, midNode.value], midNode.count);
+        this.add(midNode.key, midNode.value, midNode.count);
         buildBalanceBST(l, m - 1);
         buildBalanceBST(m + 1, r);
       };
@@ -206,7 +214,7 @@ export class TreeMultimap<K = any, V = any, N extends TreeMultimapNode<K, V, N>
           if (l <= r) {
             const m = l + Math.floor((r - l) / 2);
             const midNode = sorted[m];
-            this.add([midNode.key, midNode.value], midNode.count);
+            this.add(midNode.key, midNode.value, midNode.count);
             stack.push([m + 1, r]);
             stack.push([l, m - 1]);
           }
@@ -327,7 +335,7 @@ export class TreeMultimap<K = any, V = any, N extends TreeMultimapNode<K, V, N>
    */
   override clone(): TREE {
     const cloned = this.createTree();
-    this.bfs(node => cloned.add([node.key, node.value], node.count));
+    this.bfs(node => cloned.add(node.key, node.value, node.count));
     return cloned;
   }