data-structure-typed 0.9.16 → 1.12.9

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

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 var __values = (this && this.__values) || function(o) {
     var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
     if (m) return m.call(o);
@@ -28,7 +32,7 @@ var __read = (this && this.__read) || function (o, n) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BinaryTree = exports.BinaryTreeNode = exports.LoopType = exports.FamilyPosition = void 0;
-var trampoline_1 = require("../trampoline");
+var trampoline_1 = require("../../utils/trampoline");
 var FamilyPosition;
 (function (FamilyPosition) {
     FamilyPosition[FamilyPosition["root"] = 0] = "root";
@@ -160,6 +164,11 @@ var BinaryTreeNode = /** @class */ (function () {
 }());
 exports.BinaryTreeNode = BinaryTreeNode;
 var BinaryTree = /** @class */ (function () {
+    /**
+     * The constructor function accepts an optional options object and sets the values of loopType, autoIncrementId, and
+     * isDuplicatedVal based on the provided options.
+     * @param [options] - An optional object that can contain the following properties:
+     */
     function BinaryTree(options) {
         this._loopType = LoopType.iterative;
         this._visitedId = [];
@@ -214,24 +223,47 @@ var BinaryTree = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    BinaryTree.prototype.getCount = function () {
-        return this._count;
-    };
+    /**
+     * The function creates a new binary tree node with the given id, value, and count, or returns null if the value is
+     * null.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is of type
+     * `BinaryTreeNodeId`, which could be a string or a number, depending on how you want to identify your nodes.
+     * @param {T | null} val - The `val` parameter represents the value to be stored in the binary tree node. It can be of
+     * any type `T` or `null`.
+     * @param {number} [count] - The count parameter is an optional parameter that represents the number of occurrences of
+     * the value in the binary tree node. It is of type number.
+     * @returns The function `createNode` returns a `BinaryTreeNode<T>` object if the `val` parameter is not null.
+     * Otherwise, it returns null.
+     */
     BinaryTree.prototype.createNode = function (id, val, count) {
         return val !== null ? new BinaryTreeNode(id, val, count) : null;
     };
+    /**
+     * The clear function resets the state of an object by setting its properties to their initial values.
+     */
     BinaryTree.prototype.clear = function () {
         this.root = null;
         this.size = 0;
         this.count = 0;
         this._maxId = -1;
     };
+    /**
+     * 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.
+     */
     BinaryTree.prototype.isEmpty = function () {
         return this.size === 0;
     };
-    BinaryTree.prototype.insertTo = function (_a) {
-        var _b, _c;
-        var newNode = _a.newNode, parent = _a.parent;
+    /**
+     * The function inserts a new node into a binary tree as the left or right child of a given parent node.
+     * @param {BinaryTreeNode<T> | null} newNode - The `newNode` parameter is an instance of the `BinaryTreeNode` class or
+     * `null`. It represents the node that needs to be inserted into the binary tree.
+     * @param parent - The `parent` parameter is a BinaryTreeNode object representing the parent node to which the new node
+     * will be inserted as a child.
+     * @returns The method returns the newly inserted node, either as the left child or the right child of the parent node.
+     */
+    BinaryTree.prototype.putTo = function (newNode, parent) {
+        var _a, _b;
         if (parent) {
             if (parent.left === undefined) {
                 if (newNode) {
@@ -241,7 +273,7 @@ var BinaryTree = /** @class */ (function () {
                 parent.left = newNode;
                 if (newNode !== null) {
                     this.size++;
-                    this.count += (_b = newNode === null || newNode === void 0 ? void 0 : newNode.count) !== null && _b !== void 0 ? _b : 0;
+                    this.count += (_a = newNode === null || newNode === void 0 ? void 0 : newNode.count) !== null && _a !== void 0 ? _a : 0;
                 }
                 return parent.left;
             }
@@ -253,7 +285,7 @@ var BinaryTree = /** @class */ (function () {
                 parent.right = newNode;
                 if (newNode !== null) {
                     this.size++;
-                    this.count += (_c = newNode === null || newNode === void 0 ? void 0 : newNode.count) !== null && _c !== void 0 ? _c : 0;
+                    this.count += (_b = newNode === null || newNode === void 0 ? void 0 : newNode.count) !== null && _b !== void 0 ? _b : 0;
                 }
                 return parent.right;
             }
@@ -265,6 +297,17 @@ var BinaryTree = /** @class */ (function () {
             return;
         }
     };
+    /**
+     * The `put` function inserts a new node with a given ID and value into a binary tree, updating the count if the node
+     * already exists.
+     * @param {BinaryTreeNodeId} id - The id parameter is the identifier of the binary tree node. It is used to uniquely
+     * identify each node in the binary tree.
+     * @param {T} val - The value to be inserted into the binary tree.
+     * @param {number} [count] - The `count` parameter is an optional parameter that specifies the number of times the
+     * value should be inserted into the binary tree. If not provided, it defaults to 1.
+     * @returns The function `put` returns a `BinaryTreeNode<T>` object if a new node is inserted, or `null` if no new node
+     * is inserted, or `undefined` if the insertion fails.
+     */
     BinaryTree.prototype.put = function (id, val, count) {
         var _this = this;
         count = count !== null && count !== void 0 ? count : 1;
@@ -273,7 +316,7 @@ var BinaryTree = /** @class */ (function () {
             while (queue.length > 0) {
                 var cur = queue.shift();
                 if (cur) {
-                    var inserted_1 = _this.insertTo({ newNode: newNode, parent: cur });
+                    var inserted_1 = _this.putTo(newNode, cur);
                     if (inserted_1 !== undefined)
                         return inserted_1;
                     if (cur.left)
@@ -312,6 +355,13 @@ var BinaryTree = /** @class */ (function () {
         }
         return inserted;
     };
+    /**
+     * The `insertMany` function inserts multiple items into a binary tree and returns an array of the inserted nodes or
+     * null/undefined values.
+     * @param {T[] | BinaryTreeNode<T>[]} data - The `data` parameter can be either an array of elements of type `T` or an
+     * array of `BinaryTreeNode<T>` objects.
+     * @returns The function `insertMany` returns an array of `BinaryTreeNode<T>`, `null`, or `undefined` values.
+     */
     BinaryTree.prototype.insertMany = function (data) {
         var e_1, _a, e_2, _b;
         var _c;
@@ -377,10 +427,28 @@ var BinaryTree = /** @class */ (function () {
         }
         return inserted;
     };
+    /**
+     * The `fill` function clears the current data and inserts new data, returning a boolean indicating if the insertion
+     * was successful.
+     * @param {T[] | BinaryTreeNode<T>[]} data - The `data` parameter can be either an array of elements of type `T` or an
+     * array of `BinaryTreeNode<T>` objects.
+     * @returns The method is returning a boolean value.
+     */
     BinaryTree.prototype.fill = function (data) {
         this.clear();
         return data.length === this.insertMany(data).length;
     };
+    /**
+     * The function removes a node from a binary tree and returns information about the deleted node.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that you want to remove.
+     * It is of type `BinaryTreeNodeId`.
+     * @param {boolean} [ignoreCount] - The `ignoreCount` parameter is an optional boolean parameter that determines
+     * whether to ignore the count of the node being removed. If `ignoreCount` is set to `true`, the count of the node will
+     * not be decremented and the overall count of the binary tree will not be updated. If `
+     * @returns An array of objects is being returned. Each object in the array has two properties: "deleted" and
+     * "needBalanced". The "deleted" property contains the deleted node or undefined if no node was deleted. The
+     * "needBalanced" property is always null.
+     */
     BinaryTree.prototype.remove = function (id, ignoreCount) {
         var nodes = this.getNodes(id, 'id', true);
         var node = nodes[0];
@@ -416,6 +484,12 @@ var BinaryTree = /** @class */ (function () {
         }
         return [{ deleted: node, needBalanced: null }];
     };
+    /**
+     * The function calculates the depth of a binary tree node by traversing its parent nodes.
+     * @param node - BinaryTreeNode<T> - This is the node for which we want to calculate the depth. It is a generic type,
+     * meaning it can represent any type of data that we want to store in the node.
+     * @returns The depth of the given binary tree node.
+     */
     BinaryTree.prototype.getDepth = function (node) {
         var depth = 0;
         while (node.parent) {
@@ -424,6 +498,14 @@ var BinaryTree = /** @class */ (function () {
         }
         return depth;
     };
+    /**
+     * The `getHeight` function calculates the maximum height of a binary tree using either a recursive or iterative
+     * approach.
+     * @param {BinaryTreeNode<T> | null} [beginRoot] - The `beginRoot` parameter is an optional parameter of type
+     * `BinaryTreeNode<T> | null`. It represents the starting node from which to calculate the height of the binary tree.
+     * If no value is provided for `beginRoot`, the function will use the `root` property of the class instance as
+     * @returns the height of the binary tree.
+     */
     BinaryTree.prototype.getHeight = function (beginRoot) {
         var _a, _b, _c;
         beginRoot = beginRoot !== null && beginRoot !== void 0 ? beginRoot : this.root;
@@ -467,6 +549,14 @@ var BinaryTree = /** @class */ (function () {
             return (_c = depths.get(beginRoot)) !== null && _c !== void 0 ? _c : -1;
         }
     };
+    /**
+     * The `getMinHeight` function calculates the minimum height of a binary tree using either a recursive or iterative
+     * approach.
+     * @param {BinaryTreeNode<T> | null} [beginRoot] - The `beginRoot` parameter is an optional parameter of type
+     * `BinaryTreeNode<T> | null`. It represents the starting node from which to calculate the minimum height of the binary
+     * tree. If no value is provided for `beginRoot`, the function will use the root node of the binary tree.
+     * @returns The function `getMinHeight` returns the minimum height of the binary tree.
+     */
     BinaryTree.prototype.getMinHeight = function (beginRoot) {
         var _a, _b, _c;
         beginRoot = beginRoot || this.root;
@@ -512,9 +602,27 @@ var BinaryTree = /** @class */ (function () {
             return (_c = depths.get(beginRoot)) !== null && _c !== void 0 ? _c : -1;
         }
     };
+    /**
+     * The function checks if a binary tree is balanced by comparing the minimum height and the maximum height of the tree.
+     * @param {BinaryTreeNode<T> | null} [beginRoot] - The `beginRoot` parameter is the root node of a binary tree. It is
+     * of type `BinaryTreeNode<T> | null`, which means it can either be a `BinaryTreeNode` object or `null`.
+     * @returns The method is returning a boolean value.
+     */
     BinaryTree.prototype.isBalanced = function (beginRoot) {
         return (this.getMinHeight(beginRoot) + 1 >= this.getHeight(beginRoot));
     };
+    /**
+     * The function `getNodes` returns an array of binary tree nodes that match a given property value, with options for
+     * searching recursively or iteratively.
+     * @param {BinaryTreeNodeId | T} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeId` or a
+     * generic type `T`. 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 'id'.
+     * @param {boolean} [onlyOne] - The `onlyOne` parameter is an optional boolean parameter that determines whether to
+     * return only one node that matches the `nodeProperty` or `propertyName` criteria. If `onlyOne` is set to `true`, the
+     * function will stop traversing the tree and return the first matching node. If `
+     * @returns The function `getNodes` returns an array of `BinaryTreeNode<T> | null | undefined` objects.
+     */
     BinaryTree.prototype.getNodes = function (nodeProperty, propertyName, onlyOne) {
         var _this = this;
         if (!this.root)
@@ -546,14 +654,39 @@ var BinaryTree = /** @class */ (function () {
         }
         return result;
     };
+    /**
+     * The function checks if a binary tree node has a specific property or if any node in the tree has a specific
+     * property.
+     * @param {BinaryTreeNodeId | T} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeId` or a
+     * generic type `T`. It represents the property of a 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 check for in the nodes.
+     * @returns a boolean value.
+     */
     BinaryTree.prototype.has = function (nodeProperty, propertyName) {
         return this.getNodes(nodeProperty, propertyName).length > 0;
     };
+    /**
+     * The function returns the first binary tree node that matches the given property name and value, or null if no match
+     * is found.
+     * @param {BinaryTreeNodeId | T} nodeProperty - The `nodeProperty` parameter can be either a `BinaryTreeNodeId` or a
+     * generic type `T`. 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 of the binary tree node to search for. If not provided, it defaults to `'id'`.
+     * @returns a BinaryTreeNode object or null.
+     */
     BinaryTree.prototype.get = function (nodeProperty, propertyName) {
         var _a;
         propertyName = propertyName !== null && propertyName !== void 0 ? propertyName : 'id';
         return (_a = this.getNodes(nodeProperty, propertyName, true)[0]) !== null && _a !== void 0 ? _a : null;
     };
+    /**
+     * The function getPathToRoot returns an array of BinaryTreeNode objects representing the path from a given node to the
+     * root of a binary tree.
+     * @param node - The `node` parameter is a BinaryTreeNode object.
+     * @returns The function `getPathToRoot` returns an array of `BinaryTreeNode<T>` objects, representing the path from
+     * the given `node` to the root of the binary tree.
+     */
     BinaryTree.prototype.getPathToRoot = function (node) {
         var result = [];
         while (node.parent) {
@@ -563,9 +696,14 @@ var BinaryTree = /** @class */ (function () {
         result.unshift(node);
         return result;
     };
-    BinaryTree.prototype.getRoot = function () {
-        return this.root;
-    };
+    /**
+     * The `getLeftMost` function returns the leftmost node in a binary tree, either recursively or iteratively using tail
+     * recursion optimization.
+     * @param {BinaryTreeNode<T> | null} [node] - The `node` parameter is an optional parameter of type `BinaryTreeNode<T>
+     * | null`. It represents the starting node from which to find the leftmost node in a binary tree. If no node is
+     * provided, the function will use the root node of the binary tree.
+     * @returns The `getLeftMost` function returns the leftmost node in a binary tree.
+     */
     BinaryTree.prototype.getLeftMost = function (node) {
         node = node !== null && node !== void 0 ? node : this.root;
         if (!node)
@@ -588,6 +726,14 @@ var BinaryTree = /** @class */ (function () {
             return _traverse_3(node);
         }
     };
+    /**
+     * The `getRightMost` function returns the rightmost node in a binary tree, either recursively or iteratively using
+     * tail recursion optimization.
+     * @param {BinaryTreeNode<T> | null} [node] - The `node` parameter is an optional parameter of type `BinaryTreeNode<T>
+     * | null`. It represents the starting node from which to find the rightmost node in a binary tree. If no node is
+     * provided, the function will use the root node of the binary tree.
+     * @returns The `getRightMost` function returns the rightmost node in a binary tree.
+     */
     BinaryTree.prototype.getRightMost = function (node) {
         node = node !== null && node !== void 0 ? node : this.root;
         if (!node)
@@ -611,6 +757,14 @@ var BinaryTree = /** @class */ (function () {
         }
     };
     // --- start additional methods ---
+    /**
+     * The `isBST` function checks if a binary tree is a binary search tree.
+     * @param {BinaryTreeNode<T> | null} [node] - The `node` parameter is an optional parameter of type `BinaryTreeNode<T>
+     * | null`. It represents the root node of the binary search tree (BST) that we want to check for validity. If no node
+     * is provided, the function will default to using the root node of the BST instance that
+     * @returns The `isBST` function returns a boolean value. It returns `true` if the binary tree is a valid binary search
+     * tree, and `false` otherwise.
+     */
     BinaryTree.prototype.isBST = function (node) {
         node = node !== null && node !== void 0 ? node : this.root;
         if (!node)
@@ -642,6 +796,14 @@ var BinaryTree = /** @class */ (function () {
             return true;
         }
     };
+    /**
+     * The function calculates the size and count of a subtree in a binary tree using either recursive or iterative
+     * traversal.
+     * @param {BinaryTreeNode<T> | null | undefined} subTreeRoot - The `subTreeRoot` parameter is the root node of a binary
+     * tree.
+     * @returns The function `getSubTreeSizeAndCount` returns an array `[number, number]`. The first element of the array
+     * represents the size of the subtree, and the second element represents the count of the nodes in the subtree.
+     */
     BinaryTree.prototype.getSubTreeSizeAndCount = function (subTreeRoot) {
         var res = [0, 0];
         if (!subTreeRoot)
@@ -668,6 +830,16 @@ var BinaryTree = /** @class */ (function () {
             return res;
         }
     };
+    /**
+     * The function `subTreeSum` calculates the sum of a specified property in a binary tree, either recursively or
+     * iteratively.
+     * @param subTreeRoot - The subTreeRoot parameter is the root node of the subtree for which you want to calculate the
+     * sum.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property of the `BinaryTreeNode` object to use for calculating the sum. If `propertyName` is not
+     * provided, it defaults to `'val'`.
+     * @returns a number, which is the sum of the values of the nodes in the subtree rooted at `subTreeRoot`.
+     */
     BinaryTree.prototype.subTreeSum = function (subTreeRoot, propertyName) {
         propertyName = propertyName !== null && propertyName !== void 0 ? propertyName : 'val';
         if (!subTreeRoot)
@@ -710,6 +882,15 @@ var BinaryTree = /** @class */ (function () {
         }
         return sum;
     };
+    /**
+     * The function `subTreeAdd` adds a specified delta value to a property of each node in a binary tree.
+     * @param subTreeRoot - The `subTreeRoot` parameter is the root node of the subtree where the values will be modified.
+     * @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 increased or decreased.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property of the `BinaryTreeNode` that should be modified. It defaults to `'id'` if not provided.
+     * @returns a boolean value, which is `true`.
+     */
     BinaryTree.prototype.subTreeAdd = function (subTreeRoot, delta, propertyName) {
         var _this = this;
         propertyName = propertyName !== null && propertyName !== void 0 ? propertyName : 'id';
@@ -748,6 +929,15 @@ var BinaryTree = /** @class */ (function () {
         }
         return true;
     };
+    /**
+     * The BFS function performs a breadth-first search on a binary tree and returns the results based on a specified node
+     * or property name.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that
+     * represents either a node or a property name. If a node is provided, the breadth-first search algorithm will be
+     * performed starting from that node. If a property name is provided, the breadth-first search algorithm will be
+     * performed starting from the root node
+     * @returns an object of type `ResultsByProperty<T>`.
+     */
     BinaryTree.prototype.BFS = function (nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName !== null && nodeOrPropertyName !== void 0 ? nodeOrPropertyName : 'id';
         this._resetResults();
@@ -764,6 +954,18 @@ var BinaryTree = /** @class */ (function () {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     };
+    /**
+     * The DFS function performs a depth-first search traversal on a binary tree and returns the results based on the
+     * specified pattern and node or property name.
+     * @param {'in' | 'pre' | 'post'} [pattern] - The "pattern" parameter is used to specify the order in which the nodes
+     * of a binary tree are traversed during the Depth-First Search (DFS) algorithm. It can take one of three values: 'in',
+     * 'pre', or 'post'.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is a string that represents
+     * either the name of a property in the `BinaryTreeNode` object or the value of the `id` property in the
+     * `BinaryTreeNode` object. This parameter is used to accumulate the results based on the specified property name. If
+     * no value
+     * @returns an object of type `ResultsByProperty<T>`.
+     */
     BinaryTree.prototype.DFS = function (pattern, nodeOrPropertyName) {
         var _this = this;
         pattern = pattern !== null && pattern !== void 0 ? pattern : 'in';
@@ -846,6 +1048,18 @@ var BinaryTree = /** @class */ (function () {
         }
         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 {BinaryTreeNode<T> | 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 `'id'`. 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
+     * @returns The function `levelIterative` returns an object of type `ResultsByProperty<T>`.
+     */
     BinaryTree.prototype.levelIterative = function (node, nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName || 'id';
         node = node || this.root;
@@ -867,6 +1081,15 @@ var BinaryTree = /** @class */ (function () {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     };
+    /**
+     * The `listLevels` function collects nodes from a binary tree by a specified property and organizes them into levels.
+     * @param {BinaryTreeNode<T> | 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:
+     * @returns The function `listLevels` returns a 2D array of `ResultByProperty<T>` objects.
+     */
     BinaryTree.prototype.listLevels = function (node, nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName || 'id';
         node = node || this.root;
@@ -920,6 +1143,11 @@ var BinaryTree = /** @class */ (function () {
         }
         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.
+     */
     BinaryTree.prototype.getPredecessor = function (node) {
         if (node.left) {
             var predecessor = node.left;
@@ -935,10 +1163,16 @@ var BinaryTree = /** @class */ (function () {
         }
     };
     /**
+     * The `morris` function performs an in-order, pre-order, or post-order traversal on a binary tree using the Morris
+     * traversal algorithm and returns the results based on the specified property name.
      * The time complexity of Morris traversal is O(n), it's may slower than others
      * The space complexity  Morris traversal is O(1) because no using stack
-     * @param pattern
-     * @param nodeOrPropertyName
+     * @param {'in' | 'pre' | 'post'} [pattern] - The `pattern` parameter is an optional parameter that determines the
+     * traversal pattern of the binary tree. It can have one of three values:
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The `nodeOrPropertyName` parameter is used to specify the
+     * property of the nodes that you want to retrieve in the results. It can be either the node itself or the name of the
+     * property. If not provided, it defaults to `'id'`.
+     * @returns The function `morris` returns an object of type `ResultsByProperty<T>`.
      */
     BinaryTree.prototype.morris = function (pattern, nodeOrPropertyName) {
         var _this = this;
@@ -1027,6 +1261,9 @@ var BinaryTree = /** @class */ (function () {
         }
         return this._getResultByPropertyName(nodeOrPropertyName);
     };
+    /**
+     * The function resets the values of several arrays used for tracking visited nodes and their properties.
+     */
     BinaryTree.prototype._resetResults = function () {
         this._visitedId = [];
         this._visitedVal = [];
@@ -1034,6 +1271,22 @@ var BinaryTree = /** @class */ (function () {
         this._visitedCount = [];
         this._visitedLeftSum = [];
     };
+    /**
+     * 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 cur - The current binary tree node that is being checked.
+     * @param {(BinaryTreeNode<T> | null | undefined)[]} result - An array that stores the matching nodes found during the
+     * traversal.
+     * @param {BinaryTreeNodeId | T} nodeProperty - The `nodeProperty` parameter is the value that we are searching for in
+     * the binary tree nodes. It can be either the `id`, `count`, or `val` property of the node.
+     * @param {BinaryTreeNodePropertyName} [propertyName] - The `propertyName` parameter is an optional parameter that
+     * specifies the property of the `BinaryTreeNode` object that you want to compare with the `nodeProperty` value. It can
+     * be one of the following values: 'id', 'count', or 'val'. If no `propertyName` is provided,
+     * @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 or not a node was pushed into the result array.
+     */
     BinaryTree.prototype._pushByPropertyNameStopOrNot = function (cur, result, nodeProperty, propertyName, onlyOne) {
         switch (propertyName) {
             case 'id':
@@ -1062,6 +1315,14 @@ var BinaryTree = /** @class */ (function () {
                 break;
         }
     };
+    /**
+     * The function `_accumulatedByPropertyName` pushes a property value of a binary tree node into an array based on the
+     * provided property name or a default property name.
+     * @param node - The `node` parameter is of type `BinaryTreeNode<T>`, which represents a node in a binary tree.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` 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 of the node that should be accumulated. If it is a node object, it specifies the node itself
+     */
     BinaryTree.prototype._accumulatedByPropertyName = function (node, nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName !== null && nodeOrPropertyName !== void 0 ? nodeOrPropertyName : 'id';
         switch (nodeOrPropertyName) {
@@ -1082,6 +1343,13 @@ var BinaryTree = /** @class */ (function () {
                 break;
         }
     };
+    /**
+     * The function `_getResultByPropertyName` returns different results based on the provided property name or defaulting
+     * to 'id'.
+     * @param {NodeOrPropertyName} [nodeOrPropertyName] - The parameter `nodeOrPropertyName` is an optional parameter that
+     * can accept a value of type `NodeOrPropertyName`.
+     * @returns The method returns an object of type `ResultsByProperty<T>`.
+     */
     BinaryTree.prototype._getResultByPropertyName = function (nodeOrPropertyName) {
         nodeOrPropertyName = nodeOrPropertyName !== null && nodeOrPropertyName !== void 0 ? nodeOrPropertyName : 'id';
         switch (nodeOrPropertyName) {

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

@@ -1,3 +1,7 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 import type { BinaryTreeNodeId, BinaryTreeNodePropertyName, BSTComparator, BSTDeletedResult } from '../types';
 import { BinaryTree, BinaryTreeNode, LoopType } from './binary-tree';
 export declare enum CP {
@@ -14,6 +18,18 @@ export declare class BST<T> extends BinaryTree<T> {
         loopType?: LoopType;
     });
     createNode(id: BinaryTreeNodeId, val: T | null, count?: number): BSTNode<T> | null;
+    /**
+     * The `put` function inserts a new node into a binary search tree, updating the count and value of an existing node if
+     * the ID matches, and returns the inserted node.
+     * @param {BinaryTreeNodeId} id - The `id` parameter represents the identifier of the binary tree node. It is used to
+     * determine the position of the node in the binary search tree.
+     * @param {T | null} val - The `val` parameter represents the value to be stored in the binary search tree node. It can
+     * be of type `T` (the generic type) or `null`.
+     * @param {number} [count=1] - The `count` parameter represents the number of times the value should be inserted into
+     * the binary search tree. By default, it is set to 1, meaning that if no count is specified, the value will be
+     * inserted once.
+     * @returns The method `put` returns a `BSTNode<T>` object or `null`.
+     */
     put(id: BinaryTreeNodeId, val: T | null, count?: number): BSTNode<T> | null;
     get(nodeProperty: BinaryTreeNodeId | T, propertyName?: BinaryTreeNodePropertyName): BSTNode<T> | null;
     lastKey(): number;

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

@@ -66,6 +66,18 @@ var BST = /** @class */ (function (_super) {
     BST.prototype.createNode = function (id, val, count) {
         return val !== null ? new BSTNode(id, val, count) : null;
     };
+    /**
+     * The `put` function inserts a new node into a binary search tree, updating the count and value of an existing node if
+     * the ID matches, and returns the inserted node.
+     * @param {BinaryTreeNodeId} id - The `id` parameter represents the identifier of the binary tree node. It is used to
+     * determine the position of the node in the binary search tree.
+     * @param {T | null} val - The `val` parameter represents the value to be stored in the binary search tree node. It can
+     * be of type `T` (the generic type) or `null`.
+     * @param {number} [count=1] - The `count` parameter represents the number of times the value should be inserted into
+     * the binary search tree. By default, it is set to 1, meaning that if no count is specified, the value will be
+     * inserted once.
+     * @returns The method `put` returns a `BSTNode<T>` object or `null`.
+     */
     BST.prototype.put = function (id, val, count) {
         var _a;
         if (count === void 0) { count = 1; }

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

@@ -1,3 +1,7 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 import type { SegmentTreeNodeVal } from '../types';
 export declare class SegmentTreeNode {
     constructor(start: number, end: number, sum: number, val?: SegmentTreeNodeVal | null);

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

@@ -1,4 +1,8 @@
 "use strict";
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SegmentTree = exports.SegmentTreeNode = void 0;
 var SegmentTreeNode = /** @class */ (function () {

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

@@ -1,3 +1,7 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 import { BST, BSTNode } from './bst';
 import type { BinaryTreeNodeId, TreeMultiSetDeletedResult } from '../types';
 export declare class TreeMultiSet<T> extends BST<T> {

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

@@ -16,6 +16,10 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreeMultiSet = void 0;
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 var bst_1 = require("./bst");
 var TreeMultiSet = /** @class */ (function (_super) {
     __extends(TreeMultiSet, _super);