data-structure-typed 1.35.0 → 1.40.0-rc

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

@@ -1,9 +1,23 @@
 "use strict";
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractBinaryTree = exports.AbstractBinaryTreeNode = void 0;
 const utils_1 = require("../../utils");
 const types_1 = require("../../types");
 class AbstractBinaryTreeNode {
+    /**
+     * The constructor function initializes a BinaryTreeNode object with a key and an optional value.
+     * @param {BinaryTreeNodeKey} key - The `key` parameter is of type `BinaryTreeNodeKey` and represents the unique identifier
+     * of the binary tree node. It is used to distinguish one node from another in the binary tree.
+     * @param {V} [val] - The "val" parameter is an optional parameter of type V. It represents the value that will be
+     * stored in the binary tree node. If no value is provided, it will be set to undefined.
+     */
     constructor(key, val) {
         this.key = key;
         this.val = val;
@@ -26,6 +40,10 @@ class AbstractBinaryTreeNode {
         }
         this._right = v;
     }
+    /**
+     * The function determines the position of a node in a family tree structure.
+     * @returns a value of type `FamilyPosition`.
+     */
     get familyPosition() {
         const that = this;
         if (that.parent) {
@@ -61,7 +79,13 @@ class AbstractBinaryTreeNode {
 }
 exports.AbstractBinaryTreeNode = AbstractBinaryTreeNode;
 class AbstractBinaryTree {
+    /**
+     * The protected constructor initializes the options for an abstract binary tree.
+     * @param {AbstractBinaryTreeOptions} [options] - An optional object that contains configuration options for the binary
+     * tree.
+     */
     constructor(options) {
+        // TODO placeholder node may need redesigned
         this._root = null;
         this._size = 0;
         this._loopType = types_1.LoopType.ITERATIVE;
@@ -83,6 +107,13 @@ class AbstractBinaryTree {
     get loopType() {
         return this._loopType;
     }
+    /**
+     * The `swapLocation` function swaps the location of two nodes in a binary tree.
+     * @param {N} srcNode - The source node that you want to swap with the destination node.
+     * @param {N} destNode - The `destNode` parameter represents the destination node where the values from `srcNode` will
+     * be swapped to.
+     * @returns The `destNode` is being returned.
+     */
     swapLocation(srcNode, destNode) {
         const { key, val } = destNode;
         const tempNode = this.createNode(key, val);
@@ -94,14 +125,34 @@ class AbstractBinaryTree {
         }
         return destNode;
     }
+    /**
+     * The clear() function resets the root, size, and maxKey properties to their initial values.
+     */
     clear() {
         this._root = null;
         this._size = 0;
         this._clearResults();
     }
+    /**
+     * The function checks if the size of an object is equal to zero and returns a boolean value.
+     * @returns A boolean value indicating whether the size of the object is 0 or not.
+     */
     isEmpty() {
         return this.size === 0;
     }
+    /**
+     * When all leaf nodes are null, it will no longer be possible to add new entity nodes to this binary tree.
+     * In this scenario, null nodes serve as "sentinel nodes," "virtual nodes," or "placeholder nodes."
+     */
+    /**
+     * The `add` function adds a new node to a binary tree, either by ID or by creating a new node with a given value.
+     * @param {BinaryTreeNodeKey | N | null} keyOrNode - The `keyOrNode` parameter can be either a `BinaryTreeNodeKey`, which
+     * is a number representing the ID of a binary tree node, or it can be a `N` object, which represents a binary tree
+     * node itself. It can also be `null` if no node is specified.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the `val` property of the new node
+     * being added to the binary tree.
+     * @returns The function `add` returns either the inserted node (`N`), `null`, or `undefined`.
+     */
     add(keyOrNode, val) {
         const _bfs = (root, newNode) => {
             const queue = [root];
@@ -158,7 +209,18 @@ class AbstractBinaryTree {
         }
         return inserted;
     }
+    /**
+     * 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'][]} [data] - The `data` 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 `data` 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, data) {
+        // TODO not sure addMany not be run multi times
         const inserted = [];
         for (let i = 0; i < keysOrNodes.length; i++) {
             const keyOrNode = keysOrNodes[i];
@@ -175,10 +237,26 @@ class AbstractBinaryTree {
         }
         return inserted;
     }
+    /**
+     * 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, data) {
         this.clear();
         return keysOrNodes.length === this.addMany(keysOrNodes, data).length;
     }
+    /**
+     * The `remove` function in TypeScript is used to delete a node from a binary search tree and returns an array of objects
+     * containing the deleted node and the node that needs to be balanced.
+     * @param {N | BinaryTreeNodeKey} nodeOrKey - The `nodeOrKey` parameter can be either a node object (`N`) or a binary tree
+     * node ID (`BinaryTreeNodeKey`).
+     * @returns The function `remove` returns an array of `BinaryTreeDeletedResult<N>` objects.
+     */
     remove(nodeOrKey) {
         const bstDeletedResult = [];
         if (!this.root)
@@ -222,6 +300,11 @@ class AbstractBinaryTree {
         bstDeletedResult.push({ deleted: orgCurrent, needBalanced });
         return bstDeletedResult;
     }
+    /**
+     * The function calculates the depth of a node in a binary tree.
+     * @param {N | BinaryTreeNodeKey | null} beginRoot - The `beginRoot` parameter can be one of the following:
+     * @returns the depth of the given node or binary tree.
+     */
     getDepth(beginRoot = this.root) {
         if (typeof beginRoot === 'number')
             beginRoot = this.get(beginRoot, 'key');
@@ -232,6 +315,13 @@ class AbstractBinaryTree {
         }
         return depth;
     }
+    /**
+     * The `getHeight` function calculates the maximum height of a binary tree, either recursively or iteratively.
+     * @param {N | BinaryTreeNodeKey | null} [beginRoot] - The `beginRoot` parameter is optional and can be of type `N` (a
+     * generic type representing a node in a binary tree), `BinaryTreeNodeKey` (a type representing the ID of a binary tree
+     * node), or `null`.
+     * @returns the height of the binary tree.
+     */
     getHeight(beginRoot = this.root) {
         if (typeof beginRoot === 'number')
             beginRoot = this.get(beginRoot, 'key');
@@ -266,6 +356,14 @@ class AbstractBinaryTree {
             return maxHeight;
         }
     }
+    /**
+     * 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 an optional parameter of type `N` or `null`. It
+     * represents the starting node from which to calculate the minimum height of a binary tree. If no value is provided
+     * for `beginRoot`, the `this.root` property is used as the default value.
+     * @returns The function `getMinHeight` returns the minimum height of the binary tree.
+     */
     getMinHeight(beginRoot = this.root) {
         var _a, _b, _c;
         if (!beginRoot)
@@ -310,9 +408,27 @@ class AbstractBinaryTree {
             return (_c = depths.get(beginRoot)) !== null && _c !== void 0 ? _c : -1;
         }
     }
+    /**
+     * 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` or `null`. It represents the root node of a
+     * tree or null if the tree is empty.
+     * @returns The method is returning a boolean value.
+     */
     isPerfectlyBalanced(beginRoot = this.root) {
         return this.getMinHeight(beginRoot) + 1 >= this.getHeight(beginRoot);
     }
+    /**
+     * The function `getNodes` returns an array of nodes that match a given property name and value in a binary tree.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or a
+     * generic type `N`. It represents the property of the binary tree node that you want to search for.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property name to use when searching for nodes. If not provided, it defaults to 'key'.
+     * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to
+     * return only one node that matches the given `nodeProperty` or `propertyName`. If `onlyOne` is set to `true`, the
+     * function will stop traversing the tree and return the first matching node. If `only
+     * @returns an array of nodes (type N).
+     */
     getNodes(nodeProperty, propertyName = 'key', onlyOne = false) {
         if (!this.root)
             return [];
@@ -342,22 +458,67 @@ class AbstractBinaryTree {
         }
         return result;
     }
+    /**
+     * The function checks if a binary tree node has a specific property.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or `N`.
+     * It represents the property of the binary tree node that you want to check.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the name of the property to be checked in the nodes. If not provided, it defaults to 'key'.
+     * @returns a boolean value.
+     */
     has(nodeProperty, propertyName = 'key') {
+        // TODO may support finding node by value equal
         return this.getNodes(nodeProperty, propertyName).length > 0;
     }
+    /**
+     * The function returns the first node that matches the given property name and value, or null if no matching node is
+     * found.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeKey` or `N`.
+     * It represents the property of the binary tree node that you want to search for.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property name to be used for searching the binary tree nodes. If this parameter is not provided, the
+     * default value is set to `'key'`.
+     * @returns either the value of the specified property of the node, or the node itself if no property name is provided.
+     * If no matching node is found, it returns null.
+     */
     get(nodeProperty, propertyName = 'key') {
         var _a;
+        // TODO may support finding node by value equal
         return (_a = this.getNodes(nodeProperty, propertyName, true)[0]) !== null && _a !== void 0 ? _a : null;
     }
+    /**
+     * The function `getPathToRoot` returns an array of nodes representing the path from a given node to the root node, with
+     * an option to reverse the order of the nodes.
+     * @param {N} node - The `node` parameter represents a node in a tree structure. It is of type `N`, which could be any
+     * type that represents a node in your specific implementation.
+     * @param {boolean} [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 nodes (`N[]`).
+     */
     getPathToRoot(node, isReverse = true) {
+        // TODO to support get path through passing key
         const result = [];
         while (node.parent) {
+            // Array.push + Array.reverse is more efficient than Array.unshift
+            // TODO may consider using Deque, so far this is not the performance bottleneck
             result.push(node);
             node = node.parent;
         }
         result.push(node);
         return isReverse ? result.reverse() : result;
     }
+    /**
+     * The function `getLeftMost` returns the leftmost node in a binary tree, starting from a specified node or the root if
+     * no node is specified.
+     * @param {N | BinaryTreeNodeKey | null} [beginRoot] - The `beginRoot` parameter is optional and can be of type `N` (a
+     * generic type representing a node in a binary tree), `BinaryTreeNodeKey` (a type representing the ID of a binary tree
+     * node), or `null`.
+     * @returns The function `getLeftMost` returns the leftmost node in a binary tree. If the `beginRoot` parameter is
+     * provided, it starts the traversal from that node. If `beginRoot` is not provided or is `null`, it starts the traversal
+     * from the root of the binary tree. The function returns the leftmost node found during the traversal. If no leftmost
+     * node is found (
+     */
     getLeftMost(beginRoot = this.root) {
         if (typeof beginRoot === 'number')
             beginRoot = this.get(beginRoot, 'key');
@@ -372,6 +533,7 @@ class AbstractBinaryTree {
             return _traverse(beginRoot);
         }
         else {
+            // Indirect implementation of iteration using tail recursion optimization
             const _traverse = (0, utils_1.trampoline)((cur) => {
                 if (!cur.left)
                     return cur;
@@ -380,7 +542,18 @@ class AbstractBinaryTree {
             return _traverse(beginRoot);
         }
     }
+    /**
+     * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using tail
+     * recursion optimization.
+     * @param {N | null} [beginRoot] - The `node` parameter is an optional parameter of type `N` or `null`. It represents the
+     * starting node from which we want to find the rightmost node. If no node is provided, the function will default to
+     * using the root node of the data structure.
+     * @returns The `getRightMost` function returns the rightmost node in a binary tree. If the `node` parameter is provided,
+     * it returns the rightmost node starting from that node. If the `node` parameter is not provided, it returns the
+     * rightmost node starting from the root of the binary tree.
+     */
     getRightMost(beginRoot = this.root) {
+        // TODO support get right most by passing key in
         if (!beginRoot)
             return beginRoot;
         if (this._loopType === types_1.LoopType.RECURSIVE) {
@@ -392,6 +565,7 @@ class AbstractBinaryTree {
             return _traverse(beginRoot);
         }
         else {
+            // Indirect implementation of iteration using tail recursion optimization
             const _traverse = (0, utils_1.trampoline)((cur) => {
                 if (!cur.right)
                     return cur;
@@ -400,7 +574,13 @@ class AbstractBinaryTree {
             return _traverse(beginRoot);
         }
     }
+    /**
+     * The function checks if a binary search tree is valid by traversing it either recursively or iteratively.
+     * @param {N | null} node - The `node` parameter represents the root node of a binary search tree (BST).
+     * @returns a boolean value.
+     */
     isSubtreeBST(node) {
+        // TODO there is a bug
         if (!node)
             return true;
         if (this._loopType === types_1.LoopType.RECURSIVE) {
@@ -430,10 +610,21 @@ class AbstractBinaryTree {
             return true;
         }
     }
+    /**
+     * The function isBST checks if the binary tree is valid binary search tree.
+     * @returns The `isBST()` function is returning a boolean value.
+     */
     isBST() {
         return this.isSubtreeBST(this.root);
     }
+    /**
+     * The function calculates the size of a subtree by traversing it either recursively or iteratively.
+     * @param {N | null | undefined} subTreeRoot - The `subTreeRoot` parameter represents the root node of a subtree in a
+     * binary tree.
+     * @returns the size of the subtree rooted at `subTreeRoot`.
+     */
     getSubTreeSize(subTreeRoot) {
+        // TODO support key passed in
         let size = 0;
         if (!subTreeRoot)
             return size;
@@ -457,6 +648,15 @@ class AbstractBinaryTree {
             return size;
         }
     }
+    /**
+     * The function `subTreeSum` calculates the sum of a specified property in a binary tree or subtree.
+     * @param {N | BinaryTreeNodeKey | null} subTreeRoot - The `subTreeRoot` parameter represents the root node of a binary
+     * tree or the ID of a binary tree node. It can also be `null` if there is no subtree.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - propertyName is an optional parameter that specifies the
+     * property of the binary tree node to use for calculating the sum. It can be either 'key' or 'val'. If propertyName is
+     * not provided, it defaults to 'key'.
+     * @returns a number, which is the sum of the values of the specified property in the subtree rooted at `subTreeRoot`.
+     */
     subTreeSum(subTreeRoot, propertyName = 'key') {
         if (typeof subTreeRoot === 'number')
             subTreeRoot = this.get(subTreeRoot, 'key');
@@ -497,6 +697,16 @@ class AbstractBinaryTree {
         }
         return sum;
     }
+    /**
+     * The function `subTreeAdd` adds a delta value to a specified property of each node in a subtree.
+     * @param {N | BinaryTreeNodeKey | null} subTreeRoot - The `subTreeRoot` parameter represents the root node of a binary
+     * tree or the ID of a node in the binary tree. It can also be `null` if there is no subtree to add to.
+     * @param {number} delta - The `delta` parameter is a number that represents the amount by which the property value of
+     * each node in the subtree should be incremented.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property of the binary tree node that should be modified. If not provided, it defaults to 'key'.
+     * @returns a boolean value.
+     */
     subTreeAdd(subTreeRoot, delta, propertyName = 'key') {
         if (typeof subTreeRoot === 'number')
             subTreeRoot = this.get(subTreeRoot, 'key');
@@ -531,6 +741,13 @@ class AbstractBinaryTree {
         }
         return true;
     }
+    /**
+     * The bfs function performs a breadth-first search on a binary tree, accumulating properties of each node based on a specified property name.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - An optional parameter that represents either a node or a property name.
+     * If a node is provided, the bfs algorithm will be performed starting from that node.
+     * If a property name is provided, the bfs algorithm will be performed starting from the root node, accumulating the specified property.
+     * @returns An instance of the `AbstractBinaryTreeNodeProperties` class with generic type `N`.
+     */
     bfs(nodeOrPropertyName = 'key') {
         this._clearResults();
         const queue = [this.root];
@@ -546,6 +763,13 @@ class AbstractBinaryTree {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     }
+    /**
+     * The dfs function performs a depth-first search traversal on a binary tree and returns the accumulated properties of
+     * each node based on the specified pattern and property name.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The name of a property of the nodes in the binary tree. This property will be used to accumulate values during the depth-first search traversal. If no `nodeOrPropertyName` is provided, the default value is `'key'`.
+     * @returns an instance of the AbstractBinaryTreeNodeProperties class, which contains the accumulated properties of the binary tree nodes based on the specified pattern and node or property name.
+     */
     dfs(pattern = 'in', nodeOrPropertyName = 'key') {
         this._clearResults();
         const _traverse = (node) => {
@@ -576,10 +800,18 @@ class AbstractBinaryTree {
         this.root && _traverse(this.root);
         return this._getResultByPropertyName(nodeOrPropertyName);
     }
+    /**
+     * The dfsIterative function performs an iterative depth-first search traversal on a binary tree, with the option to
+     * specify the traversal pattern and the property name to accumulate results by.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The name of a property of the nodes in the binary tree. This property will be used to accumulate values during the depth-first search traversal. By default, it is set to `'key'`.
+     * @returns An object of type AbstractBinaryTreeNodeProperties<N>.
+     */
     dfsIterative(pattern = 'in', nodeOrPropertyName = 'key') {
         this._clearResults();
         if (!this.root)
             return this._getResultByPropertyName(nodeOrPropertyName);
+        // 0: visit, 1: print
         const stack = [{ opt: 0, node: this.root }];
         while (stack.length > 0) {
             const cur = stack.pop();
@@ -615,6 +847,18 @@ class AbstractBinaryTree {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     }
+    /**
+     * The `levelIterative` function performs a level-order traversal on a binary tree and returns the values of the nodes
+     * in an array, based on a specified property name.
+     * @param {N | null} node - The `node` parameter is a BinaryTreeNode object representing the starting
+     * node for the level order traversal. It can be null if no specific node is provided, in which case the root node of
+     * the tree is used as the starting node.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that
+     * can be either a `BinaryTreeNode` property name or the string `'key'`. If a property name is provided, the function
+     * will accumulate results based on that property. If no property name is provided, the function will default to
+     * accumulating results based on the 'key' property.
+     * @returns An object of type `AbstractBinaryTreeNodeProperties<N>`.
+     */
     levelIterative(node = this.root, nodeOrPropertyName = 'key') {
         if (!node)
             return [];
@@ -634,6 +878,12 @@ class AbstractBinaryTree {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     }
+    /**
+     * The `listLevels` function collects nodes from a binary tree by a specified property and organizes them into levels.
+     * @param {N | null} node - The `node` parameter is a BinaryTreeNode object or null. It represents the root node of a binary tree. If it is null, the function will use the root node of the current binary tree instance.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that specifies the property of the `BinaryTreeNode` object to collect at each level. It can be one of the following values: 'key', 'val', or 'node'. If not provided, it defaults to 'key'.
+     * @returns A 2D array of `AbstractBinaryTreeNodeProperty<N>` objects.
+     */
     listLevels(node = this.root, nodeOrPropertyName = 'key') {
         if (!node)
             return [];
@@ -682,6 +932,11 @@ class AbstractBinaryTree {
         }
         return levelsNodes;
     }
+    /**
+     * The function returns the predecessor of a given node in a binary tree.
+     * @param node - The parameter `node` is a BinaryTreeNode object, representing a node in a binary tree.
+     * @returns the predecessor of the given node in a binary tree.
+     */
     getPredecessor(node) {
         if (node.left) {
             let predecessor = node.left;
@@ -696,6 +951,12 @@ class AbstractBinaryTree {
             return node;
         }
     }
+    /**
+     * The `morris` function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris traversal algorithm.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The traversal pattern: 'in' (in-order), 'pre' (pre-order), or 'post' (post-order).
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The property name of the nodes to retrieve or perform operations on during the traversal. It can be any valid property name of the nodes in the binary tree. If not provided, it defaults to 'key'.
+     * @returns An array of AbstractBinaryTreeNodeProperties<N> objects.
+     */
     morris(pattern = 'in', nodeOrPropertyName = 'key') {
         if (this.root === null)
             return [];
@@ -780,8 +1041,20 @@ class AbstractBinaryTree {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     }
+    /**
+     * The function adds a new node to a binary tree if there is an available position.
+     * @param {N | null} newNode - The `newNode` parameter is of type `N | null`, which means it can either be a node of
+     * type `N` or `null`. It represents the node that you want to add to the binary tree.
+     * @param {N} parent - The parent parameter is of type N, which represents a node in a binary tree.
+     * @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.
+     */
     _addTo(newNode, parent) {
         if (parent) {
+            // When all leaf nodes are null, it will no longer be possible to add new entity nodes to this binary tree.
+            // In this scenario, null nodes serve as "sentinel nodes," "virtual nodes," or "placeholder nodes."
             if (parent.left === undefined) {
                 parent.left = newNode;
                 if (newNode) {
@@ -804,23 +1077,55 @@ class AbstractBinaryTree {
             return;
         }
     }
+    /**
+     * The function sets the loop type for a protected variable.
+     * @param {LoopType} value - The value parameter is of type LoopType.
+     */
     _setLoopType(value) {
         this._loopType = value;
     }
+    /**
+     * 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`.
+     */
     _setRoot(v) {
         if (v) {
             v.parent = undefined;
         }
         this._root = v;
     }
+    /**
+     * The function sets the size of a protected variable.
+     * @param {number} v - number
+     */
     _setSize(v) {
         this._size = v;
     }
+    /**
+     * The function `_clearResults` resets the values of several arrays used for tracking visited nodes and their
+     * properties.
+     */
     _clearResults() {
         this.visitedKey = [];
         this.visitedVal = [];
         this.visitedNode = [];
     }
+    /**
+     * The function checks if a given property of a binary tree node matches a specified value, and if so, adds the node to
+     * a result array.
+     * @param {N} cur - The current node being processed.
+     * @param {(N | null | undefined)[]} result - An array that stores the matching nodes.
+     * @param {BinaryTreeNodeKey | N} nodeProperty - The `nodeProperty` parameter is either a `BinaryTreeNodeKey` or a `N`
+     * type. It represents the property value that we are comparing against in the switch statement.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property name to compare against when pushing nodes into the `result` array. It can be either `'key'`
+     * or `'val'`. If it is not provided or is not equal to `'key'` or `'val'`, the
+     * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to
+     * stop after finding the first matching node or continue searching for all matching nodes. If `onlyOne` is set to
+     * `true`, the function will stop after finding the first matching node and return `true`. If `onlyOne
+     * @returns a boolean value indicating whether only one matching node should be pushed into the result array.
+     */
     _pushByPropertyNameStopOrNot(cur, result, nodeProperty, propertyName = 'key', onlyOne = false) {
         switch (propertyName) {
             case 'key':
@@ -843,6 +1148,13 @@ class AbstractBinaryTree {
                 break;
         }
     }
+    /**
+     * The function `_accumulatedByPropertyName` accumulates values from a given node based on the specified property name.
+     * @param {N} node - The `node` parameter is of type `N`, which represents a node in a data structure.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is an optional parameter that
+     * can be either a string representing a property name or a reference to a `Node` object. If it is a string, it
+     * specifies the property name to be used for accumulating values. If it is a `Node` object, it specifies
+     */
     _accumulatedByPropertyName(node, nodeOrPropertyName = 'key') {
         switch (nodeOrPropertyName) {
             case 'key':
@@ -859,6 +1171,17 @@ class AbstractBinaryTree {
                 break;
         }
     }
+    /**
+     * The time complexity of Morris traversal is O(n), it may slower than others
+     * The space complexity  Morris traversal is O(1) because no using stack
+     */
+    /**
+     * The function `_getResultByPropertyName` returns the corresponding property value based on the given node or property
+     * name.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that
+     * can accept either a `NodeOrPropertyName` type or be undefined.
+     * @returns The method `_getResultByPropertyName` returns an instance of `AbstractBinaryTreeNodeProperties<N>`.
+     */
     _getResultByPropertyName(nodeOrPropertyName = 'key') {
         switch (nodeOrPropertyName) {
             case 'key':