data-structure-typed 1.54.0 → 1.54.2

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

@@ -0,0 +1,100 @@
+/**
+ * data-structure-typed
+ *
+ * @author Pablo Zeng
+ * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { AVLTreeMultiMapOptions, BTNRep, OptNodeOrNull } from '../../types';
+import { AVLTree, AVLTreeNode } from './avl-tree';
+import { IBinaryTree } from '../../interfaces';
+export declare class AVLTreeMultiMapNode<K = any, V = any> extends AVLTreeNode<K, V[]> {
+    /**
+     * This TypeScript constructor initializes an object with a key of type K and an array of values of
+     * type V.
+     * @param {K} key - The `key` parameter is typically used to store a unique identifier or key for the
+     * data being stored in the data structure. It helps in quickly accessing or retrieving the
+     * associated value in the data structure.
+     * @param {V[]} value - The `value` parameter in the constructor represents an array of values of
+     * type `V`.
+     */
+    constructor(key: K, value: V[]);
+    parent?: AVLTreeMultiMapNode<K, V>;
+    _left?: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    get left(): OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    set left(v: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>);
+    _right?: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    get right(): OptNodeOrNull<AVLTreeMultiMapNode<K, V>>;
+    set right(v: OptNodeOrNull<AVLTreeMultiMapNode<K, V>>);
+}
+/**
+ *
+ */
+export declare class AVLTreeMultiMap<K = any, V = any, R = object, MK = any, MV = any, MR = object> extends AVLTree<K, V[], R, MK, MV[], MR> implements IBinaryTree<K, V[], R, MK, MV, MR> {
+    /**
+     * The constructor initializes an AVLTreeMultiMap with the provided keys, nodes, entries, or raw data
+     * and options.
+     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
+     * iterable that can contain either key-value pairs represented as `BTNRep<K, V[],
+     * AVLTreeMultiMapNode<K, V>>` or raw data represented as `R`. This parameter is used to initialize
+     * the AVLTreeMulti
+     * @param [options] - The `options` parameter in the constructor is of type
+     * `AVLTreeMultiMapOptions<K, V[], R>`. It is an optional parameter that allows you to specify
+     * additional options for configuring the AVLTreeMultiMap instance.
+     */
+    constructor(keysNodesEntriesOrRaws?: Iterable<BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | R>, options?: AVLTreeMultiMapOptions<K, V[], R>);
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function `createTree` in TypeScript overrides the creation of an AVLTreeMultiMap with
+     * specified options.
+     * @param [options] - The `options` parameter in the `createTree` function is of type
+     * `AVLTreeMultiMapOptions<K, V[], R>`. This means it is an object that can have properties of type
+     * `K`, `V[]`, and `R`. The function creates a new `AVL
+     * @returns The `createTree` method is returning a new instance of `AVLTreeMultiMap` with the
+     * provided options.
+     */
+    createTree(options?: AVLTreeMultiMapOptions<K, V[], R>): AVLTreeMultiMap<K, V, R, MK, MV, MR>;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function `createNode` overrides the method to create a new AVLTreeMultiMapNode with a
+     * specified key and an empty array of values.
+     * @param {K} key - The `key` parameter in the `createNode` method represents the key of the node
+     * that will be created in the AVLTreeMultiMap.
+     * @returns An AVLTreeMultiMapNode object is being returned, initialized with the provided key and an
+     * empty array.
+     */
+    createNode(key: K): AVLTreeMultiMapNode<K, V>;
+    add(node: BTNRep<K, V[], AVLTreeMultiMapNode<K, V>>): boolean;
+    add(key: K, value: V): boolean;
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(log n)
+     *
+     * The function `deleteValue` removes a specific value from a key in an AVLTreeMultiMap data
+     * structure and deletes the entire node if no values are left for that key.
+     * @param {BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | K} keyNodeOrEntry - The `keyNodeOrEntry`
+     * parameter in the `deleteValue` function can be either a `BTNRep` object representing a key-value
+     * pair in the AVLTreeMultiMapNode, or just the key itself.
+     * @param {V} value - The `value` parameter in the `deleteValue` function represents the specific
+     * value that you want to delete from the multi-map data structure associated with a particular key.
+     * The function checks if the value exists in the array of values associated with the key, and if
+     * found, removes it from the array.
+     * @returns The `deleteValue` function returns a boolean value. It returns `true` if the specified
+     * `value` was successfully deleted from the array of values associated with the `keyNodeOrEntry`. If
+     * the value was not found in the array, it returns `false`.
+     */
+    deleteValue(keyNodeOrEntry: BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | K, value: V): boolean;
+    /**
+     * 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 A cloned tree object is being returned.
+     */
+    clone(): AVLTreeMultiMap<K, V, R, MK, MV, MR>;
+}

package/dist/esm/data-structures/binary-tree/avl-tree-multi-map.js

@@ -0,0 +1,191 @@
+import { AVLTree, AVLTreeNode } from './avl-tree';
+export class AVLTreeMultiMapNode extends AVLTreeNode {
+    /**
+     * This TypeScript constructor initializes an object with a key of type K and an array of values of
+     * type V.
+     * @param {K} key - The `key` parameter is typically used to store a unique identifier or key for the
+     * data being stored in the data structure. It helps in quickly accessing or retrieving the
+     * associated value in the data structure.
+     * @param {V[]} value - The `value` parameter in the constructor represents an array of values of
+     * type `V`.
+     */
+    constructor(key, value) {
+        super(key, value);
+    }
+    parent = undefined;
+    _left = undefined;
+    get left() {
+        return this._left;
+    }
+    set left(v) {
+        if (v) {
+            v.parent = this;
+        }
+        this._left = v;
+    }
+    _right = undefined;
+    get right() {
+        return this._right;
+    }
+    set right(v) {
+        if (v) {
+            v.parent = this;
+        }
+        this._right = v;
+    }
+}
+/**
+ *
+ */
+export class AVLTreeMultiMap extends AVLTree {
+    /**
+     * The constructor initializes an AVLTreeMultiMap with the provided keys, nodes, entries, or raw data
+     * and options.
+     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
+     * iterable that can contain either key-value pairs represented as `BTNRep<K, V[],
+     * AVLTreeMultiMapNode<K, V>>` or raw data represented as `R`. This parameter is used to initialize
+     * the AVLTreeMulti
+     * @param [options] - The `options` parameter in the constructor is of type
+     * `AVLTreeMultiMapOptions<K, V[], R>`. It is an optional parameter that allows you to specify
+     * additional options for configuring the AVLTreeMultiMap instance.
+     */
+    constructor(keysNodesEntriesOrRaws = [], options) {
+        super([], { ...options, isMapMode: true });
+        if (keysNodesEntriesOrRaws) {
+            this.addMany(keysNodesEntriesOrRaws);
+        }
+    }
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function `createTree` in TypeScript overrides the creation of an AVLTreeMultiMap with
+     * specified options.
+     * @param [options] - The `options` parameter in the `createTree` function is of type
+     * `AVLTreeMultiMapOptions<K, V[], R>`. This means it is an object that can have properties of type
+     * `K`, `V[]`, and `R`. The function creates a new `AVL
+     * @returns The `createTree` method is returning a new instance of `AVLTreeMultiMap` with the
+     * provided options.
+     */
+    createTree(options) {
+        return new AVLTreeMultiMap([], {
+            iterationType: this.iterationType,
+            specifyComparable: this._specifyComparable,
+            toEntryFn: this._toEntryFn,
+            isReverse: this._isReverse,
+            ...options
+        });
+    }
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function `createNode` overrides the method to create a new AVLTreeMultiMapNode with a
+     * specified key and an empty array of values.
+     * @param {K} key - The `key` parameter in the `createNode` method represents the key of the node
+     * that will be created in the AVLTreeMultiMap.
+     * @returns An AVLTreeMultiMapNode object is being returned, initialized with the provided key and an
+     * empty array.
+     */
+    createNode(key) {
+        return new AVLTreeMultiMapNode(key, []);
+    }
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(log n)
+     *
+     * The function `add` in TypeScript overrides the superclass method to add key-value pairs to an AVL
+     * tree multi-map.
+     * @param {BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | K} keyNodeOrEntry - The `keyNodeOrEntry`
+     * parameter in the `override add` method can be either a key-value pair entry or just a key. If it
+     * is a key-value pair entry, it will be in the format `[key, values]`, where `key` is the key and
+     * `values`
+     * @param {V} [value] - The `value` parameter in the `override add` method represents the value that
+     * you want to add to the AVLTreeMultiMap. It can be a single value or an array of values associated
+     * with a specific key.
+     * @returns The `override add` method is returning a boolean value, which indicates whether the
+     * addition operation was successful or not.
+     */
+    add(keyNodeOrEntry, value) {
+        if (this.isRealNode(keyNodeOrEntry))
+            return super.add(keyNodeOrEntry);
+        const _commonAdd = (key, values) => {
+            if (key === undefined || key === null)
+                return false;
+            const existingValues = this.get(key);
+            if (existingValues !== undefined && values !== undefined) {
+                for (const value of values)
+                    existingValues.push(value);
+                return true;
+            }
+            const existingNode = this.getNode(key);
+            if (this.isRealNode(existingNode)) {
+                if (existingValues === undefined) {
+                    super.add(key, values);
+                    return true;
+                }
+                if (values !== undefined) {
+                    for (const value of values)
+                        existingValues.push(value);
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+            else {
+                return super.add(key, values);
+            }
+        };
+        if (this.isEntry(keyNodeOrEntry)) {
+            const [key, values] = keyNodeOrEntry;
+            return _commonAdd(key, value !== undefined ? [value] : values);
+        }
+        return _commonAdd(keyNodeOrEntry, value !== undefined ? [value] : undefined);
+    }
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(log n)
+     *
+     * The function `deleteValue` removes a specific value from a key in an AVLTreeMultiMap data
+     * structure and deletes the entire node if no values are left for that key.
+     * @param {BTNRep<K, V[], AVLTreeMultiMapNode<K, V>> | K} keyNodeOrEntry - The `keyNodeOrEntry`
+     * parameter in the `deleteValue` function can be either a `BTNRep` object representing a key-value
+     * pair in the AVLTreeMultiMapNode, or just the key itself.
+     * @param {V} value - The `value` parameter in the `deleteValue` function represents the specific
+     * value that you want to delete from the multi-map data structure associated with a particular key.
+     * The function checks if the value exists in the array of values associated with the key, and if
+     * found, removes it from the array.
+     * @returns The `deleteValue` function returns a boolean value. It returns `true` if the specified
+     * `value` was successfully deleted from the array of values associated with the `keyNodeOrEntry`. If
+     * the value was not found in the array, it returns `false`.
+     */
+    deleteValue(keyNodeOrEntry, value) {
+        const values = this.get(keyNodeOrEntry);
+        if (Array.isArray(values)) {
+            const index = values.indexOf(value);
+            if (index === -1)
+                return false;
+            values.splice(index, 1);
+            // If no values left, remove the entire node
+            if (values.length === 0)
+                this.delete(keyNodeOrEntry);
+            return true;
+        }
+        return false;
+    }
+    /**
+     * 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 A cloned tree object is being returned.
+     */
+    clone() {
+        const cloned = this.createTree();
+        this._clone(cloned);
+        return cloned;
+    }
+}
+//# sourceMappingURL=avl-tree-multi-map.js.map

package/dist/esm/data-structures/binary-tree/avl-tree-multi-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avl-tree-multi-map.js","sourceRoot":"","sources":["../../../../src/data-structures/binary-tree/avl-tree-multi-map.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGlD,MAAM,OAAO,mBAAsC,SAAQ,WAAmB;IAC5E;;;;;;;;OAQG;IACH,YAAY,GAAM,EAAE,KAAU;QAC5B,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpB,CAAC;IAEQ,MAAM,GAA+B,SAAS,CAAC;IAE/C,KAAK,GAA8C,SAAS,CAAC;IAEtE,IAAa,IAAI;QACf,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAa,IAAI,CAAC,CAA2C;QAC3D,IAAI,CAAC,EAAE,CAAC;YACN,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC;QAClB,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;IACjB,CAAC;IAEQ,MAAM,GAA8C,SAAS,CAAC;IAEvE,IAAa,KAAK;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAa,KAAK,CAAC,CAA2C;QAC5D,IAAI,CAAC,EAAE,CAAC;YACN,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC;QAClB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,eACX,SAAQ,OAAgC;IAGxC;;;;;;;;;;OAUG;IACH,YACE,yBAAkF,EAAE,EACpF,OAA2C;QAE3C,KAAK,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3C,IAAI,sBAAsB,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACM,UAAU,CAAC,OAA2C;QAC7D,OAAO,IAAI,eAAe,CAAsB,EAAE,EAAE;YAClD,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;YAC1C,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACM,UAAU,CAAC,GAAM;QACxB,OAAO,IAAI,mBAAmB,CAAO,GAAG,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAMD;;;;;;;;;;;;;;;OAeG;IACM,GAAG,CAAC,cAA6D,EAAE,KAAS;QACnF,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YAAE,OAAO,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAEtE,MAAM,UAAU,GAAG,CAAC,GAAwB,EAAE,MAAY,EAAE,EAAE;YAC5D,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI;gBAAE,OAAO,KAAK,CAAC;YAEpD,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACrC,IAAI,cAAc,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzD,KAAK,MAAM,KAAK,IAAI,MAAM;oBAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvD,OAAO,IAAI,CAAC;YACd,CAAC;YAED,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;gBAClC,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;oBACjC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;oBACvB,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;oBACzB,KAAK,MAAM,KAAK,IAAI,MAAM;wBAAE,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACvD,OAAO,IAAI,CAAC;gBACd,CAAC;qBAAM,CAAC;oBACN,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC;YACrC,OAAO,UAAU,CAAC,GAAG,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACjE,CAAC;QAED,OAAO,UAAU,CAAC,cAAc,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,cAA6D,EAAE,KAAQ;QACjF,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YAExB,4CAA4C;YAC5C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;YAErD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACM,KAAK;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

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

@@ -0,0 +1,234 @@
+/**
+ * data-structure-typed
+ *
+ * @author Pablo Zeng
+ * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { BST, BSTNode } from './bst';
+import type { AVLTreeOptions, BinaryTreeDeleteResult, BSTNOptKeyOrNode, BTNRep, EntryCallback, OptNodeOrNull } from '../../types';
+import { IBinaryTree } from '../../interfaces';
+export declare class AVLTreeNode<K = any, V = any> extends BSTNode<K, V> {
+    /**
+     * This TypeScript constructor function initializes an instance with a key and an optional value.
+     * @param {K} key - The `key` parameter is typically used to uniquely identify an object or element
+     * within a data structure. It serves as a reference or identifier for accessing or manipulating the
+     * associated value or data.
+     * @param {V} [value] - The `value` parameter in the constructor is optional, meaning it does not
+     * have to be provided when creating an instance of the class. If a value is not provided, it will
+     * default to `undefined`.
+     */
+    constructor(key: K, value?: V);
+    parent?: AVLTreeNode<K, V>;
+    _left?: OptNodeOrNull<AVLTreeNode<K, V>>;
+    get left(): OptNodeOrNull<AVLTreeNode<K, V>>;
+    set left(v: OptNodeOrNull<AVLTreeNode<K, V>>);
+    _right?: OptNodeOrNull<AVLTreeNode<K, V>>;
+    get right(): OptNodeOrNull<AVLTreeNode<K, V>>;
+    set right(v: OptNodeOrNull<AVLTreeNode<K, V>>);
+}
+/**
+ * 1. Height-Balanced: Each node's left and right subtrees differ in height by no more than one.
+ * 2. Automatic Rebalancing: AVL trees rebalance themselves automatically during insertions and deletions.
+ * 3. Rotations for Balancing: Utilizes rotations (single or double) to maintain balance after updates.
+ * 4. Order Preservation: Maintains the binary search tree property where left child values are less than the parent, and right child values are greater.
+ * 5. Efficient Lookups: Offers O(log n) search time, where 'n' is the number of nodes, due to its balanced nature.
+ * 6. Complex Insertions and Deletions: Due to rebalancing, these operations are more complex than in a regular BST.
+ * 7. Path Length: The path length from the root to any leaf is longer compared to an unbalanced BST, but shorter than a linear chain of nodes.
+ */
+export declare class AVLTree<K = any, V = any, R = object, MK = any, MV = any, MR = object> extends BST<K, V, R, MK, MV, MR> implements IBinaryTree<K, V, R, MK, MV, MR> {
+    /**
+     * This TypeScript constructor initializes an AVLTree with keys, nodes, entries, or raw data provided
+     * in an iterable format.
+     * @param keysNodesEntriesOrRaws - The `keysNodesEntriesOrRaws` parameter in the constructor is an
+     * iterable that can contain either `BTNRep<K, V, AVLTreeNode<K, V>>` objects or `R` objects. It is
+     * used to initialize the AVLTree with key-value pairs or raw data entries. If provided
+     * @param [options] - The `options` parameter in the constructor is of type `AVLTreeOptions<K, V,
+     * R>`. It is an optional parameter that allows you to specify additional options for configuring the
+     * AVL tree. These options could include things like custom comparators, initial capacity, or any
+     * other configuration settings specific
+     */
+    constructor(keysNodesEntriesOrRaws?: Iterable<BTNRep<K, V, AVLTreeNode<K, V>> | R>, options?: AVLTreeOptions<K, V, R>);
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * 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 AVLTreeNode<K, V>.
+     */
+    createNode(key: K, value?: V): AVLTreeNode<K, V>;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function creates a new AVL tree with the specified options and returns it.
+     * @param {AVLTreeOptions} [options] - The `options` parameter is an optional object that can be
+     * passed to the `createTree` function. It is used to customize the behavior of the AVL tree that is
+     * being created.
+     * @returns a new AVLTree object.
+     */
+    createTree(options?: AVLTreeOptions<K, V, R>): AVLTree<K, V, R, MK, MV, MR>;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function checks if the input is an instance of AVLTreeNode.
+     * @param {BTNRep<K, V, AVLTreeNode<K, V>>} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can be of type `R` or `BTNRep<K, V, AVLTreeNode<K, V>>`.
+     * @returns a boolean value indicating whether the input parameter `keyNodeOrEntry` is
+     * an instance of the `AVLTreeNode` class.
+     */
+    isNode(keyNodeOrEntry: BTNRep<K, V, AVLTreeNode<K, V>>): keyNodeOrEntry is AVLTreeNode<K, V>;
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(log n)
+     *
+     * The function overrides the add method of a class and inserts a key-value pair into a data
+     * structure, then balances the path.
+     * @param {BTNRep<K, V, AVLTreeNode<K, V>>} keyNodeOrEntry - The parameter
+     * `keyNodeOrEntry` can accept values of type `R`, `BTNRep<K, V, AVLTreeNode<K, V>>`
+     * @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(keyNodeOrEntry: BTNRep<K, V, AVLTreeNode<K, V>>, value?: V): boolean;
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(log n)
+     *
+     * The function overrides the delete method in a TypeScript class, performs deletion, and then
+     * balances the tree if necessary.
+     * @param {BTNRep<K, V, AVLTreeNode<K, V>>} keyNodeOrEntry - The `keyNodeOrEntry`
+     * parameter in the `override delete` method can be one of the following types:
+     * @returns The `delete` method is being overridden in this code snippet. It first calls the `delete`
+     * method from the superclass (presumably a parent class) with the provided `predicate`, which could
+     * be a key, node, entry, or a custom predicate. The result of this deletion operation is stored in
+     * `deletedResults`, which is an array of `BinaryTreeDeleteResult` objects.
+     */
+    delete(keyNodeOrEntry: BTNRep<K, V, AVLTreeNode<K, V>>): BinaryTreeDeleteResult<AVLTreeNode<K, V>>[];
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The `map` function in TypeScript overrides the default map behavior of an AVLTree data structure
+     * by applying a callback function to each entry and creating a new AVLTree with the results.
+     * @param callback - A function that will be called for each entry in the AVLTree. It takes four
+     * arguments: the key, the value (which can be undefined), the index of the entry, and a reference to
+     * the AVLTree itself.
+     * @param [options] - The `options` parameter in the `override map` function is of type
+     * `AVLTreeOptions<MK, MV, MR>`. It is an optional parameter that allows you to specify additional
+     * options for the AVL tree being created during the mapping process. These options could include
+     * custom comparators, initial
+     * @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`) within the callback function. This can be useful when you want to access
+     * properties or
+     * @returns The `map` method is returning a new AVLTree instance (`newTree`) with the entries
+     * modified by the provided callback function.
+     */
+    map(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: AVLTreeOptions<MK, MV, MR>, thisArg?: any): AVLTree<MK, MV, MR>;
+    /**
+     * 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 A cloned tree object is being returned.
+     */
+    clone(): AVLTree<K, V, R, MK, MV, MR>;
+    /**
+     * 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 {BSTNOptKeyOrNode<K, AVLTreeNode<K, V>>} srcNode - The `srcNode` parameter represents either a node
+     * object (`AVLTreeNode<K, V>`) or a key-value pair (`R`) that is being swapped with another node.
+     * @param {BSTNOptKeyOrNode<K, AVLTreeNode<K, V>>} destNode - The `destNode` parameter is either an instance of
+     * `R` or an instance of `BSTNOptKeyOrNode<K, AVLTreeNode<K, V>>`.
+     * @returns The method is returning the `destNodeEnsured` object if both `srcNodeEnsured` and
+     * `destNodeEnsured` are truthy. Otherwise, it returns `undefined`.
+     */
+    protected _swapProperties(srcNode: BSTNOptKeyOrNode<K, AVLTreeNode<K, V>>, destNode: BSTNOptKeyOrNode<K, AVLTreeNode<K, V>>): AVLTreeNode<K, V> | undefined;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function calculates the balance factor of a node in a binary tree.
+     * @param {AVLTreeNode<K, V>} node - The parameter "node" is of type "AVLTreeNode<K, V>", 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.
+     */
+    protected _balanceFactor(node: AVLTreeNode<K, V>): number;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function updates the height of a node in a binary tree based on the heights of its left and
+     * right children.
+     * @param {AVLTreeNode<K, V>} node - The parameter "node" represents a node in a binary tree data structure.
+     */
+    protected _updateHeight(node: AVLTreeNode<K, V>): void;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `_balanceLL` function performs a left-left rotation to balance a binary search tree.
+     * @param {AVLTreeNode<K, V>} A - A is a node in a binary tree.
+     */
+    protected _balanceLL(A: AVLTreeNode<K, V>): void;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The `_balanceLR` function performs a left-right rotation to balance a binary tree.
+     * @param {AVLTreeNode<K, V>} A - A is a node in a binary tree.
+     */
+    protected _balanceLR(A: AVLTreeNode<K, V>): void;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function `_balanceRR` performs a right-right rotation to balance a binary tree.
+     * @param {AVLTreeNode<K, V>} A - A is a node in a binary tree.
+     */
+    protected _balanceRR(A: AVLTreeNode<K, V>): void;
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
+     * The function `_balanceRL` performs a right-left rotation to balance a binary tree.
+     * @param {AVLTreeNode<K, V>} A - A is a node in a binary tree.
+     */
+    protected _balanceRL(A: AVLTreeNode<K, V>): void;
+    /**
+     * Time Complexity: O(log n)
+     * Space Complexity: O(1)
+     *
+     * 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 {BTNRep<K, V, AVLTreeNode<K, V>>} node - The `node` parameter can be of type `R` or
+     * `BTNRep<K, V, AVLTreeNode<K, V>>`.
+     */
+    protected _balancePath(node: BTNRep<K, V, AVLTreeNode<K, V>>): void;
+    /**
+     * 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 {AVLTreeNode<K, V>} oldNode - The `oldNode` parameter represents the node that needs to be replaced in
+     * the data structure.
+     * @param {AVLTreeNode<K, V>} newNode - The `newNode` parameter is the new node that will replace the `oldNode` in
+     * the data structure.
+     * @returns The method is returning the result of calling the `_replaceNode` method from the
+     * superclass, with the `oldNode` and `newNode` as arguments.
+     */
+    protected _replaceNode(oldNode: AVLTreeNode<K, V>, newNode: AVLTreeNode<K, V>): AVLTreeNode<K, V>;
+}