min-heap-typed 1.38.0 → 1.38.1

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

@@ -0,0 +1,261 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BinaryIndexedTree = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+const utils_1 = require("../../utils");
+class BinaryIndexedTree {
+    /**
+     * The constructor initializes the properties of an object, including default frequency, maximum
+     * value, a freqMap data structure, the most significant bit, and the count of negative frequencies.
+     * @param  - - `frequency`: The default frequency value. It is optional and has a default
+     * value of 0.
+     */
+    constructor({ frequency = 0, max }) {
+        this._freq = frequency;
+        this._max = max;
+        this._freqMap = { 0: 0 };
+        this._msb = (0, utils_1.getMSB)(max);
+        this._negativeCount = frequency < 0 ? max : 0;
+    }
+    get freqMap() {
+        return this._freqMap;
+    }
+    set freqMap(value) {
+        this._freqMap = value;
+    }
+    get msb() {
+        return this._msb;
+    }
+    set msb(value) {
+        this._msb = value;
+    }
+    get negativeCount() {
+        return this._negativeCount;
+    }
+    set negativeCount(value) {
+        this._negativeCount = value;
+    }
+    get freq() {
+        return this._freq;
+    }
+    get max() {
+        return this._max;
+    }
+    /**
+     * The function "readSingle" reads a single number from a specified index.
+     * @param {number} index - The `index` parameter is a number that represents the index of an element in a
+     * collection or array.
+     * @returns a number.
+     */
+    readSingle(index) {
+        this._checkIndex(index);
+        return this._readSingle(index);
+    }
+    /**
+     * The "update" function updates the value at a given index by adding a delta and triggers a callback
+     * to notify of the change.
+     * @param {number} position - The `index` parameter represents the index of the element that needs to be
+     * updated in the data structure.
+     * @param {number} change - The "delta" parameter represents the change in value that needs to be
+     * applied to the frequency at the specified index.
+     */
+    update(position, change) {
+        this._checkIndex(position);
+        const freqCur = this._readSingle(position);
+        this._update(position, change);
+        this._updateNegativeCount(freqCur, freqCur + change);
+    }
+    /**
+     * The function "writeSingle" checks the index and writes a single value with a given frequency.
+     * @param {number} index - The `index` parameter is a number that represents the index of an element. It
+     * is used to identify the specific element that needs to be written.
+     * @param {number} freq - The `freq` parameter represents the frequency value that needs to be
+     * written.
+     */
+    writeSingle(index, freq) {
+        this._checkIndex(index);
+        this._writeSingle(index, freq);
+    }
+    /**
+     * The read function takes a count parameter, checks if it is an integer, and returns the result of
+     * calling the _read function with the count parameter clamped between 0 and the maximum value.
+     * @param {number} count - The `count` parameter is a number that represents the number of items to
+     * read.
+     * @returns a number.
+     */
+    read(count) {
+        if (!Number.isInteger(count)) {
+            throw new Error('Invalid count');
+        }
+        return this._read(Math.max(Math.min(count, this.max), 0));
+    }
+    /**
+     * The function returns the lower bound of a non-descending sequence that sums up to a given number.
+     * @param {number} sum - The `sum` parameter is a number that represents the target sum that we want
+     * to find in the sequence.
+     * @returns The lowerBound function is returning a number.
+     */
+    lowerBound(sum) {
+        if (this.negativeCount > 0) {
+            throw new Error('Sequence is not non-descending');
+        }
+        return this._binarySearch(sum, (x, y) => x < y);
+    }
+    /**
+     * The upperBound function returns the index of the first element in a sequence that is greater than
+     * or equal to a given sum.
+     * @param {number} sum - The "sum" parameter is a number that represents the target sum that we want
+     * to find in the sequence.
+     * @returns The upperBound function is returning a number.
+     */
+    upperBound(sum) {
+        if (this.negativeCount > 0) {
+            throw new Error('Must not be descending');
+        }
+        return this._binarySearch(sum, (x, y) => x <= y);
+    }
+    /**
+     * The function returns the value of a specific index in a freqMap data structure, or a default value if
+     * the index is not found.
+     * @param {number} index - The `index` parameter is a number that represents the index of a node in a
+     * freqMap data structure.
+     * @returns a number.
+     */
+    _getFrequency(index) {
+        if (index in this.freqMap) {
+            return this.freqMap[index];
+        }
+        return this.freq * (index & -index);
+    }
+    /**
+     * The function _updateFrequency adds a delta value to the element at the specified index in the freqMap array.
+     * @param {number} index - The index parameter is a number that represents the index of the freqMap
+     * element that needs to be updated.
+     * @param {number} delta - The `delta` parameter represents the change in value that needs to be
+     * added to the freqMap at the specified `index`.
+     */
+    _updateFrequency(index, delta) {
+        this.freqMap[index] = this._getFrequency(index) + delta;
+    }
+    /**
+     * The function checks if the given index is valid and within the range.
+     * @param {number} index - The parameter "index" is of type number and represents the index value
+     * that needs to be checked.
+     */
+    _checkIndex(index) {
+        if (!Number.isInteger(index)) {
+            throw new Error('Invalid index: Index must be an integer.');
+        }
+        if (index < 0 || index >= this.max) {
+            throw new Error('Index out of range: Index must be within the range [0, this.max).');
+        }
+    }
+    /**
+     * The function calculates the sum of elements in an array up to a given index using a binary indexed
+     * freqMap.
+     * @param {number} index - The `index` parameter is a number that represents the index of an element in a
+     * data structure.
+     * @returns a number.
+     */
+    _readSingle(index) {
+        index = index + 1;
+        let sum = this._getFrequency(index);
+        const z = index - (index & -index);
+        index--;
+        while (index !== z) {
+            sum -= this._getFrequency(index);
+            index -= index & -index;
+        }
+        return sum;
+    }
+    /**
+     * The function `_updateNegativeCount` updates a counter based on changes in frequency values.
+     * @param {number} freqCur - The current frequency value.
+     * @param {number} freqNew - The freqNew parameter represents the new frequency value.
+     */
+    _updateNegativeCount(freqCur, freqNew) {
+        if (freqCur < 0 && freqNew >= 0) {
+            this.negativeCount--;
+        }
+        else if (freqCur >= 0 && freqNew < 0) {
+            this.negativeCount++;
+        }
+    }
+    /**
+     * The `_update` function updates the values in a binary indexed freqMap starting from a given index and
+     * propagating the changes to its parent nodes.
+     * @param {number} index - The `index` parameter is a number that represents the index of the element in
+     * the data structure that needs to be updated.
+     * @param {number} delta - The `delta` parameter represents the change in value that needs to be
+     * applied to the elements in the data structure.
+     */
+    _update(index, delta) {
+        index = index + 1;
+        while (index <= this.max) {
+            this._updateFrequency(index, delta);
+            index += index & -index;
+        }
+    }
+    /**
+     * The `_writeSingle` function updates the frequency at a specific index and triggers a callback if
+     * the frequency has changed.
+     * @param {number} index - The `index` parameter is a number that represents the index of the element
+     * being modified or accessed.
+     * @param {number} freq - The `freq` parameter represents the new frequency value that needs to be
+     * written to the specified index `index`.
+     */
+    _writeSingle(index, freq) {
+        const freqCur = this._readSingle(index);
+        this._update(index, freq - freqCur);
+        this._updateNegativeCount(freqCur, freq);
+    }
+    /**
+     * The `_read` function calculates the sum of values in a binary freqMap up to a given count.
+     * @param {number} count - The `count` parameter is a number that represents the number of elements
+     * to read from the freqMap.
+     * @returns the sum of the values obtained from calling the `_getFrequency` method for each index in the
+     * range from `count` to 1.
+     */
+    _read(count) {
+        let index = count;
+        let sum = 0;
+        while (index) {
+            sum += this._getFrequency(index);
+            index -= index & -index;
+        }
+        return sum;
+    }
+    /**
+     * The function `_binarySearch` performs a binary search to find the largest number that satisfies a given
+     * condition.
+     * @param {number} sum - The sum parameter is a number that represents the target sum value.
+     * @param before - The `before` parameter is a function that takes two numbers `x` and `y` as
+     * arguments and returns a boolean value. It is used to determine if `x` is less than or equal to
+     * `y`. The purpose of this function is to compare two numbers and determine their order.
+     * @returns the value of the variable "left".
+     */
+    _binarySearch(sum, before) {
+        let left = 0;
+        let right = this.msb << 1;
+        let sumT = sum;
+        while (right > left + 1) {
+            const middle = (left + right) >> 1;
+            const sumM = this._getFrequency(middle);
+            if (middle <= this.max && before(sumM, sumT)) {
+                sumT -= sumM;
+                left = middle;
+            }
+            else {
+                right = middle;
+            }
+        }
+        return left;
+    }
+}
+exports.BinaryIndexedTree = BinaryIndexedTree;

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

@@ -0,0 +1,409 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { BFSCallback, BFSCallbackReturn, BinaryTreeNodeKey, BinaryTreeNodeNested, BinaryTreeOptions, MapCallback, MapCallbackReturn } from '../../types';
+import { BinaryTreeDeletedResult, DFSOrderPattern, FamilyPosition, IterationType } from '../../types';
+import { IBinaryTree } from '../../interfaces';
+/**
+ * Represents a node in a binary tree.
+ * @template V - The type of data stored in the node.
+ * @template FAMILY - The type of the family relationship in the binary tree.
+ */
+export declare class BinaryTreeNode<V = any, FAMILY extends BinaryTreeNode<V, FAMILY> = BinaryTreeNodeNested<V>> {
+    /**
+     * The key associated with the node.
+     */
+    key: BinaryTreeNodeKey;
+    /**
+     * The value stored in the node.
+     */
+    val: V | undefined;
+    /**
+     * The parent node of the current node.
+     */
+    parent: FAMILY | null | undefined;
+    /**
+     * Creates a new instance of BinaryTreeNode.
+     * @param {BinaryTreeNodeKey} key - The key associated with the node.
+     * @param {V} val - The value stored in the node.
+     */
+    constructor(key: BinaryTreeNodeKey, val?: V);
+    private _left;
+    /**
+     * Get the left child node.
+     */
+    get left(): FAMILY | null | undefined;
+    /**
+     * Set the left child node.
+     * @param {FAMILY | null | undefined} v - The left child node.
+     */
+    set left(v: FAMILY | null | undefined);
+    private _right;
+    /**
+     * Get the right child node.
+     */
+    get right(): FAMILY | null | undefined;
+    /**
+     * Set the right child node.
+     * @param {FAMILY | null | undefined} v - The right child node.
+     */
+    set right(v: FAMILY | null | undefined);
+    /**
+     * Get the position of the node within its family.
+     * @returns {FamilyPosition} - The family position of the node.
+     */
+    get familyPosition(): FamilyPosition;
+}
+/**
+ * Represents a binary tree data structure.
+ * @template N - The type of the binary tree's nodes.
+ */
+export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTreeNode> implements IBinaryTree<N> {
+    private _loopType;
+    /**
+     * Creates a new instance of BinaryTree.
+     * @param {BinaryTreeOptions} [options] - The options for the binary tree.
+     */
+    constructor(options?: BinaryTreeOptions);
+    private _root;
+    /**
+     * Get the root node of the binary tree.
+     */
+    get root(): N | null;
+    private _size;
+    /**
+     * Get the number of nodes in the binary tree.
+     */
+    get size(): number;
+    /**
+     * Get the iteration type used in the binary tree.
+     */
+    get iterationType(): IterationType;
+    /**
+     * Set the iteration type for the binary tree.
+     * @param {IterationType} v - The new iteration type to set.
+     */
+    set iterationType(v: IterationType);
+    /**
+     * Creates a new instance of BinaryTreeNode with the given key and value.
+     * @param {BinaryTreeNodeKey} key - The key for the new node.
+     * @param {N['val']} val - The value for the new node.
+     * @returns {N} - The newly created BinaryTreeNode.
+     */
+    createNode(key: BinaryTreeNodeKey, val?: N['val']): N;
+    /**
+     * Clear the binary tree, removing all nodes.
+     */
+    clear(): void;
+    /**
+     * Check if the binary tree is empty.
+     * @returns {boolean} - True if the binary tree is empty, false otherwise.
+     */
+    isEmpty(): boolean;
+    /**
+     * Add a node with the given key and value to the binary tree.
+     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The key or node to add to the binary tree.
+     * @param {N['val']} val - The value for the new node (optional).
+     * @returns {N | null | undefined} - The inserted node, or null if nothing was inserted, or undefined if the operation failed.
+     */
+    add(keyOrNode: BinaryTreeNodeKey | N | null, val?: N['val']): N | null | undefined;
+    /**
+     * The `addMany` function takes an array of binary tree node IDs or nodes, and optionally an array of corresponding data
+     * values, and adds them to the binary tree.
+     * @param {(BinaryTreeNodeKey | null)[] | (N | null)[]} keysOrNodes - An array of BinaryTreeNodeKey or BinaryTreeNode
+     * objects, or null values.
+     * @param {N['val'][]} [values] - The `values` parameter is an optional array of values (`N['val'][]`) that corresponds to
+     * the nodes or node IDs being added. It is used to set the value of each node being added. If `values` is not provided,
+     * the value of the nodes will be `undefined`.
+     * @returns The function `addMany` returns an array of `N`, `null`, or `undefined` values.
+     */
+    addMany(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], values?: N['val'][]): (N | null | undefined)[];
+    /**
+     * The `refill` function clears the binary tree and adds multiple nodes with the given IDs or nodes and optional data.
+     * @param {(BinaryTreeNodeKey | N)[]} keysOrNodes - The `keysOrNodes` parameter is an array that can contain either
+     * `BinaryTreeNodeKey` or `N` values.
+     * @param {N[] | Array<N['val']>} [data] - The `data` parameter is an optional array of values that will be assigned to
+     * the nodes being added. If provided, the length of the `data` array should be equal to the length of the `keysOrNodes`
+     * array. Each value in the `data` array will be assigned to the
+     * @returns The method is returning a boolean value.
+     */
+    refill(keysOrNodes: (BinaryTreeNodeKey | null)[] | (N | null)[], data?: N[] | Array<N['val']>): boolean;
+    /**
+     * The `delete` function removes a node from a binary search tree and returns the deleted node along
+     * with the parent node that needs to be balanced.
+     * @param {N | BinaryTreeNodeKey} nodeOrKey - The `nodeOrKey` parameter can be either a node (`N`) or
+     * a key (`BinaryTreeNodeKey`). If it is a key, the function will find the corresponding node in the
+     * binary tree.
+     * @returns an array of `BinaryTreeDeletedResult<N>` objects.
+     */
+    delete(nodeOrKey: N | BinaryTreeNodeKey): BinaryTreeDeletedResult<N>[];
+    /**
+     * The function `getDepth` calculates the depth of a given node in a binary tree relative to a
+     * specified root node.
+     * @param {N | BinaryTreeNodeKey | null} distNode - The `distNode` parameter represents the node
+     * whose depth we want to find in the binary tree. It can be either a node object (`N`), a key value
+     * of the node (`BinaryTreeNodeKey`), or `null`.
+     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter represents the
+     * starting node from which we want to calculate the depth. It can be either a node object or the key
+     * of a node in the binary tree. If no value is provided for `beginRoot`, it defaults to the root
+     * node of the binary tree.
+     * @returns the depth of the `distNode` relative to the `beginRoot`.
+     */
+    getDepth(distNode: N | BinaryTreeNodeKey | null, beginRoot?: N | BinaryTreeNodeKey | null): number;
+    /**
+     * The `getHeight` function calculates the maximum height of a binary tree using either recursive or
+     * iterative approach.
+     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter represents the
+     * starting node from which the height of the binary tree is calculated. It can be either a node
+     * object (`N`), a key value of a node in the tree (`BinaryTreeNodeKey`), or `null` if no starting
+     * node is specified. If `
+     * @param iterationType - The `iterationType` parameter is used to determine whether to calculate the
+     * height of the binary tree using a recursive approach or an iterative approach. It can have two
+     * possible values:
+     * @returns the height of the binary tree.
+     */
+    getHeight(beginRoot?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): number;
+    /**
+     * The `getMinHeight` function calculates the minimum height of a binary tree using either a
+     * recursive or iterative approach.
+     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node from which we want to
+     * calculate the minimum height of the tree. It is optional and defaults to the root of the tree if
+     * not provided.
+     * @param iterationType - The `iterationType` parameter is used to determine the method of iteration
+     * to calculate the minimum height of a binary tree. It can have two possible values:
+     * @returns The function `getMinHeight` returns the minimum height of a binary tree.
+     */
+    getMinHeight(beginRoot?: N | null, iterationType?: IterationType): number;
+    /**
+     * The function checks if a binary tree is perfectly balanced by comparing the minimum height and the
+     * height of the tree.
+     * @param {N | null} beginRoot - The parameter `beginRoot` is of type `N | null`, which means it can
+     * either be of type `N` (representing a node in a tree) or `null` (representing an empty tree).
+     * @returns The method is returning a boolean value.
+     */
+    isPerfectlyBalanced(beginRoot?: N | null): boolean;
+    /**
+     * The function `getNodes` returns an array of nodes that match a given node property, using either
+     * recursive or iterative traversal.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is either a
+     * `BinaryTreeNodeKey` or a generic type `N`. It represents the property of the node that we are
+     * searching for. It can be a specific key value or any other property of the node.
+     * @param callback - The `callback` parameter is a function that takes a node as input and returns a
+     * value. This value is compared with the `nodeProperty` parameter to determine if the node should be
+     * included in the result. The `callback` parameter has a default value of
+     * `this._defaultCallbackByKey`, which
+     * @param [onlyOne=false] - A boolean value indicating whether to stop searching after finding the
+     * first node that matches the nodeProperty. If set to true, the function will return an array with
+     * only one element (or an empty array if no matching node is found). If set to false (default), the
+     * function will continue searching for all
+     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node from which the
+     * traversal of the binary tree will begin. It is optional and defaults to the root of the binary
+     * tree.
+     * @param iterationType - The `iterationType` parameter determines the type of iteration used to
+     * traverse the binary tree. It can have two possible values:
+     * @returns The function `getNodes` returns an array of nodes (`N[]`).
+     */
+    getNodes(nodeProperty: BinaryTreeNodeKey | N, callback?: MapCallback<N>, onlyOne?: boolean, beginRoot?: N | null, iterationType?: IterationType): N[];
+    /**
+     * The function checks if a binary tree has a node with a given property or key.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is the key or value of
+     * the node that you want to find in the binary tree. It can be either a `BinaryTreeNodeKey` or a
+     * generic type `N`.
+     * @param callback - The `callback` parameter is a function that is used to determine whether a node
+     * matches the desired criteria. It takes a node as input and returns a boolean value indicating
+     * whether the node matches the criteria or not. The default callback function
+     * `this._defaultCallbackByKey` is used if no callback function is
+     * @param beginRoot - The `beginRoot` parameter is the starting point for the search. It specifies
+     * the node from which the search should begin. By default, it is set to `this.root`, which means the
+     * search will start from the root node of the binary tree. However, you can provide a different node
+     * as
+     * @param iterationType - The `iterationType` parameter specifies the type of iteration to be
+     * performed when searching for nodes in the binary tree. It can have one of the following values:
+     * @returns a boolean value.
+     */
+    has(nodeProperty: BinaryTreeNodeKey | N, callback?: MapCallback<N>, beginRoot?: N | null, iterationType?: IterationType): boolean;
+    /**
+     * The function `get` returns the first node in a binary tree that matches the given property or key.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is the key or value of
+     * the node that you want to find in the binary tree. It can be either a `BinaryTreeNodeKey` or `N`
+     * type.
+     * @param callback - The `callback` parameter is a function that is used to determine whether a node
+     * matches the desired criteria. It takes a node as input and returns a boolean value indicating
+     * whether the node matches the criteria or not. The default callback function
+     * (`this._defaultCallbackByKey`) is used if no callback function is
+     * @param beginRoot - The `beginRoot` parameter is the starting point for the search. It specifies
+     * the root node from which the search should begin.
+     * @param iterationType - The `iterationType` parameter specifies the type of iteration to be
+     * performed when searching for a node in the binary tree. It can have one of the following values:
+     * @returns either the found node (of type N) or null if no node is found.
+     */
+    get(nodeProperty: BinaryTreeNodeKey | N, callback?: MapCallback<N>, beginRoot?: N | null, iterationType?: IterationType): N | null;
+    /**
+     * The function `getPathToRoot` returns an array of nodes starting from a given node and traversing
+     * up to the root node, with the option to reverse the order of the nodes.
+     * @param {N} beginRoot - The `beginRoot` parameter represents the starting node from which you want
+     * to find the path to the root node.
+     * @param [isReverse=true] - The `isReverse` parameter is a boolean flag that determines whether the
+     * resulting path should be reversed or not. If `isReverse` is set to `true`, the path will be
+     * reversed before returning it. If `isReverse` is set to `false` or not provided, the path will
+     * @returns The function `getPathToRoot` returns an array of type `N[]`.
+     */
+    getPathToRoot(beginRoot: N, isReverse?: boolean): N[];
+    /**
+     * The function `getLeftMost` returns the leftmost node in a binary tree, either using recursive or
+     * iterative traversal.
+     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter is the starting point
+     * for finding the leftmost node in a binary tree. It can be either a node object (`N`), a key value
+     * of a node (`BinaryTreeNodeKey`), or `null` if the tree is empty.
+     * @param iterationType - The `iterationType` parameter is used to determine the type of iteration to
+     * be performed when finding the leftmost node in a binary tree. It can have two possible values:
+     * @returns The function `getLeftMost` returns the leftmost node (`N`) in a binary tree. If there is
+     * no leftmost node, it returns `null`.
+     */
+    getLeftMost(beginRoot?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): N | null;
+    /**
+     * The function `getRightMost` returns the rightmost node in a binary tree, either recursively or
+     * iteratively.
+     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node from which we want to
+     * find the rightmost node. It is of type `N | null`, which means it can either be a node of type `N`
+     * or `null`. If it is `null`, it means there is no starting node
+     * @param iterationType - The `iterationType` parameter is used to determine the type of iteration to
+     * be performed when finding the rightmost node in a binary tree. It can have two possible values:
+     * @returns The function `getRightMost` returns the rightmost node (`N`) in a binary tree. If the
+     * `beginRoot` parameter is `null`, it returns `null`.
+     */
+    getRightMost(beginRoot?: N | null, iterationType?: IterationType): N | null;
+    /**
+     * The function `isSubtreeBST` checks if a given binary tree is a valid binary search tree.
+     * @param {N} beginRoot - The `beginRoot` parameter is the root node of the binary tree that you want
+     * to check if it is a binary search tree (BST) subtree.
+     * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
+     * type of iteration to use when checking if a subtree is a binary search tree (BST). It can have two
+     * possible values:
+     * @returns The function `isSubtreeBST` returns a boolean value.
+     */
+    isSubtreeBST(beginRoot: N, iterationType?: IterationType): boolean;
+    /**
+     * The function checks if a binary tree is a binary search tree.
+     * @param iterationType - The parameter "iterationType" is used to specify the type of iteration to
+     * be used when checking if the binary tree is a binary search tree (BST). It is an optional
+     * parameter with a default value of "this.iterationType". The value of "this.iterationType" is not
+     * provided in
+     * @returns a boolean value.
+     */
+    isBST(iterationType?: IterationType): boolean;
+    /**
+     * The function `subTreeTraverse` traverses a binary tree and applies a callback function to each
+     * node, either recursively or iteratively.
+     * @param callback - The `callback` parameter is a function that will be called on each node in the
+     * subtree traversal. It takes a single argument, which is the current node being traversed, and
+     * returns a value. The return values from each callback invocation will be collected and returned as
+     * an array.
+     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter is the starting point
+     * for traversing the subtree. It can be either a node object, a key value of a node, or `null` to
+     * start from the root of the tree.
+     * @param iterationType - The `iterationType` parameter determines the type of traversal to be
+     * performed on the binary tree. It can have two possible values:
+     * @returns The function `subTreeTraverse` returns an array of `MapCallbackReturn<N>`.
+     */
+    subTreeTraverse(callback?: MapCallback<N>, beginRoot?: N | BinaryTreeNodeKey | null, iterationType?: IterationType): MapCallbackReturn<N>[];
+    /**
+     * The `dfs` function performs a depth-first search traversal on a binary tree, executing a callback
+     * function on each node according to a specified order pattern.
+     * @param callback - The `callback` parameter is a function that will be called on each node during
+     * the depth-first search traversal. It takes a node as input and returns a value. The default value
+     * is `this._defaultCallbackByKey`, which is a callback function defined elsewhere in the code.
+     * @param {DFSOrderPattern} [pattern=in] - The `pattern` parameter determines the order in which the
+     * nodes are visited during the depth-first search. There are three possible values for `pattern`:
+     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the depth-first
+     * search. It determines where the search will begin in the tree or graph structure. If `beginRoot`
+     * is `null`, an empty array will be returned.
+     * @param {IterationType} iterationType - The `iterationType` parameter determines the type of
+     * iteration used in the depth-first search algorithm. It can have two possible values:
+     * @returns The function `dfs` returns an array of `MapCallbackReturn<N>` values.
+     */
+    dfs(callback?: MapCallback<N>, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType): MapCallbackReturn<N>[];
+    /**
+     * The bfs function performs a breadth-first search traversal on a binary tree, executing a callback
+     * function on each node.
+     * @param callback - The `callback` parameter is a function that will be called for each node in the
+     * breadth-first search. It takes a node of type `N` as its argument and returns a value of type
+     * `BFSCallbackReturn<N>`. The default value for this parameter is `this._defaultCallbackByKey
+     * @param {boolean} [withLevel=false] - The `withLevel` parameter is a boolean flag that determines
+     * whether or not to include the level of each node in the callback function. If `withLevel` is set
+     * to `true`, the level of each node will be passed as an argument to the callback function. If
+     * `withLevel` is
+     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the breadth-first
+     * search. It determines from which node the search will begin. If `beginRoot` is `null`, the search
+     * will not be performed and an empty array will be returned.
+     * @param iterationType - The `iterationType` parameter determines the type of iteration to be used
+     * in the breadth-first search (BFS) algorithm. It can have two possible values:
+     * @returns The function `bfs` returns an array of `BFSCallbackReturn<N>[]`.
+     */
+    bfs(callback?: BFSCallback<N>, withLevel?: boolean, beginRoot?: N | null, iterationType?: IterationType): BFSCallbackReturn<N>[];
+    /**
+     * The function returns the predecessor node of a given node in a binary tree.
+     * @param {N} node - The parameter "node" represents a node in a binary tree.
+     * @returns The function `getPredecessor` returns the predecessor node of the given node `node`.
+     */
+    getPredecessor(node: N): N;
+    /**
+     * The `morris` function performs a depth-first traversal of a binary tree using the Morris traversal
+     * algorithm and returns an array of values obtained by applying a callback function to each node.
+     * @param callback - The `callback` parameter is a function that will be called on each node in the
+     * tree. It takes a node of type `N` as input and returns a value of type `MapCallbackReturn<N>`. The
+     * default value for this parameter is `this._defaultCallbackByKey`.
+     * @param {DFSOrderPattern} [pattern=in] - The `pattern` parameter in the `morris` function
+     * determines the order in which the nodes of a binary tree are traversed. It can have one of the
+     * following values:
+     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the Morris
+     * traversal. It specifies the root node of the tree from which the traversal should begin. If
+     * `beginRoot` is `null`, an empty array will be returned.
+     * @returns The `morris` function returns an array of `MapCallbackReturn<N>` values.
+     */
+    morris(callback?: MapCallback<N>, pattern?: DFSOrderPattern, beginRoot?: N | null): MapCallbackReturn<N>[];
+    /**
+     * Swap the data of two nodes in the binary tree.
+     * @param {N} srcNode - The source node to swap.
+     * @param {N} destNode - The destination node to swap.
+     * @returns {N} - The destination node after the swap.
+     */
+    protected _swap(srcNode: N, destNode: N): N;
+    /**
+     * Time complexity is O(n)
+     * Space complexity of Iterative dfs equals to recursive dfs which is O(n) because of the stack
+     * The Morris algorithm only modifies the tree's structure during traversal; once the traversal is complete,
+     * the tree's structure should be restored to its original state to maintain the tree's integrity.
+     * This is because the purpose of the Morris algorithm is to save space rather than permanently alter the tree's shape.
+     */
+    protected _defaultCallbackByKey: MapCallback<N>;
+    /**
+     * The function `_addTo` adds a new node to a binary tree if there is an available position.
+     * @param {N | null} newNode - The `newNode` parameter represents the node that you want to add to
+     * the binary tree. It can be either a node object or `null`.
+     * @param {N} parent - The `parent` parameter represents the parent node to which the new node will
+     * be added as a child.
+     * @returns either the left or right child node of the parent node, depending on which child is
+     * available for adding the new node. If a new node is added, the function also updates the size of
+     * the binary tree. If neither the left nor right child is available, the function returns undefined.
+     * If the parent node is null, the function also returns undefined.
+     */
+    protected _addTo(newNode: N | null, parent: N): N | null | undefined;
+    /**
+     * The function sets the root property of an object to a given value, and if the value is not null,
+     * it also sets the parent property of the value to undefined.
+     * @param {N | null} v - The parameter `v` is of type `N | null`, which means it can either be of
+     * type `N` or `null`.
+     */
+    protected _setRoot(v: N | null): void;
+    /**
+     * The function sets the value of the protected property "_size" to the given number.
+     * @param {number} v - The parameter "v" is a number that represents the size value that we want to
+     * set.
+     */
+    protected _setSize(v: number): void;
+}