data-structure-typed 1.12.11 → 1.15.0

package/README.md

@@ -1,4 +1,3 @@
-# data-structure-typed
 
 Javascript Data Structure, TypeScript Data Structure Library
 
@@ -15,15 +14,22 @@ yarn add data-structure-typed
 ```bash
 npm install data-structure-typed
 ```
-## Online examples
 
-[Online Examples](https://data-structure-typed-examples.vercel.app)
+## Live Examples
 
-## Examples Repository
+[//]: # ([Live Examples](https://data-structure-typed-examples.vercel.app))
 
-[Example Repository](https://github.com/zrwusa/data-structure-typed-examples)
+<a href="https://data-structure-typed-examples.vercel.app" target="_blank">Live Examples</a>
 
-## api docs
+## Data Structures
+
+Meticulously crafted to empower developers with a versatile set of essential data structures. Our library includes a
+wide range of data structures:
+Binary Tree, Binary Search Tree (BST), AVL Tree, Tree Multiset, Segment Tree, Binary Indexed Tree, Graph, Directed
+Graph, Undirected Graph, Linked List, Singly Linked List, Doubly Linked List, Queue, Object Deque, Array Deque, Stack,
+Hash, Coordinate Set, Coordinate Map, Heap, Priority Queue, Max Priority Queue, Min Priority Queue, Trie
+
+## API docs
 
 [//]: # ([api docs]&#40;https://data-structure-typed-docs.vercel.app/&#41;)
 
@@ -37,14 +43,16 @@ npm install data-structure-typed
 [//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/enums/LoopType.html"><span>Loop<wbr/>Type</span></a></li>)
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/AVLTree.html"><span>AVLTree</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/AVLTreeNode.html"><span>AVLTree<wbr/>Node</span></a></li>
-<li><a href="https://data-structure-typed-docs.vercel.app/classes/AaTree.html"><span>Aa<wbr/>Tree</span></a></li>
+
+[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/AaTree.html"><span>Aa<wbr/>Tree</span></a></li>)
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractEdge.html"><span>Abstract<wbr/>Edge</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractGraph.html"><span>Abstract<wbr/>Graph</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractVertex.html"><span>Abstract<wbr/>Vertex</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/ArrayDeque.html"><span>Array<wbr/>Deque</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/BST.html"><span>BST</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/BSTNode.html"><span>BSTNode</span></a></li>
-<li><a href="https://data-structure-typed-docs.vercel.app/classes/BTree.html"><span>BTree</span></a></li>
+
+[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/BTree.html"><span>BTree</span></a></li>)
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryIndexedTree.html"><span>Binary<wbr/>Indexed<wbr/>Tree</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTree.html"><span>Binary<wbr/>Tree</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTreeNode.html"><span>Binary<wbr/>Tree<wbr/>Node</span></a></li>
@@ -68,200 +76,292 @@ npm install data-structure-typed
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/ObjectDeque.html"><span>Object<wbr/>Deque</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/PriorityQueue.html"><span>Priority<wbr/>Queue</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/Queue.html"><span>Queue</span></a></li>
-<li><a href="https://data-structure-typed-docs.vercel.app/classes/RBTree.html"><span>RBTree</span></a></li>
+
+[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/RBTree.html"><span>RBTree</span></a></li>)
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/SegmentTree.html"><span>Segment<wbr/>Tree</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/SegmentTreeNode.html"><span>Segment<wbr/>Tree<wbr/>Node</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/SinglyLinkedList.html"><span>Singly<wbr/>Linked<wbr/>List</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/SinglyLinkedListNode.html"><span>Singly<wbr/>Linked<wbr/>List<wbr/>Node</span></a></li>
-<li><a href="https://data-structure-typed-docs.vercel.app/classes/SplayTree.html"><span>Splay<wbr/>Tree</span></a></li>
+
+[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/SplayTree.html"><span>Splay<wbr/>Tree</span></a></li>)
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/Stack.html"><span>Stack</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/TreeMultiSet.html"><span>Tree<wbr/>Multi<wbr/>Set</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/Trie.html"><span>Trie</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/TrieNode.html"><span>Trie<wbr/>Node</span></a></li>
-<li><a href="https://data-structure-typed-docs.vercel.app/classes/TwoThreeTree.html"><span>Two<wbr/>Three<wbr/>Tree</span></a></li>
+
+[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/TwoThreeTree.html"><span>Two<wbr/>Three<wbr/>Tree</span></a></li>)
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedEdge.html"><span>Undirected<wbr/>Edge</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedGraph.html"><span>Undirected<wbr/>Graph</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedVertex.html"><span>Undirected<wbr/>Vertex</span></a></li>
 <li><a href="https://data-structure-typed-docs.vercel.app/classes/Vector2D.html"><span>Vector2D</span></a></li></ul></nav>
 
-## data structures
+[//]: # ([Examples Repository]&#40;https://github.com/zrwusa/data-structure-typed-examples&#41;)
+
+<a href="https://github.com/zrwusa/data-structure-typed-examples" target="_blank">Examples Repository</a>
+
+
+## Complexities
+
+### performance of Big O
 
-Meticulously crafted to empower developers with a versatile set of essential data structures. Our library includes a wide range of data structures:
-Binary Tree, Binary Search Tree (BST), AVL Tree, Tree Multiset, Segment Tree, Binary Indexed Tree, Graph, Directed Graph, Undirected Graph, Linked List, Singly Linked List, Doubly Linked List, Queue, Object Deque, Array Deque, Stack, Hash, Coordinate Set, Coordinate Map, Heap, Priority Queue, Max Priority Queue, Min Priority Queue, Trie
 <table>
 <thead>
-  <tr>
-    <th>Data Structure</th>
-    <th>Derived</th>
-    <th>Basic Features</th>
-    <th>Additional Features</th>
-  </tr>
+<tr>
+<th>Big O Notation</th>
+<th>Type</th>
+<th>Computations for 10 elements</th>
+<th>Computations for 100 elements</th>
+<th>Computations for 1000 elements</th>
+</tr>
 </thead>
-
 <tbody>
 <tr>
-    <td>Binary Tree</td>
-    <td>AVL Tree, Binary Search Tree, Tree Multiset</td>
-    <td>put, has, get, remove, size, insertTo, insertMany, fill, getDepth, getHeight, getMinHeight, getPathToRoot, isBalanced </td>
-    <td>getLeftMost, isBST, getSubTreeSizeAndCount, subTreeSum, subTreeAdd, BFS, DFS, DFSIterative, levelIterative, listLevels, getPredecessor, morris,  </td>
-  </tr>
-
-  <tr>
-    <td>AVL Tree</td>
-    <td></td>
-    <td>All the features inherited from Binary Tree, balanceFactor, updateHeight, balancePath, balanceLL, balanceLR, balanceRR, balanceRL</td>
-    <td></td>
-  </tr>
-
-  <tr>
-    <td>Binary Search Tree (BST)</td>
-    <td></td>
-    <td>All the features inherited from Binary Tree, lastKey</td>
-    <td>All the features inherited from Binary Tree, lesserSum, allGreaterNodesAdd, balance, isAVLBalanced</td>
-  </tr>
-
-  <tr>
-    <td>Tree Multiset</td>
-    <td></td>
-    <td>All the features inherited from Binary Tree</td>
-    <td>All the features inherited from Binary Tree</td>
-  </tr>
-
-  <tr>
-    <td>Segment Tree</td>
-    <td></td>
-    <td>build, updateNode, querySumByRange</td>
-    <td></td>
-  </tr>
-
-  <tr>
-    <td>Binary Indexed Tree</td>
-    <td></td>
-    <td>update, getPrefixSum, getRangeSum, BinaryIndexedTree.lowBit</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>Graph</td>
-    <td>Directed Graph, Undirected Graph</td>
-    <td>getVertex, getVertexId, containsVertex, vertexSet, addVertex, removeVertex, removeAllVertices, containsEdge, setEdgeWeight, getAllPathsBetween, getPathSumWeight, getMinCostBetween, getMinPathBetween, </td>
-    <td>dijkstra, dijkstraWithoutHeap, bellmanFord, floyd, tarjan</td>
-  </tr>
-  <tr>
-    <td>Directed Graph</td>
-    <td></td>
-    <td>All the features inherited from Graph, getEdge, addEdge, removeEdgeBetween, removeEdge, removeAllEdges, incomingEdgesOf, outgoingEdgesOf, degreeOf, inDegreeOf, outDegreeOf, edgesOf, getEdgeSrc, getEdgeDest, getDestinations, edgeSet, getNeighbors, getEndsOfEdge</td>
-    <td>All the features inherited from Graph, topologicalSort</td>
-  </tr>
-  <tr>
-    <td>Undirected Graph</td>
-    <td></td>
-    <td>All the features inherited from Graph, getEdge, addEdge, removeEdgeBetween, removeEdge, degreeOf, edgesOf, edgeSet, getEdgesOf, getNeighbors, getEndsOfEdge</td>
-    <td>All the features inherited from Graph</td>
-  </tr>
-  <tr>
-    <td>Singly Linked List</td>
-    <td></td>
-    <td>length, head, tail, size, get, getNode, findNodeIndex, findNode, find, findIndex, append, push, prepend, insertAt, removeNode, removeAt, insertBefore, sort, insertAfter, shift, pop, merge, clear, slice, reverse, forEach, map, filter, reduce, toArray, toString</td>
-    <td></td>
-
-  </tr>
-  <tr>
-    <td>Hash</td>
-    <td>CoordinateSet, CoordinateMap</td>
-    <td></td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>CoordinateSet</td>
-    <td></td>
-    <td>has, set, get, delete</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>CoordinateMap</td>
-    <td></td>
-    <td>has, add, delete</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>Heap</td>
-    <td></td>
-    <td></td>
-  </tr>
-
-
-  <tr>
-    <td>Doubly Linked List</td>
-    <td></td>
-    <td>size, offerFirst, offerLast, peekFirst, peekLast, pollFirst, pollLast, get, isEmpty, insert, remove, </td>
-    <td></td>
-  </tr>
-
-[//]: # (  <tr>)
-
-[//]: # (    <td>Matrix</td>)
-
-[//]: # (    <td></td>)
-
-[//]: # (    <td></td>)
-
-[//]: # (    <td></td>)
-
-[//]: # (  </tr>)
-
-  <tr>
-    <td>Priority Queue</td>
-    <td>Max Priority Queue, Min Priority Queue</td>
-    <td>offer, peek, poll, leaf, isEmpty, clear, toArray, clone</td>
-    <td>isValid, sort, DFS</td>
-  </tr>
-  <tr>
-    <td>Max Priority Queue</td>
-    <td></td>
-    <td>All the features inherited from Priority Queue</td>
-    <td>All the features inherited from Priority Queue</td>
-  </tr>
-  <tr>
-    <td>Min Priority Queue</td>
-    <td></td>
-    <td>All the features inherited from Priority Queue</td>
-    <td>All the features inherited from Priority Queue</td>
-  </tr>
-  <tr>
-    <td>Queue</td>
-    <td>Queue, Dequeue</td>
-    <td>offer, poll, peek, peekLast, size, isEmpty, toArray, clear, clone, Queue.fromArray</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>ObjectDeque</td>
-    <td></td>
-    <td>size, offerFirst, offerLast, pollFirst, peekFirst, pollLast, peekLast, get, isEmpty</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>ArrayDeque</td>
-    <td></td>
-    <td>offerLast, pollLast, pollFirst, offerFirst, peekFirst, peekLast, get, set, insert, remove, isEmpty</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>Stack</td>
-    <td></td>
-    <td>isEmpty, size, peek, push, pop, toArray, clear, clone, Stack.fromArray</td>
-    <td></td>
-  </tr>
-  <tr>
-    <td>Trie</td>
-    <td></td>
-    <td>put, has, remove, isAbsPrefix, isPrefix, getAll</td>
-    <td></td>
-  </tr>
+<td><strong>O(1)</strong></td>
+<td>Constant</td>
+<td>1</td>
+<td>1</td>
+<td>1</td>
+</tr>
+<tr>
+<td><strong>O(log N)</strong></td>
+<td>Logarithmic</td>
+<td>3</td>
+<td>6</td>
+<td>9</td>
+</tr>
+<tr>
+<td><strong>O(N)</strong></td>
+<td>Linear</td>
+<td>10</td>
+<td>100</td>
+<td>1000</td>
+</tr>
+<tr>
+<td><strong>O(N log N)</strong></td>
+<td>n log(n)</td>
+<td>30</td>
+<td>600</td>
+<td>9000</td>
+</tr>
+<tr>
+<td><strong>O(N^2)</strong></td>
+<td>Quadratic</td>
+<td>100</td>
+<td>10000</td>
+<td>1000000</td>
+</tr>
+<tr>
+<td><strong>O(2^N)</strong></td>
+<td>Exponential</td>
+<td>1024</td>
+<td>1.26e+29</td>
+<td>1.07e+301</td>
+</tr>
+<tr>
+<td><strong>O(N!)</strong></td>
+<td>Factorial</td>
+<td>3628800</td>
+<td>9.3e+157</td>
+<td>4.02e+2567</td>
+</tr>
 </tbody>
+</table>
+
+### Data Structure Complexity
 
+<table>
+<thead>
+<tr>
+<th>Data Structure</th>
+<th>Access</th>
+<th>Search</th>
+<th>Insertion</th>
+<th>Deletion</th>
+<th>Comments</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>Array</strong></td>
+<td>1</td>
+<td>n</td>
+<td>n</td>
+<td>n</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Stack</strong></td>
+<td>n</td>
+<td>n</td>
+<td>1</td>
+<td>1</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Queue</strong></td>
+<td>n</td>
+<td>n</td>
+<td>1</td>
+<td>1</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Linked List</strong></td>
+<td>n</td>
+<td>n</td>
+<td>1</td>
+<td>n</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Hash Table</strong></td>
+<td>-</td>
+<td>n</td>
+<td>n</td>
+<td>n</td>
+<td>In case of perfect hash function costs would be O(1)</td>
+</tr>
+<tr>
+<td><strong>Binary Search Tree</strong></td>
+<td>n</td>
+<td>n</td>
+<td>n</td>
+<td>n</td>
+<td>In case of balanced tree costs would be O(log(n))</td>
+</tr>
+<tr>
+<td><strong>B-Tree</strong></td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Red-Black Tree</strong></td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>AVL Tree</strong></td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td>log(n)</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Bloom Filter</strong></td>
+<td>-</td>
+<td>1</td>
+<td>1</td>
+<td>-</td>
+<td>False positives are possible while searching</td>
+</tr>
+</tbody>
 </table>
 
+### Sorting Complexity
 
+<table>
+<thead>
+<tr>
+<th>Name</th>
+<th>Best</th>
+<th>Average</th>
+<th>Worst</th>
+<th>Memory</th>
+<th>Stable</th>
+<th>Comments</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><strong>Bubble sort</strong></td>
+<td>n</td>
+<td>n<sup>2</sup></td>
+<td>n<sup>2</sup></td>
+<td>1</td>
+<td>Yes</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Insertion sort</strong></td>
+<td>n</td>
+<td>n<sup>2</sup></td>
+<td>n<sup>2</sup></td>
+<td>1</td>
+<td>Yes</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Selection sort</strong></td>
+<td>n<sup>2</sup></td>
+<td>n<sup>2</sup></td>
+<td>n<sup>2</sup></td>
+<td>1</td>
+<td>No</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Heap sort</strong></td>
+<td>n&nbsp;log(n)</td>
+<td>n&nbsp;log(n)</td>
+<td>n&nbsp;log(n)</td>
+<td>1</td>
+<td>No</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Merge sort</strong></td>
+<td>n&nbsp;log(n)</td>
+<td>n&nbsp;log(n)</td>
+<td>n&nbsp;log(n)</td>
+<td>n</td>
+<td>Yes</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Quick sort</strong></td>
+<td>n&nbsp;log(n)</td>
+<td>n&nbsp;log(n)</td>
+<td>n<sup>2</sup></td>
+<td>log(n)</td>
+<td>No</td>
+<td>Quicksort is usually done in-place with O(log(n)) stack space</td>
+</tr>
+<tr>
+<td><strong>Shell sort</strong></td>
+<td>n&nbsp;log(n)</td>
+<td>depends on gap sequence</td>
+<td>n&nbsp;(log(n))<sup>2</sup></td>
+<td>1</td>
+<td>No</td>
+<td></td>
+</tr>
+<tr>
+<td><strong>Counting sort</strong></td>
+<td>n + r</td>
+<td>n + r</td>
+<td>n + r</td>
+<td>n + r</td>
+<td>Yes</td>
+<td>r - biggest number in array</td>
+</tr>
+<tr>
+<td><strong>Radix sort</strong></td>
+<td>n * k</td>
+<td>n * k</td>
+<td>n * k</td>
+<td>n + k</td>
+<td>Yes</td>
+<td>k - length of longest key</td>
+</tr>
+</tbody>
+</table>
 
 
 ![complexities](src/assets/complexities-diff.jpg)
@@ -272,7 +372,6 @@ Binary Tree, Binary Search Tree (BST), AVL Tree, Tree Multiset, Segment Tree, Bi
 
 ![](src/data-structures/binary-tree/diagrams/avl-tree-inserting.gif)
 
-
 ![](src/data-structures/graph/diagrams/tarjan.webp)
 
 ![](src/data-structures/graph/diagrams/adjacency-list.jpg)

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

@@ -1,18 +1,27 @@
 /**
- * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
  */
 import { BST, BSTNode } from './bst';
 import type { AVLTreeDeleted, BinaryTreeNodeId } from '../types';
 export declare class AVLTreeNode<T> extends BSTNode<T> {
+    /**
+     * The function overrides the clone method of the AVLTreeNode class to create a new AVLTreeNode object with the same
+     * id, value, and count.
+     * @returns The method is returning a new instance of the AVLTreeNode class with the same id, val, and count values as
+     * the current instance.
+     */
     clone(): AVLTreeNode<T>;
 }
 export declare class AVLTree<T> extends BST<T> {
     createNode(id: BinaryTreeNodeId, val: T, count?: number): AVLTreeNode<T>;
     /**
-     * The function overrides the put method of a Binary Search Tree to insert a node with a given id and value, and then
+     * The function overrides the add method of a Binary Search Tree to insert a node with a given id and value, and then
      * balances the tree.
-     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that we want to put or
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that we want to add or
      * update in the AVL tree.
      * @param {T | null} val - The `val` parameter represents the value that you want to assign to the node with the given
      * `id`. It can be of type `T` (the generic type) or `null`.
@@ -21,7 +30,7 @@ export declare class AVLTree<T> extends BST<T> {
      * to `1`, indicating that the value should be inserted once.
      * @returns The method is returning either an AVLTreeNode<T> object or null.
      */
-    put(id: BinaryTreeNodeId, val: T | null, count?: number): AVLTreeNode<T> | null;
+    add(id: BinaryTreeNodeId, val: T | null, count?: number): AVLTreeNode<T> | null;
     /**
      * The function overrides the remove method of the Binary Search Tree class, performs the removal operation, and
      * then balances the tree if necessary.

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

@@ -28,8 +28,11 @@ var __values = (this && this.__values) || function(o) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AVLTree = exports.AVLTreeNode = void 0;
 /**
- * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
  */
 var bst_1 = require("./bst");
 var AVLTreeNode = /** @class */ (function (_super) {
@@ -37,6 +40,12 @@ var AVLTreeNode = /** @class */ (function (_super) {
     function AVLTreeNode() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * The function overrides the clone method of the AVLTreeNode class to create a new AVLTreeNode object with the same
+     * id, value, and count.
+     * @returns The method is returning a new instance of the AVLTreeNode class with the same id, val, and count values as
+     * the current instance.
+     */
     AVLTreeNode.prototype.clone = function () {
         return new AVLTreeNode(this.id, this.val, this.count);
     };
@@ -52,9 +61,9 @@ var AVLTree = /** @class */ (function (_super) {
         return new AVLTreeNode(id, val, count);
     };
     /**
-     * The function overrides the put method of a Binary Search Tree to insert a node with a given id and value, and then
+     * The function overrides the add method of a Binary Search Tree to insert a node with a given id and value, and then
      * balances the tree.
-     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that we want to put or
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier of the binary tree node that we want to add or
      * update in the AVL tree.
      * @param {T | null} val - The `val` parameter represents the value that you want to assign to the node with the given
      * `id`. It can be of type `T` (the generic type) or `null`.
@@ -63,8 +72,8 @@ var AVLTree = /** @class */ (function (_super) {
      * to `1`, indicating that the value should be inserted once.
      * @returns The method is returning either an AVLTreeNode<T> object or null.
      */
-    AVLTree.prototype.put = function (id, val, count) {
-        var inserted = _super.prototype.put.call(this, id, val, count);
+    AVLTree.prototype.add = function (id, val, count) {
+        var inserted = _super.prototype.add.call(this, id, val, count);
         if (inserted)
             this.balancePath(inserted);
         return inserted;

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

@@ -1,9 +1,18 @@
 /**
- * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
  */
 export declare class BinaryIndexedTree {
     private readonly _sumTree;
+    /**
+     * The constructor initializes an array with a specified length and fills it with zeros.
+     * @param {number} n - The parameter `n` represents the size of the array that will be used to store the sum tree. The
+     * sum tree is a binary tree data structure used to efficiently calculate the sum of a range of elements in an array.
+     * The size of the sum tree array is `n + 1` because
+     */
     constructor(n: number);
     static lowBit(x: number): number;
     /**

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

@@ -2,10 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BinaryIndexedTree = void 0;
 /**
- * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
  */
 var BinaryIndexedTree = /** @class */ (function () {
+    /**
+     * The constructor initializes an array with a specified length and fills it with zeros.
+     * @param {number} n - The parameter `n` represents the size of the array that will be used to store the sum tree. The
+     * sum tree is a binary tree data structure used to efficiently calculate the sum of a range of elements in an array.
+     * The size of the sum tree array is `n + 1` because
+     */
     function BinaryIndexedTree(n) {
         this._sumTree = new Array(n + 1).fill(0);
     }