bst-typed 1.53.9 → 1.54.1

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

@@ -4,33 +4,39 @@ exports.RedBlackTree = exports.RedBlackTreeNode = void 0;
 const bst_1 = require("./bst");
 class RedBlackTreeNode extends bst_1.BSTNode {
     /**
-     * The constructor function initializes a Red-Black Tree Node with a key, an optional value, and a
-     * color.
-     * @param {K} key - The key parameter is of type K and represents the key of the node in the
-     * Red-Black Tree.
-     * @param {V} [value] - The `value` parameter is an optional parameter that represents the value
-     * associated with the key in the Red-Black Tree Node. It is not required and can be omitted when
-     * creating a new instance of the Red-Black Tree Node.
-     * @param {RBTNColor} color - The `color` parameter is used to specify the color of the Red-Black
-     * Tree Node. It is an optional parameter with a default value of `'BLACK'`.
+     * The constructor initializes a node with a key, value, and color for a Red-Black Tree.
+     * @param {K} key - The `key` parameter is a key of type `K` that is used to identify the node in a
+     * Red-Black Tree data structure.
+     * @param {V} [value] - The `value` parameter in the constructor is an optional parameter of type
+     * `V`. It represents the value associated with the key in the data structure being constructed.
+     * @param {RBTNColor} [color=BLACK] - The `color` parameter in the constructor is used to specify the
+     * color of the node in a Red-Black Tree. It has a default value of 'BLACK' if not provided
+     * explicitly.
      */
     constructor(key, value, color = 'BLACK') {
         super(key, value);
+        this.parent = undefined;
+        this._left = undefined;
+        this._right = undefined;
         this._color = color;
     }
-    /**
-     * The function returns the color value of a variable.
-     * @returns The color value stored in the private variable `_color`.
-     */
-    get color() {
-        return this._color;
+    get left() {
+        return this._left;
     }
-    /**
-     * The function sets the color property to the specified value.
-     * @param {RBTNColor} value - The value parameter is of type RBTNColor.
-     */
-    set color(value) {
-        this._color = value;
+    set left(v) {
+        if (v) {
+            v.parent = this;
+        }
+        this._left = v;
+    }
+    get right() {
+        return this._right;
+    }
+    set right(v) {
+        if (v) {
+            v.parent = this;
+        }
+        this._right = v;
     }
 }
 exports.RedBlackTreeNode = RedBlackTreeNode;
@@ -89,14 +95,15 @@ exports.RedBlackTreeNode = RedBlackTreeNode;
  */
 class RedBlackTree extends bst_1.BST {
     /**
-     * This is the constructor function for a Red-Black Tree data structure in TypeScript.
-     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter is an
-     * iterable object that can contain either keys, nodes, entries, or raw elements. It is used to
-     * initialize the RedBlackTree with the provided elements.
-     * @param [options] - The `options` parameter is an optional object that can be passed to the
-     * constructor. It is of type `RedBlackTreeOptions<K, V, R>`. This object can contain various options for
-     * configuring the behavior of the Red-Black Tree. The specific properties and their meanings would
-     * depend on the implementation
+     * This TypeScript constructor initializes a Red-Black Tree with optional keys, nodes, entries, or
+     * raw data.
+     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
+     * iterable that can contain either `BTNRep<K, V, RedBlackTreeNode<K, V>>` objects or `R` objects. It
+     * is used to initialize the Red-Black Tree with keys, nodes, entries, or
+     * @param [options] - The `options` parameter in the constructor is of type `RedBlackTreeOptions<K,
+     * V, R>`. It is an optional parameter that allows you to specify additional options for the
+     * RedBlackTree class. These options could include configuration settings, behavior customization, or
+     * any other parameters that are specific to
      */
     constructor(keysNodesEntriesOrRaws = [], options) {
         super([], options);
@@ -105,14 +112,13 @@ class RedBlackTree extends bst_1.BST {
             this.addMany(keysNodesEntriesOrRaws);
         }
     }
-    /**
-     * The function returns the root node of a tree or undefined if there is no root.
-     * @returns The root node of the tree structure, or undefined if there is no root node.
-     */
     get root() {
         return this._root;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function creates a new Red-Black Tree node with the specified key, value, and color.
      * @param {K} key - The key parameter represents the key value of the node being created. It is of
      * type K, which is a generic type that can be replaced with any specific type when using the
@@ -130,15 +136,14 @@ class RedBlackTree extends bst_1.BST {
         return new RedBlackTreeNode(key, this._isMapMode ? undefined : value, color);
     }
     /**
-     * The function `createTree` overrides the default implementation to create a Red-Black Tree with
-     * specified options in TypeScript.
-     * @param [options] - The `options` parameter in the `createTree` method is of type `RedBlackTreeOptions<K,
-     * V, R>`, which is a generic type with three type parameters `K`, `V`, and `R`. This parameter
-     * allows you to pass additional configuration options when creating a new Red-
-     * @returns A new instance of a RedBlackTree with the specified options and properties from the
-     * current object is being returned.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function creates a new Red-Black Tree with the specified options.
+     * @param [options] - The `options` parameter is an optional object that contains additional
+     * configuration options for creating the Red-Black Tree. It has the following properties:
+     * @returns a new instance of a RedBlackTree object.
      */
-    // @ts-ignore
     createTree(options) {
         return new RedBlackTree([], Object.assign({ iterationType: this.iterationType, isMapMode: this._isMapMode, specifyComparable: this._specifyComparable, toEntryFn: this._toEntryFn }, options));
     }
@@ -147,13 +152,13 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The function checks if the input is an instance of the RedBlackTreeNode class.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The parameter
-     * `keyNodeEntryOrRaw` can be of type `R` or `BTNRep<K, V, NODE>`.
-     * @returns a boolean value indicating whether the input parameter `keyNodeEntryOrRaw` is
+     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, RedBlackTreeNode<K, V>>`.
+     * @returns a boolean value indicating whether the input parameter `keyNodeOrEntry` is
      * an instance of the `RedBlackTreeNode` class.
      */
-    isNode(keyNodeEntryOrRaw) {
-        return keyNodeEntryOrRaw instanceof RedBlackTreeNode;
+    isNode(keyNodeOrEntry) {
+        return keyNodeOrEntry instanceof RedBlackTreeNode;
     }
     /**
      * Time Complexity: O(1)
@@ -168,12 +173,12 @@ class RedBlackTree extends bst_1.BST {
     }
     /**
      * Time Complexity: O(log n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(log n)
      *
      * The function adds a new node to a binary search tree and returns true if the node was successfully
      * added.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The parameter
-     * `keyNodeEntryOrRaw` can accept a value of type `R` or `BTNRep<K, V, NODE>`.
+     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can accept a value of type `R` or `BTNRep<K, V, RedBlackTreeNode<K, V>>`.
      * @param {V} [value] - The `value` parameter is an optional value that you want to associate with
      * the key in the data structure. It represents the value that you want to add or update in the data
      * structure.
@@ -181,8 +186,8 @@ class RedBlackTree extends bst_1.BST {
      * the method returns true. If the node already exists and its value is updated, the method also
      * returns true. If the node cannot be added or updated, the method returns false.
      */
-    add(keyNodeEntryOrRaw, value) {
-        const [newNode, newValue] = this._keyValueNodeEntryRawToNodeAndValue(keyNodeEntryOrRaw, value);
+    add(keyNodeOrEntry, value) {
+        const [newNode, newValue] = this._keyValueNodeOrEntryToNodeAndValue(keyNodeOrEntry, value);
         if (!this.isRealNode(newNode))
             return false;
         const insertStatus = this._insert(newNode);
@@ -208,35 +213,37 @@ class RedBlackTree extends bst_1.BST {
     }
     /**
      * Time Complexity: O(log n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(log n)
      *
      * The function overrides the delete method in a binary tree data structure to remove a node based on
      * a given predicate and maintain the binary search tree properties.
-     * @param {BTNRep<K, V, NODE> | R} keyNodeEntryOrRaw - The `keyNodeEntryOrRaw`
+     * @param {BTNRep<K, V, RedBlackTreeNode<K, V>>} keyNodeOrEntry - The `keyNodeOrEntry`
      * parameter in the `override delete` method is used to specify the condition or key based on which a
      * node should be deleted from the binary tree. It can be a key, a node, an entry, or a predicate
      * function that determines which node(s) should be deleted.
-     * @returns The `override delete` method is returning an array of `BinaryTreeDeleteResult<NODE>`
+     * @returns The `override delete` method is returning an array of `BinaryTreeDeleteResult<RedBlackTreeNode<K, V>>`
      * objects. Each object in the array contains information about the deleted node and whether
      * balancing is needed.
      */
-    delete(keyNodeEntryOrRaw) {
-        if (keyNodeEntryOrRaw === null)
+    delete(keyNodeOrEntry) {
+        if (keyNodeOrEntry === null)
             return [];
         const results = [];
         let nodeToDelete;
-        if (this._isPredicate(keyNodeEntryOrRaw))
-            nodeToDelete = this.getNode(keyNodeEntryOrRaw);
+        if (this._isPredicate(keyNodeOrEntry))
+            nodeToDelete = this.getNode(keyNodeOrEntry);
         else
-            nodeToDelete = this.isRealNode(keyNodeEntryOrRaw) ? keyNodeEntryOrRaw : this.getNode(keyNodeEntryOrRaw);
+            nodeToDelete = this.isRealNode(keyNodeOrEntry) ? keyNodeOrEntry : this.getNode(keyNodeOrEntry);
         if (!nodeToDelete) {
             return results;
         }
         let originalColor = nodeToDelete.color;
         let replacementNode;
         if (!this.isRealNode(nodeToDelete.left)) {
-            replacementNode = nodeToDelete.right;
-            this._transplant(nodeToDelete, nodeToDelete.right);
+            if (nodeToDelete.right !== null) {
+                replacementNode = nodeToDelete.right;
+                this._transplant(nodeToDelete, nodeToDelete.right);
+            }
         }
         else if (!this.isRealNode(nodeToDelete.right)) {
             replacementNode = nodeToDelete.left;
@@ -246,15 +253,18 @@ class RedBlackTree extends bst_1.BST {
             const successor = this.getLeftMost(node => node, nodeToDelete.right);
             if (successor) {
                 originalColor = successor.color;
-                replacementNode = successor.right;
+                if (successor.right !== null)
+                    replacementNode = successor.right;
                 if (successor.parent === nodeToDelete) {
                     if (this.isRealNode(replacementNode)) {
                         replacementNode.parent = successor;
                     }
                 }
                 else {
-                    this._transplant(successor, successor.right);
-                    successor.right = nodeToDelete.right;
+                    if (successor.right !== null) {
+                        this._transplant(successor, successor.right);
+                        successor.right = nodeToDelete.right;
+                    }
                     if (this.isRealNode(successor.right)) {
                         successor.right.parent = successor;
                     }
@@ -297,7 +307,6 @@ class RedBlackTree extends bst_1.BST {
      * @returns A new Red-Black Tree is being returned, where each entry has been transformed using the
      * provided callback function.
      */
-    // @ts-ignore
     map(callback, options, thisArg) {
         const newTree = new RedBlackTree([], options);
         let index = 0;
@@ -306,13 +315,26 @@ class RedBlackTree extends bst_1.BST {
         }
         return newTree;
     }
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The function `clone` overrides the default cloning behavior to create a deep copy of a tree
+     * structure.
+     * @returns The `cloned` object is being returned.
+     */
+    clone() {
+        const cloned = this.createTree();
+        this._clone(cloned);
+        return cloned;
+    }
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
      * The function sets the root of a tree-like structure and updates the parent property of the new
      * root.
-     * @param {NODE | undefined} v - v is a parameter of type NODE or undefined.
+     * @param {RedBlackTreeNode<K, V> | undefined} v - v is a parameter of type RedBlackTreeNode<K, V> or undefined.
      */
     _setRoot(v) {
         if (v) {
@@ -325,9 +347,9 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The function replaces an old node with a new node while preserving the color of the old node.
-     * @param {NODE} oldNode - The `oldNode` parameter represents the node that needs to be replaced in
+     * @param {RedBlackTreeNode<K, V>} oldNode - The `oldNode` parameter represents the node that needs to be replaced in
      * the data structure.
-     * @param {NODE} newNode - The `newNode` parameter is of type `NODE`, which represents a node in a
+     * @param {RedBlackTreeNode<K, V>} newNode - The `newNode` parameter is of type `RedBlackTreeNode<K, V>`, which represents a node in a
      * data structure.
      * @returns The method is returning the result of calling the `_replaceNode` method from the
      * superclass, with the `oldNode` and `newNode` parameters.
@@ -338,11 +360,11 @@ class RedBlackTree extends bst_1.BST {
     }
     /**
      * Time Complexity: O(log n)
-     * Space Complexity: O(1)
+     * Space Complexity: O(log n)
      *
      * The `_insert` function inserts a node into a binary search tree and performs necessary fix-ups to
      * maintain the red-black tree properties.
-     * @param {NODE} node - The `node` parameter represents the node that needs to be inserted into the
+     * @param {RedBlackTreeNode<K, V>} node - The `node` parameter represents the node that needs to be inserted into the
      * binary search tree.
      * @returns a string value indicating the result of the insertion operation. It can return either
      * 'UPDATED' if the node with the same key already exists and was updated, or 'CREATED' if a new node
@@ -387,9 +409,9 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The function `_transplant` is used to replace a node `u` with another node `v` in a binary tree.
-     * @param {NODE} u - The parameter "u" represents a node in a binary tree.
-     * @param {NODE | undefined} v - The parameter `v` is of type `NODE | undefined`, which means it can
-     * either be a `NODE` object or `undefined`.
+     * @param {RedBlackTreeNode<K, V>} u - The parameter "u" represents a node in a binary tree.
+     * @param {RedBlackTreeNode<K, V> | undefined} v - The parameter `v` is of type `RedBlackTreeNode<K, V> | undefined`, which means it can
+     * either be a `RedBlackTreeNode<K, V>` object or `undefined`.
      */
     _transplant(u, v) {
         if (!u.parent) {
@@ -410,11 +432,11 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The `_insertFixup` function is used to fix the Red-Black Tree after inserting a new node.
-     * @param {NODE | undefined} z - The parameter `z` represents a node in the Red-Black Tree data
+     * @param {RedBlackTreeNode<K, V> | undefined} z - The parameter `z` represents a node in the Red-Black Tree data
      * structure. It can either be a valid node or `undefined`.
      */
     _insertFixup(z) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         // Continue fixing the tree as long as the parent of z is red
         while (((_a = z === null || z === void 0 ? void 0 : z.parent) === null || _a === void 0 ? void 0 : _a.color) === 'RED') {
             // Check if the parent of z is the left child of its parent
@@ -448,7 +470,7 @@ class RedBlackTree extends bst_1.BST {
             else {
                 // Symmetric case for the right child (left and right exchanged)
                 // Follow the same logic as above with left and right exchanged
-                const y = (_d = (_c = z === null || z === void 0 ? void 0 : z.parent) === null || _c === void 0 ? void 0 : _c.parent) === null || _d === void 0 ? void 0 : _d.left;
+                const y = (_e = (_d = (_c = z === null || z === void 0 ? void 0 : z.parent) === null || _c === void 0 ? void 0 : _c.parent) === null || _d === void 0 ? void 0 : _d.left) !== null && _e !== void 0 ? _e : undefined;
                 if ((y === null || y === void 0 ? void 0 : y.color) === 'RED') {
                     z.parent.color = 'BLACK';
                     y.color = 'BLACK';
@@ -478,7 +500,7 @@ class RedBlackTree extends bst_1.BST {
      *
      * The `_deleteFixup` function is used to fix the red-black tree after a node deletion by adjusting
      * the colors and performing rotations.
-     * @param {NODE | undefined} node - The `node` parameter represents a node in a binary tree. It can
+     * @param {RedBlackTreeNode<K, V> | undefined} node - The `node` parameter represents a node in a binary tree. It can
      * be either a valid node object or `undefined`.
      * @returns The function does not return any value. It has a return type of `void`, which means it
      * does not return anything.
@@ -564,7 +586,7 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The `_leftRotate` function performs a left rotation on a given node in a binary tree.
-     * @param {NODE | undefined} x - The parameter `x` is of type `NODE | undefined`. It represents a
+     * @param {RedBlackTreeNode<K, V> | undefined} x - The parameter `x` is of type `RedBlackTreeNode<K, V> | undefined`. It represents a
      * node in a binary tree or `undefined` if there is no node.
      * @returns void, which means it does not return any value.
      */
@@ -595,7 +617,7 @@ class RedBlackTree extends bst_1.BST {
      * Space Complexity: O(1)
      *
      * The `_rightRotate` function performs a right rotation on a given node in a binary tree.
-     * @param {NODE | undefined} y - The parameter `y` is of type `NODE | undefined`. It represents a
+     * @param {RedBlackTreeNode<K, V> | undefined} y - The parameter `y` is of type `RedBlackTreeNode<K, V> | undefined`. It represents a
      * node in a binary tree or `undefined` if there is no node.
      * @returns void, which means it does not return any value.
      */

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

@@ -0,0 +1,212 @@
+/**
+ * data-structure-typed
+ *
+ * @author Pablo Zeng
+ * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { BinaryTreeDeleteResult, BSTNOptKeyOrNode, BTNRep, EntryCallback, IterationType, OptNodeOrNull, RBTNColor, TreeCounterOptions } from '../../types';
+import { IBinaryTree } from '../../interfaces';
+import { RedBlackTree, RedBlackTreeNode } from './red-black-tree';
+export declare class TreeCounterNode<K = any, V = any> extends RedBlackTreeNode<K, V> {
+    /**
+     * The constructor function initializes a Red-Black Tree node with a key, value, count, and color.
+     * @param {K} key - The key parameter represents the key of the node in the Red-Black Tree. It is
+     * used to identify and locate the node within the tree.
+     * @param {V} [value] - The `value` parameter is an optional parameter that represents the value
+     * associated with the key in the Red-Black Tree node. It is not required and can be omitted when
+     * creating a new node.
+     * @param [count=1] - The `count` parameter represents the number of occurrences of a particular key
+     * in the Red-Black Tree. It is an optional parameter with a default value of 1.
+     * @param {RBTNColor} [color=BLACK] - The `color` parameter is used to specify the color of the node
+     * in a Red-Black Tree. It is optional and has a default value of `'BLACK'`.
+     */
+    constructor(key: K, value?: V, count?: number, color?: RBTNColor);
+    parent?: TreeCounterNode<K, V>;
+    _left?: OptNodeOrNull<TreeCounterNode<K, V>>;
+    get left(): OptNodeOrNull<TreeCounterNode<K, V>>;
+    set left(v: OptNodeOrNull<TreeCounterNode<K, V>>);
+    _right?: OptNodeOrNull<TreeCounterNode<K, V>>;
+    get right(): OptNodeOrNull<TreeCounterNode<K, V>>;
+    set right(v: OptNodeOrNull<TreeCounterNode<K, V>>);
+}
+/**
+ *
+ */
+export declare class TreeCounter<K = any, V = any, R = object, MK = any, MV = any, MR = object> extends RedBlackTree<K, V, R, MK, MV, MR> implements IBinaryTree<K, V, R, MK, MV, MR> {
+    /**
+     * The constructor function initializes a TreeCounter object with optional initial data.
+     * @param keysNodesEntriesOrRaws - The parameter `keysNodesEntriesOrRaws` is an
+     * iterable that can contain keys, nodes, entries, or raw elements. It is used to initialize the
+     * TreeCounter with initial data.
+     * @param [options] - The `options` parameter is an optional object that can be used to customize the
+     * behavior of the `TreeCounter` constructor. It can include properties such as `compareKeys` and
+     * `compareValues`, which are functions used to compare keys and values respectively.
+     */
+    constructor(keysNodesEntriesOrRaws?: Iterable<BTNRep<K, V, TreeCounterNode<K, V>> | R>, options?: TreeCounterOptions<K, V, R>);
+    protected _count: number;
+    /**
+     * The function calculates the sum of the count property of all nodes in a tree structure.
+     * @returns the sum of the count property of all nodes in the tree.
+     */
+    get count(): number;
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
+     * The function calculates the sum of the count property of all nodes in a tree using depth-first
+     * search.
+     * @returns the sum of the count property of all nodes in the tree.
+     */
+    getComputedCount(): number;
+    /**
+     * The function creates a new TreeCounterNode with the specified key, value, color, and count.
+     * @param {K} key - The key parameter represents the key of the node being created. It is of type K,
+     * which is a generic type representing the type of keys in the tree.
+     * @param {V} [value] - The `value` parameter is an optional parameter that represents the value
+     * associated with the key in the node. It is of type `V`, which can be any data type.
+     * @param {RBTNColor} [color=BLACK] - The color parameter is used to specify the color of the node in
+     * a Red-Black Tree. It can have two possible values: 'RED' or 'BLACK'. The default value is 'BLACK'.
+     * @param {number} [count] - The `count` parameter represents the number of occurrences of a key in
+     * the tree. It is an optional parameter and is used to keep track of the number of values associated
+     * with a key in the tree.
+     * @returns A new instance of the TreeCounterNode class, casted as TreeCounterNode<K, V>.
+     */
+    createNode(key: K, value?: V, color?: RBTNColor, count?: number): TreeCounterNode<K, V>;
+    /**
+     * The function creates a new instance of a TreeCounter with the specified options and returns it.
+     * @param [options] - The `options` parameter is an optional object that contains additional
+     * configuration options for creating the `TreeCounter`. It is of type `TreeCounterOptions<K, V,
+     * R>`.
+     * @returns a new instance of the `TreeCounter` class, with the provided options merged with the
+     * existing `iterationType` property. The returned value is casted as `TREE`.
+     */
+    createTree(options?: TreeCounterOptions<K, V, R>): TreeCounter<K, V, R, MK, MV, MR>;
+    /**
+     * The function checks if the input is an instance of the TreeCounterNode class.
+     * @param {BTNRep<K, V, TreeCounterNode<K, V>>} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, TreeCounterNode<K, V>>`.
+     * @returns a boolean value indicating whether the input parameter `keyNodeOrEntry` is
+     * an instance of the `TreeCounterNode` class.
+     */
+    isNode(keyNodeOrEntry: BTNRep<K, V, TreeCounterNode<K, V>>): keyNodeOrEntry is TreeCounterNode<K, V>;
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
+     *
+     * The function overrides the add method of a class and adds a new node to a data structure, updating
+     * the count and returning a boolean indicating success.
+     * @param {BTNRep<K, V, TreeCounterNode<K, V>>} keyNodeOrEntry - The
+     * `keyNodeOrEntry` parameter can accept one of the following types:
+     * @param {V} [value] - The `value` parameter represents the value associated with the key in the
+     * data structure. It is an optional parameter, so it can be omitted if not needed.
+     * @param [count=1] - The `count` parameter represents the number of times the key-value pair should
+     * be added to the data structure. By default, it is set to 1, meaning that if no value is provided
+     * for `count`, the key-value pair will be added once.
+     * @returns The method is returning a boolean value. It returns true if the addition of the new node
+     * was successful, and false otherwise.
+     */
+    add(keyNodeOrEntry: BTNRep<K, V, TreeCounterNode<K, V>>, value?: V, count?: number): boolean;
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
+     *
+     * The function `delete` in TypeScript overrides the deletion operation in a binary tree data
+     * structure, handling cases where nodes have children and maintaining balance in the tree.
+     * @param {BTNRep<K, V, TreeCounterNode<K, V>>} keyNodeOrEntry - The `predicate`
+     * parameter in the `delete` method is used to specify the condition or key based on which a node
+     * should be deleted from the binary tree. It can be a key, a node, or an entry.
+     * @param [ignoreCount=false] - The `ignoreCount` parameter in the `override delete` method is a
+     * boolean flag that determines whether to ignore the count of nodes when performing deletion. If
+     * `ignoreCount` is set to `true`, the method will delete the node regardless of its count. If
+     * `ignoreCount` is `false
+     * @returns The `override delete` method returns an array of `BinaryTreeDeleteResult<TreeCounterNode<K, V>>` objects.
+     */
+    delete(keyNodeOrEntry: BTNRep<K, V, TreeCounterNode<K, V>>, ignoreCount?: boolean): BinaryTreeDeleteResult<TreeCounterNode<K, V>>[];
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The "clear" function overrides the parent class's "clear" function and also resets the count to
+     * zero.
+     */
+    clear(): void;
+    /**
+     * Time Complexity: O(n log n)
+     * Space Complexity: O(log n)
+     *
+     * 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} iterationType - The `iterationType` parameter is an optional parameter that
+     * specifies the type of iteration to use when building the balanced binary search tree. It has a
+     * default value of `this.iterationType`, which means it will use the iteration type specified by the
+     * `iterationType` property of the current object.
+     * @returns The function `perfectlyBalance` returns a boolean value. It returns `true` if the
+     * balancing operation is successful, and `false` if there are no nodes to balance.
+     */
+    perfectlyBalance(iterationType?: IterationType): boolean;
+    /**
+     * Time complexity: O(n)
+     * Space complexity: O(n)
+     *
+     * The function overrides the clone method to create a deep copy of a tree object.
+     * @returns The `clone()` method is returning a cloned instance of the `TREE` object.
+     */
+    clone(): TreeCounter<K, V, R, MK, MV, MR>;
+    /**
+     * The `map` function in TypeScript overrides the default behavior to create a new TreeCounter with
+     * modified entries based on a provided callback.
+     * @param callback - The `callback` parameter is a function that will be called for each entry in the
+     * map. It takes four arguments:
+     * @param [options] - The `options` parameter in the `override map` function is of type
+     * `TreeCounterOptions<MK, MV, MR>`. This parameter allows you to provide additional configuration
+     * options when creating a new `TreeCounter` instance within the `map` function. These options could
+     * include things like
+     * @param {any} [thisArg] - The `thisArg` parameter in the `override map` function is used to specify
+     * the value of `this` when executing the `callback` function. It allows you to set the context
+     * (value of `this`) for the callback function when it is called within the `map` function. This
+     * @returns A new TreeCounter instance is being returned, which is populated with entries generated
+     * by the provided callback function.
+     */
+    map(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: TreeCounterOptions<MK, MV, MR>, thisArg?: any): TreeCounter<MK, MV, MR>;
+    /**
+     * The function `keyValueNodeEntryRawToNodeAndValue` takes in a key, value, and count and returns a
+     * node based on the input.
+     * @param {BTNRep<K, V, TreeCounterNode<K, V>>} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, TreeCounterNode<K, V>>`.
+     * @param {V} [value] - The `value` parameter is an optional value that represents the value
+     * associated with the key in the node. It is used when creating a new node or updating the value of
+     * an existing node.
+     * @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 data structure. If not provided, it defaults to 1.
+     * @returns either a TreeCounterNode<K, V> object or undefined.
+     */
+    protected _keyValueNodeOrEntryToNodeAndValue(keyNodeOrEntry: BTNRep<K, V, TreeCounterNode<K, V>>, value?: V, count?: number): [TreeCounterNode<K, V> | undefined, V | undefined];
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `_swapProperties` function swaps the properties (key, value, count, color) between two nodes
+     * in a binary search tree.
+     * @param {R | BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>} srcNode - The `srcNode` parameter represents the source node
+     * that will be swapped with the `destNode`. It can be either an instance of the `R` class or an
+     * instance of the `BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>` class.
+     * @param {R | BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>} destNode - The `destNode` parameter represents the destination
+     * node where the properties will be swapped with the source node.
+     * @returns The method is returning the `destNode` after swapping its properties with the `srcNode`.
+     * If either `srcNode` or `destNode` is undefined, it returns undefined.
+     */
+    protected _swapProperties(srcNode: BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>, destNode: BSTNOptKeyOrNode<K, TreeCounterNode<K, V>>): TreeCounterNode<K, V> | undefined;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function replaces an old node with a new node and updates the count property of the new node.
+     * @param {TreeCounterNode<K, V>} oldNode - The `oldNode` parameter is the node that you want to replace in the data
+     * structure.
+     * @param {TreeCounterNode<K, V>} newNode - The `newNode` parameter is an instance of the `TreeCounterNode<K, V>` class.
+     * @returns The method is returning the result of calling the `_replaceNode` method from the
+     * superclass, which is of type `TreeCounterNode<K, V>`.
+     */
+    protected _replaceNode(oldNode: TreeCounterNode<K, V>, newNode: TreeCounterNode<K, V>): TreeCounterNode<K, V>;
+}