avl-tree-typed 1.48.4 → 1.48.6

package/dist/data-structures/base/iterable-base.d.ts

@@ -1,5 +1,5 @@
-import { ElementCallback, PairCallback, ReduceElementCallback, ReducePairCallback } from "../../types";
-export declare abstract class IterablePairBase<K = any, V = any> {
+import { ElementCallback, EntryCallback, ReduceElementCallback, ReduceEntryCallback } from "../../types";
+export declare abstract class IterableEntryBase<K = any, V = any> {
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -66,7 +66,7 @@ export declare abstract class IterablePairBase<K = any, V = any> {
      * @returns The `every` method is returning a boolean value. It returns `true` if every element in
      * the collection satisfies the provided predicate function, and `false` otherwise.
      */
-    every(predicate: PairCallback<K, V, boolean>, thisArg?: any): boolean;
+    every(predicate: EntryCallback<K, V, boolean>, thisArg?: any): boolean;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -86,7 +86,7 @@ export declare abstract class IterablePairBase<K = any, V = any> {
      * @returns a boolean value. It returns true if the predicate function returns true for any pair in
      * the collection, and false otherwise.
      */
-    some(predicate: PairCallback<K, V, boolean>, thisArg?: any): boolean;
+    some(predicate: EntryCallback<K, V, boolean>, thisArg?: any): boolean;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -104,7 +104,7 @@ export declare abstract class IterablePairBase<K = any, V = any> {
      * specify the value of `this` within the callback function. If `thisArg` is provided, it will be
      * used as the `this` value when calling the callback function. If `thisArg` is not provided, `
      */
-    forEach(callbackfn: PairCallback<K, V, void>, thisArg?: any): void;
+    forEach(callbackfn: EntryCallback<K, V, void>, thisArg?: any): void;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -125,7 +125,7 @@ export declare abstract class IterablePairBase<K = any, V = any> {
      * @returns The `reduce` method is returning the final value of the accumulator after iterating over
      * all the elements in the collection.
      */
-    reduce<U>(callbackfn: ReducePairCallback<K, V, U>, initialValue: U): U;
+    reduce<U>(callbackfn: ReduceEntryCallback<K, V, U>, initialValue: U): U;
     protected abstract _getIterator(...args: any[]): IterableIterator<[K, V]>;
 }
 export declare abstract class IterableElementBase<V> {

package/dist/data-structures/base/iterable-base.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IterableElementBase = exports.IterablePairBase = void 0;
-class IterablePairBase {
+exports.IterableElementBase = exports.IterableEntryBase = void 0;
+class IterableEntryBase {
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
@@ -173,7 +173,7 @@ class IterablePairBase {
         return accumulator;
     }
 }
-exports.IterablePairBase = IterablePairBase;
+exports.IterableEntryBase = IterableEntryBase;
 class IterableElementBase {
     /**
      * Time Complexity: O(n)

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

@@ -68,11 +68,13 @@ export declare class AVLTree<K = any, V = any, N extends AVLTreeNode<K, V, N> =
      *
      * 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.
      */
-    add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | undefined;
+    add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | undefined;
     /**
      * 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.

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

@@ -81,14 +81,16 @@ class AVLTree extends bst_1.BST {
      *
      * The function overrides the add method of a binary tree node and balances the tree after inserting
      * a new node.
-     * @param 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.
      */
-    add(keyOrNodeOrEntry) {
+    add(keyOrNodeOrEntry, value) {
         if (keyOrNodeOrEntry === null)
             return undefined;
-        const inserted = super.add(keyOrNodeOrEntry);
+        const inserted = super.add(keyOrNodeOrEntry, value);
         if (inserted)
             this._balancePath(inserted);
         return inserted;

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

@@ -6,9 +6,9 @@
  * @license MIT License
  */
 import type { BinaryTreeNodeNested, BinaryTreeOptions, BTNCallback, BTNodeEntry, BTNodeExemplar, BTNodeKeyOrNode } from '../../types';
-import { BinaryTreeNested, BinaryTreePrintOptions, BiTreeDeleteResult, DFSOrderPattern, FamilyPosition, IterationType, NodeDisplayLayout, PairCallback } from '../../types';
+import { BinaryTreeNested, BinaryTreePrintOptions, BiTreeDeleteResult, DFSOrderPattern, EntryCallback, FamilyPosition, IterationType, NodeDisplayLayout } from '../../types';
 import { IBinaryTree } from '../../interfaces';
-import { IterablePairBase } from "../base";
+import { IterableEntryBase } from "../base";
 /**
  * Represents a node in a binary tree.
  * @template V - The type of data stored in the node.
@@ -42,7 +42,7 @@ export declare class BinaryTreeNode<K = any, V = any, N extends BinaryTreeNode<K
  * 8. Full Trees: Every node has either 0 or 2 children.
  * 9. Complete Trees: All levels are fully filled except possibly the last, filled from left to right.
  */
-export declare 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> implements IBinaryTree<K, V, N, TREE> {
+export declare 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;
     /**
      * The constructor function initializes a binary tree object with optional elements and options.
@@ -82,13 +82,14 @@ export declare class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V,
      */
     isNode(exemplar: BTNodeExemplar<K, V, N>): exemplar is N;
     /**
-     * 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;
     /**
      * The function checks if a given value is an entry in a binary tree node.
      * @param kne - BTNodeExemplar<K, V,N> - A generic type representing a node in a binary tree. It has
@@ -104,11 +105,13 @@ export declare class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V,
      * 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;
     /**
      * Time Complexity: O(k log n) - O(k * n)
      * Space Complexity: O(1)
@@ -118,14 +121,13 @@ export declare class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V,
      * Time Complexity: O(k log n) - O(k * n)
      * Space Complexity: O(1)
      *
-     * The function `addMany` takes in an iterable of `BTNodeExemplar` objects, adds each object to the
-     * current instance, and returns an array of the inserted nodes.
-     * @param nodes - The `nodes` parameter is an iterable (such as an array or a set) of
-     * `BTNodeExemplar<K, V,N>` objects.
-     * @returns The function `addMany` returns an array of values, where each value is either of type
-     * `N`, `null`, or `undefined`.
+     * The `addMany` function takes in a collection of nodes and an optional collection of values, and
+     * adds each node with its corresponding value to the data structure.
+     * @param nodes - An iterable collection of BTNodeExemplar objects.
+     * @param [values] - An optional iterable of values that will be assigned to each node being added.
+     * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values.
      */
-    addMany(nodes: Iterable<BTNodeExemplar<K, V, N>>): (N | null | undefined)[];
+    addMany(nodes: Iterable<BTNodeExemplar<K, V, N>>, values?: Iterable<V | undefined>): (N | null | undefined)[];
     /**
      * Time Complexity: O(k * n)  "n" is the number of nodes in the tree, and "k" is the number of keys to be inserted.
      * Space Complexity: O(1)
@@ -495,7 +497,7 @@ export declare class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V,
      * @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): TREE;
+    filter(predicate: EntryCallback<K, V | undefined, boolean>, thisArg?: any): TREE;
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -515,7 +517,7 @@ export declare class BinaryTree<K = any, V = any, N extends BinaryTreeNode<K, V,
      * 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): TREE;
+    map(callback: EntryCallback<K, V | undefined, V>, thisArg?: any): TREE;
     /**
      * The `print` function is used to display a binary tree structure in a visually appealing way.
      * @param {K | N | null | undefined} [beginRoot=this.root] - The `root` parameter is of type `K | N | null |

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

@@ -70,7 +70,7 @@ exports.BinaryTreeNode = BinaryTreeNode;
  * 8. Full Trees: Every node has either 0 or 2 children.
  * 9. Complete Trees: All levels are fully filled except possibly the last, filled from left to right.
  */
-class BinaryTree extends base_1.IterablePairBase {
+class BinaryTree extends base_1.IterableEntryBase {
     /**
      * The constructor function initializes a binary tree object with optional elements and options.
      * @param [elements] - An optional iterable of BTNodeExemplar objects. These objects represent the
@@ -135,13 +135,14 @@ class BinaryTree extends base_1.IterablePairBase {
         return exemplar instanceof BinaryTreeNode;
     }
     /**
-     * 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) {
+    exemplarToNode(exemplar, value) {
         if (exemplar === undefined)
             return;
         let node;
@@ -164,7 +165,7 @@ class BinaryTree extends base_1.IterablePairBase {
             node = exemplar;
         }
         else if (this.isNotNodeInstance(exemplar)) {
-            node = this.createNode(exemplar);
+            node = this.createNode(exemplar, value);
         }
         else {
             return;
@@ -188,13 +189,15 @@ class BinaryTree extends base_1.IterablePairBase {
      * 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) {
+    add(keyOrNodeOrEntry, value) {
         let inserted;
-        const newNode = this.exemplarToNode(keyOrNodeOrEntry);
+        const newNode = this.exemplarToNode(keyOrNodeOrEntry, value);
         if (newNode === undefined)
             return;
         const _bfs = (root, newNode) => {
@@ -238,18 +241,28 @@ class BinaryTree extends base_1.IterablePairBase {
      * Time Complexity: O(k log n) - O(k * n)
      * Space Complexity: O(1)
      *
-     * The function `addMany` takes in an iterable of `BTNodeExemplar` objects, adds each object to the
-     * current instance, and returns an array of the inserted nodes.
-     * @param nodes - The `nodes` parameter is an iterable (such as an array or a set) of
-     * `BTNodeExemplar<K, V,N>` objects.
-     * @returns The function `addMany` returns an array of values, where each value is either of type
-     * `N`, `null`, or `undefined`.
-     */
-    addMany(nodes) {
+     * The `addMany` function takes in a collection of nodes and an optional collection of values, and
+     * adds each node with its corresponding value to the data structure.
+     * @param nodes - An iterable collection of BTNodeExemplar objects.
+     * @param [values] - An optional iterable of values that will be assigned to each node being added.
+     * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values.
+     */
+    addMany(nodes, values) {
         // TODO not sure addMany not be run multi times
         const inserted = [];
+        let valuesIterator;
+        if (values) {
+            valuesIterator = values[Symbol.iterator]();
+        }
         for (const kne of nodes) {
-            inserted.push(this.add(kne));
+            let value = undefined;
+            if (valuesIterator) {
+                const valueResult = valuesIterator.next();
+                if (!valueResult.done) {
+                    value = valueResult.value;
+                }
+            }
+            inserted.push(this.add(kne, value));
         }
         return inserted;
     }

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

@@ -80,12 +80,14 @@ export declare class BST<K = any, V = any, N extends BSTNode<K, V, N> = BSTNode<
      */
     isNode(exemplar: BTNodeExemplar<K, V, N>): exemplar is N;
     /**
-     * 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.
      */
-    exemplarToNode(exemplar: BTNodeExemplar<K, V, N>): N | undefined;
+    exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, value?: V): N | undefined;
     /**
      * 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.
@@ -94,13 +96,15 @@ export declare class BST<K = any, V = any, N extends BSTNode<K, V, N> = BSTNode<
      * 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.
      */
-    add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | undefined;
+    add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | undefined;
     /**
      * Time Complexity: O(k log n) - Adding each element individually in a balanced tree.
      * Space Complexity: O(k) - Additional space is required for the sorted array.
@@ -109,19 +113,23 @@ export declare class BST<K = any, V = any, N extends BSTNode<K, V, N> = BSTNode<
      * Time Complexity: O(k log n) - Adding each element individually in a balanced tree.
      * Space Complexity: O(k) - Additional space is required for the sorted array.
      *
-     * The `addMany` function in TypeScript adds multiple nodes to a binary tree, either in a balanced or
-     * unbalanced manner, and returns an array of the inserted nodes.
-     * @param keysOrNodesOrEntries - An iterable containing keys, nodes, or entries to be added to the
-     * binary tree.
-     * @param [isBalanceAdd=true] - A boolean flag indicating whether the tree should be balanced after
-     * adding the nodes. The default value is true.
+     * The `addMany` function in TypeScript adds multiple keys or nodes to a binary tree, optionally
+     * balancing the tree after each addition.
+     * @param keysOrNodesOrEntries - An iterable containing the keys, nodes, or entries to be added to
+     * the binary tree.
+     * @param [values] - An optional iterable of values to be associated with the keys or nodes being
+     * added. If provided, the values will be assigned to the corresponding keys or nodes in the same
+     * order. If not provided, undefined will be assigned as the value for each key or node.
+     * @param [isBalanceAdd=true] - A boolean flag indicating whether the add operation should be
+     * balanced or not. If set to true, the add operation will be balanced using a binary search tree
+     * algorithm. If set to false, the add operation will not be balanced and the elements will be added
+     * in the order they appear in the input.
      * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
-     * type of iteration to use when adding multiple keys or nodes to the binary tree. It has a default
-     * value of `this.iterationType`, which means it will use the iteration type specified by the binary
-     * tree instance.
-     * @returns The `addMany` function returns an array of `N` or `undefined` values.
+     * type of iteration to use when adding multiple keys or nodes. It has a default value of
+     * `this.iterationType`, which suggests that it is a property of the current object.
+     * @returns The function `addMany` returns an array of nodes (`N`) or `undefined` values.
      */
-    addMany(keysOrNodesOrEntries: Iterable<BTNodeExemplar<K, V, N>>, isBalanceAdd?: boolean, iterationType?: IterationType): (N | undefined)[];
+    addMany(keysOrNodesOrEntries: Iterable<BTNodeExemplar<K, V, N>>, values?: Iterable<V | undefined>, isBalanceAdd?: boolean, iterationType?: IterationType): (N | undefined)[];
     /**
      * Time Complexity: O(log n) - Average case for a balanced tree.
      * Space Complexity: O(1) - Constant space is used.

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

@@ -112,12 +112,14 @@ class BST extends binary_tree_1.BinaryTree {
         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.
      */
-    exemplarToNode(exemplar) {
+    exemplarToNode(exemplar, value) {
         let node;
         if (exemplar === null || exemplar === undefined) {
             return;
@@ -135,7 +137,7 @@ class BST extends binary_tree_1.BinaryTree {
             }
         }
         else if (this.isNotNodeInstance(exemplar)) {
-            node = this.createNode(exemplar);
+            node = this.createNode(exemplar, value);
         }
         else {
             return;
@@ -150,14 +152,16 @@ class BST extends binary_tree_1.BinaryTree {
      * 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.
      */
-    add(keyOrNodeOrEntry) {
-        const newNode = this.exemplarToNode(keyOrNodeOrEntry);
+    add(keyOrNodeOrEntry, value) {
+        const newNode = this.exemplarToNode(keyOrNodeOrEntry, value);
         if (newNode === undefined)
             return;
         if (this.root === undefined) {
@@ -207,23 +211,32 @@ class BST extends binary_tree_1.BinaryTree {
      * Time Complexity: O(k log n) - Adding each element individually in a balanced tree.
      * Space Complexity: O(k) - Additional space is required for the sorted array.
      *
-     * The `addMany` function in TypeScript adds multiple nodes to a binary tree, either in a balanced or
-     * unbalanced manner, and returns an array of the inserted nodes.
-     * @param keysOrNodesOrEntries - An iterable containing keys, nodes, or entries to be added to the
-     * binary tree.
-     * @param [isBalanceAdd=true] - A boolean flag indicating whether the tree should be balanced after
-     * adding the nodes. The default value is true.
+     * The `addMany` function in TypeScript adds multiple keys or nodes to a binary tree, optionally
+     * balancing the tree after each addition.
+     * @param keysOrNodesOrEntries - An iterable containing the keys, nodes, or entries to be added to
+     * the binary tree.
+     * @param [values] - An optional iterable of values to be associated with the keys or nodes being
+     * added. If provided, the values will be assigned to the corresponding keys or nodes in the same
+     * order. If not provided, undefined will be assigned as the value for each key or node.
+     * @param [isBalanceAdd=true] - A boolean flag indicating whether the add operation should be
+     * balanced or not. If set to true, the add operation will be balanced using a binary search tree
+     * algorithm. If set to false, the add operation will not be balanced and the elements will be added
+     * in the order they appear in the input.
      * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
-     * type of iteration to use when adding multiple keys or nodes to the binary tree. It has a default
-     * value of `this.iterationType`, which means it will use the iteration type specified by the binary
-     * tree instance.
-     * @returns The `addMany` function returns an array of `N` or `undefined` values.
+     * type of iteration to use when adding multiple keys or nodes. It has a default value of
+     * `this.iterationType`, which suggests that it is a property of the current object.
+     * @returns The function `addMany` returns an array of nodes (`N`) or `undefined` values.
      */
-    addMany(keysOrNodesOrEntries, isBalanceAdd = true, iterationType = this.iterationType) {
+    addMany(keysOrNodesOrEntries, values, isBalanceAdd = true, iterationType = this.iterationType) {
         const inserted = [];
+        let valuesIterator;
+        if (values) {
+            valuesIterator = values[Symbol.iterator]();
+        }
         if (!isBalanceAdd) {
             for (const kve of keysOrNodesOrEntries) {
-                const nn = this.add(kve);
+                const value = valuesIterator === null || valuesIterator === void 0 ? void 0 : valuesIterator.next().value;
+                const nn = this.add(kve, value);
                 inserted.push(nn);
             }
             return inserted;
@@ -237,7 +250,6 @@ class BST extends binary_tree_1.BinaryTree {
         for (const kve of keysOrNodesOrEntries) {
             isRealBTNExemplar(kve) && realBTNExemplars.push(kve);
         }
-        // TODO this addMany function is inefficient, it should be optimized
         let sorted = [];
         sorted = realBTNExemplars.sort((a, b) => {
             let aR, bR;

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

@@ -66,25 +66,31 @@ export declare class RedBlackTree<K = any, V = any, N extends RedBlackTreeNode<K
      */
     isNode(exemplar: BTNodeExemplar<K, V, N>): exemplar is 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.
      */
-    exemplarToNode(exemplar: BTNodeExemplar<K, V, N>): N | undefined;
+    exemplarToNode(exemplar: BTNodeExemplar<K, V, N>, value?: V): N | undefined;
     /**
      * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
      * Space Complexity: O(1)
      */
     /**
-     * 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`.
-     */
-    add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>): N | 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`.
+     */
+    add(keyOrNodeOrEntry: BTNodeExemplar<K, V, N>, value?: V): N | undefined;
     /**
      * Time Complexity: O(log n) on average (where n is the number of nodes in the tree)
      * Space Complexity: O(1)

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

@@ -86,14 +86,14 @@ class RedBlackTree extends bst_1.BST {
         return exemplar instanceof RedBlackTreeNode;
     }
     /**
-     * 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.
      */
-    exemplarToNode(exemplar) {
+    exemplarToNode(exemplar, value) {
         let node;
         if (exemplar === null || exemplar === undefined) {
             return;
@@ -111,7 +111,7 @@ class RedBlackTree extends bst_1.BST {
             }
         }
         else if (this.isNotNodeInstance(exemplar)) {
-            node = this.createNode(exemplar, undefined, types_1.RBTNColor.RED);
+            node = this.createNode(exemplar, value, types_1.RBTNColor.RED);
         }
         else {
             return;
@@ -123,13 +123,19 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      */
     /**
-     * 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`.
      */
-    add(keyOrNodeOrEntry) {
-        const newNode = this.exemplarToNode(keyOrNodeOrEntry);
+    add(keyOrNodeOrEntry, value) {
+        const newNode = this.exemplarToNode(keyOrNodeOrEntry, value);
         if (newNode === undefined)
             return;
         newNode.left = this.Sentinel;