[benchmark] Determine the order of magnitude for most performance tes…

…ts. Report metric reductions.

README.md

@@ -658,37 +658,40 @@ optimal approach to data structure design.
 [//]: # (Start of Replace Section)
 <div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>avl-tree</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000 add randomly</td><td>2.28</td><td>438.38</td><td>23</td><td>0.00</td><td>2.56e-5</td></tr><tr><td>1000 add & delete randomly</td><td>5.16</td><td>193.94</td><td>11</td><td>0.01</td><td>7.96e-4</td></tr><tr><td>1000 addMany</td><td>3.05</td><td>328.30</td><td>17</td><td>0.00</td><td>3.13e-4</td></tr><tr><td>1000 get</td><td>2.08</td><td>480.72</td><td>25</td><td>0.00</td><td>9.01e-5</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>10,000 add randomly</td><td>32.75</td><td>30.53</td><td>9.04e-4</td></tr><tr><td>10,000 add & delete randomly</td><td>69.59</td><td>14.37</td><td>0.00</td></tr><tr><td>10,000 addMany</td><td>42.07</td><td>23.77</td><td>8.58e-4</td></tr><tr><td>10,000 get</td><td>27.87</td><td>35.88</td><td>5.71e-4</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>binary-tree</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000 add randomly</td><td>12.88</td><td>77.65</td><td>5</td><td>0.01</td><td>1.17e-4</td></tr><tr><td>1000 add & delete randomly</td><td>15.95</td><td>62.70</td><td>4</td><td>0.02</td><td>1.78e-4</td></tr><tr><td>1000 addMany</td><td>10.61</td><td>94.25</td><td>5</td><td>0.01</td><td>1.16e-4</td></tr><tr><td>1000 get</td><td>18.02</td><td>55.51</td><td>3</td><td>0.02</td><td>1.59e-4</td></tr><tr><td>1000 dfs</td><td>69.95</td><td>14.30</td><td>1</td><td>0.07</td><td>6.49e-4</td></tr><tr><td>1000 bfs</td><td>54.78</td><td>18.25</td><td>1</td><td>0.05</td><td>4.98e-4</td></tr><tr><td>1000 morris</td><td>37.26</td><td>26.83</td><td>2</td><td>0.04</td><td>2.16e-4</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>1,000 add randomly</td><td>12.84</td><td>77.86</td><td>1.92e-4</td></tr><tr><td>1,000 add & delete randomly</td><td>15.94</td><td>62.72</td><td>3.07e-4</td></tr><tr><td>1,000 addMany</td><td>10.59</td><td>94.45</td><td>1.67e-4</td></tr><tr><td>1,000 get</td><td>17.99</td><td>55.59</td><td>2.35e-4</td></tr><tr><td>1,000 dfs</td><td>70.17</td><td>14.25</td><td>8.83e-4</td></tr><tr><td>1,000 bfs</td><td>54.52</td><td>18.34</td><td>7.43e-4</td></tr><tr><td>1,000 morris</td><td>37.26</td><td>26.84</td><td>5.27e-4</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>bst</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000 add randomly</td><td>2.02</td><td>496.10</td><td>25</td><td>0.00</td><td>1.56e-5</td></tr><tr><td>1000 add & delete randomly</td><td>4.60</td><td>217.31</td><td>12</td><td>0.00</td><td>4.43e-4</td></tr><tr><td>1000 addMany</td><td>2.23</td><td>448.71</td><td>24</td><td>0.00</td><td>2.96e-4</td></tr><tr><td>1000 get</td><td>2.09</td><td>479.52</td><td>25</td><td>0.00</td><td>1.27e-5</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>10,000 add randomly</td><td>33.25</td><td>30.07</td><td>4.20e-4</td></tr><tr><td>10,000 add & delete randomly</td><td>73.76</td><td>13.56</td><td>8.39e-4</td></tr><tr><td>10,000 addMany</td><td>29.96</td><td>33.38</td><td>4.40e-4</td></tr><tr><td>10,000 get</td><td>28.53</td><td>35.05</td><td>3.89e-4</td></tr></table></div>
+    </div><div class="json-to-html-collapse clearfix 0">
+      <div class='collapsible level0' ><span class='json-to-html-label'>rb-tree</span></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>100,000 add randomly</td><td>74.41</td><td>13.44</td><td>0.00</td></tr><tr><td>100,000 add & 1000 delete randomly</td><td>80.63</td><td>12.40</td><td>0.01</td></tr><tr><td>100,000 getNode</td><td>60.00</td><td>16.67</td><td>0.01</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>directed-graph</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000 addVertex</td><td>0.10</td><td>9871.96</td><td>501</td><td>1.01e-4</td><td>7.32e-7</td></tr><tr><td>1000 addEdge</td><td>6.48</td><td>154.29</td><td>9</td><td>0.01</td><td>0.00</td></tr><tr><td>1000 getVertex</td><td>0.05</td><td>2.17e+4</td><td>1110</td><td>4.61e-5</td><td>3.80e-7</td></tr><tr><td>1000 getEdge</td><td>24.65</td><td>40.57</td><td>3</td><td>0.02</td><td>0.01</td></tr><tr><td>tarjan</td><td>208.00</td><td>4.81</td><td>1</td><td>0.21</td><td>0.01</td></tr><tr><td>tarjan all</td><td>212.97</td><td>4.70</td><td>1</td><td>0.21</td><td>0.00</td></tr><tr><td>topologicalSort</td><td>171.49</td><td>5.83</td><td>1</td><td>0.17</td><td>0.01</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>1,000 addVertex</td><td>0.10</td><td>9856.40</td><td>1.79e-6</td></tr><tr><td>1,000 addEdge</td><td>6.21</td><td>160.96</td><td>8.40e-4</td></tr><tr><td>1,000 getVertex</td><td>0.05</td><td>2.16e+4</td><td>3.85e-7</td></tr><tr><td>1,000 getEdge</td><td>22.43</td><td>44.57</td><td>0.00</td></tr><tr><td>tarjan</td><td>219.40</td><td>4.56</td><td>0.03</td></tr><tr><td>tarjan all</td><td>214.21</td><td>4.67</td><td>0.00</td></tr><tr><td>topologicalSort</td><td>172.46</td><td>5.80</td><td>0.00</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>heap</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000 add & pop</td><td>0.34</td><td>2929.81</td><td>149</td><td>3.41e-4</td><td>2.37e-6</td></tr><tr><td>1000 fib add & pop</td><td>3.89</td><td>257.31</td><td>14</td><td>0.00</td><td>2.53e-5</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>10,000 add & pop</td><td>4.63</td><td>215.75</td><td>4.05e-5</td></tr><tr><td>10,000 fib add & pop</td><td>355.10</td><td>2.82</td><td>0.00</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>doubly-linked-list</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000000 unshift</td><td>212.40</td><td>4.71</td><td>1</td><td>0.21</td><td>0.02</td></tr><tr><td>1000000 unshift & shift</td><td>172.94</td><td>5.78</td><td>1</td><td>0.17</td><td>0.03</td></tr><tr><td>1000 insertBefore</td><td>0.03</td><td>3.70e+4</td><td>1903</td><td>2.71e-5</td><td>2.38e-6</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>1,000,000 unshift</td><td>210.62</td><td>4.75</td><td>0.05</td></tr><tr><td>1,000,000 unshift & shift</td><td>176.63</td><td>5.66</td><td>0.04</td></tr><tr><td>1,000,000 insertBefore</td><td>288.55</td><td>3.47</td><td>0.05</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>singly-linked-list</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000 push & pop</td><td>1.75</td><td>571.73</td><td>30</td><td>0.00</td><td>5.06e-5</td></tr><tr><td>1000 insertBefore</td><td>2.30</td><td>434.82</td><td>22</td><td>0.00</td><td>5.10e-5</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>10,000 push & pop</td><td>232.24</td><td>4.31</td><td>0.03</td></tr><tr><td>10,000 insertBefore</td><td>245.58</td><td>4.07</td><td>0.00</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>max-priority-queue</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>10000 refill & poll</td><td>11.41</td><td>87.65</td><td>5</td><td>0.01</td><td>1.49e-4</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>10,000 refill & poll</td><td>11.62</td><td>86.09</td><td>2.24e-4</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>deque</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000000 push</td><td>212.51</td><td>4.71</td><td>1</td><td>0.21</td><td>0.06</td></tr><tr><td>1000000 shift</td><td>24.98</td><td>40.04</td><td>3</td><td>0.02</td><td>0.00</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>1,000,000 push</td><td>223.78</td><td>4.47</td><td>0.05</td></tr><tr><td>1,000,000 shift</td><td>25.79</td><td>38.78</td><td>0.00</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>queue</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>1000000 push</td><td>41.97</td><td>23.83</td><td>2</td><td>0.04</td><td>0.01</td></tr><tr><td>1000000 push & shift</td><td>79.08</td><td>12.65</td><td>1</td><td>0.08</td><td>0.00</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>1,000,000 push</td><td>44.27</td><td>22.59</td><td>0.01</td></tr><tr><td>1,000,000 push & shift</td><td>79.63</td><td>12.56</td><td>0.00</td></tr></table></div>
     </div><div class="json-to-html-collapse clearfix 0">
       <div class='collapsible level0' ><span class='json-to-html-label'>trie</span></div>
-      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>executed times</th><th>sample mean (secs)</th><th>sample deviation</th></tr><tr><td>100000 push</td><td>54.24</td><td>18.44</td><td>1</td><td>0.05</td><td>7.00e-4</td></tr><tr><td>100000 getWords</td><td>96.12</td><td>10.40</td><td>1</td><td>0.10</td><td>0.00</td></tr></table></div>
+      <div class="content"><table><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>100,000 push</td><td>49.29</td><td>20.29</td><td>0.00</td></tr><tr><td>100,000 getWords</td><td>95.55</td><td>10.47</td><td>0.01</td></tr></table></div>
     </div>
 
 [//]: # (End of Replace Section)

src/data-structures/binary-tree/binary-tree.ts

@@ -142,7 +142,7 @@ export class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = BinaryTreeNode
   }
 
   protected defaultOneParamCallback = (node: N) => node.key;
-  
+
   /**
    * Creates a new instance of BinaryTreeNode with the given key and value.
    * @param {BTNKey} key - The key for the new node.

src/data-structures/binary-tree/bst.ts

@@ -36,7 +36,7 @@ export class BST<V = any, N extends BSTNode<V, N> = BSTNode<V, BSTNodeNested<V>>
       }
     }
   }
-  
+
   /**
    * The function creates a new binary search tree node with the given key and value.
    * @param {BTNKey} key - The key parameter is the key value that will be associated with

src/data-structures/binary-tree/rb-tree.ts

@@ -44,14 +44,20 @@ export class RedBlackTree {
     return this._root;
   }
 
+  protected _size: number = 0;
+
+  get size(): number {
+    return this._size;
+  }
+
   /**
    * The `insert` function inserts a new node with a given key into a red-black tree and fixes any
    * violations of the red-black tree properties.
    * @param {number} key - The key parameter is a number that represents the value to be inserted into
    * the RBTree.
    * @returns The function does not explicitly return anything.
    */
-  insert(key: number): void {
+  add(key: number): void {
     const node: RBTreeNode = new RBTreeNode(key, RBTNColor.RED);
     node.left = NIL;
     node.right = NIL;
@@ -79,20 +85,23 @@ export class RedBlackTree {
 
     if (node.parent === null) {
       node.color = RBTNColor.BLACK;
+      this._size++;
       return;
     }
 
     if (node.parent.parent === null) {
+      this._size++;
       return;
     }
 
     this._fixInsert(node);
+    this._size++;
   }
 
   /**
    * The `delete` function in TypeScript is used to remove a node with a specific key from a red-black
    * tree.
-   * @param {RBTreeNode} node - The `node` parameter is of type `RBTreeNode` and represents the current
+   * @param {number} key - The `node` parameter is of type `RBTreeNode` and represents the current
    * node being processed in the delete operation.
    * @returns The `delete` function does not return anything. It has a return type of `void`.
    */
@@ -113,6 +122,7 @@ export class RedBlackTree {
       }
 
       if (z === NIL) {
+        this._size--;
         return;
       }
 
@@ -144,6 +154,7 @@ export class RedBlackTree {
       if (yOriginalColor === RBTNColor.BLACK) {
         this._fixDelete(x);
       }
+      this._size--;
     };
     helper(this.root);
   }
@@ -241,6 +252,11 @@ export class RedBlackTree {
     return y;
   }
 
+  clear() {
+    this._root = NIL;
+    this._size = 0;
+  }
+
   print(beginRoot: RBTreeNode = this.root) {
     const display = (root: RBTreeNode | null): void => {
       const [lines, , ,] = _displayAux(root);

test/performance/data-structures/binary-tree/avl-tree.test.ts

@@ -4,17 +4,17 @@ import {getRandomIntArray, magnitude} from '../../../utils';
 
 const suite = new Benchmark.Suite();
 const avl = new AVLTree<number>();
-const {N_LOG_N} = magnitude;
-const arr = getRandomIntArray(N_LOG_N, 0, N_LOG_N, true);
+const {TEN_THOUSAND} = magnitude;
+const arr = getRandomIntArray(TEN_THOUSAND, 0, TEN_THOUSAND, true);
 
 suite
-  .add(`${N_LOG_N} add randomly`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} add randomly`, () => {
     avl.clear();
     for (let i = 0; i < arr.length; i++) {
       avl.add(arr[i]);
     }
   })
-  .add(`${N_LOG_N} add & delete randomly`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} add & delete randomly`, () => {
     avl.clear();
     for (let i = 0; i < arr.length; i++) {
       avl.add(arr[i]);
@@ -23,11 +23,11 @@ suite
       avl.delete(arr[i]);
     }
   })
-  .add(`${N_LOG_N} addMany`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} addMany`, () => {
     avl.clear();
     avl.addMany(arr);
   })
-  .add(`${N_LOG_N} get`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} get`, () => {
     for (let i = 0; i < arr.length; i++) {
       avl.get(arr[i]);
     }

test/performance/data-structures/binary-tree/binary-tree.test.ts

@@ -8,13 +8,13 @@ const {N_LOG_N} = magnitude;
 const arr = getRandomIntArray(N_LOG_N, 0, N_LOG_N, true);
 
 suite
-  .add(`${N_LOG_N} add randomly`, () => {
+  .add(`${N_LOG_N.toLocaleString()} add randomly`, () => {
     biTree.clear();
     for (let i = 0; i < arr.length; i++) {
       biTree.add(arr[i]);
     }
   })
-  .add(`${N_LOG_N} add & delete randomly`, () => {
+  .add(`${N_LOG_N.toLocaleString()} add & delete randomly`, () => {
     biTree.clear();
     for (let i = 0; i < arr.length; i++) {
       biTree.add(arr[i]);
@@ -23,22 +23,22 @@ suite
       biTree.delete(arr[i]);
     }
   })
-  .add(`${N_LOG_N} addMany`, () => {
+  .add(`${N_LOG_N.toLocaleString()} addMany`, () => {
     biTree.clear();
     biTree.addMany(arr);
   })
-  .add(`${N_LOG_N} get`, () => {
+  .add(`${N_LOG_N.toLocaleString()} get`, () => {
     for (let i = 0; i < arr.length; i++) {
       biTree.get(arr[i]);
     }
   })
-  .add(`${N_LOG_N} dfs`, () => {
+  .add(`${N_LOG_N.toLocaleString()} dfs`, () => {
     for (let i = 0; i < N_LOG_N; i++) biTree.dfs();
   })
-  .add(`${N_LOG_N} bfs`, () => {
+  .add(`${N_LOG_N.toLocaleString()} bfs`, () => {
     for (let i = 0; i < N_LOG_N; i++) biTree.bfs();
   })
-  .add(`${N_LOG_N} morris`, () => {
+  .add(`${N_LOG_N.toLocaleString()} morris`, () => {
     for (let i = 0; i < N_LOG_N; i++) biTree.morris(n => n, 'pre');
   });
 

test/performance/data-structures/binary-tree/bst.test.ts

@@ -4,17 +4,17 @@ import {getRandomIntArray, magnitude} from '../../../utils';
 
 const suite = new Benchmark.Suite();
 const bst = new BST<number>();
-const {N_LOG_N} = magnitude;
-const arr = getRandomIntArray(N_LOG_N, 0, N_LOG_N, true);
+const {TEN_THOUSAND} = magnitude;
+const arr = getRandomIntArray(TEN_THOUSAND, 0, TEN_THOUSAND, true);
 
 suite
-  .add(`${N_LOG_N} add randomly`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} add randomly`, () => {
     bst.clear();
     for (let i = 0; i < arr.length; i++) {
       bst.add(arr[i]);
     }
   })
-  .add(`${N_LOG_N} add & delete randomly`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} add & delete randomly`, () => {
     bst.clear();
     for (let i = 0; i < arr.length; i++) {
       bst.add(arr[i]);
@@ -23,11 +23,11 @@ suite
       bst.delete(arr[i]);
     }
   })
-  .add(`${N_LOG_N} addMany`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} addMany`, () => {
     bst.clear();
     bst.addMany(arr);
   })
-  .add(`${N_LOG_N} get`, () => {
+  .add(`${TEN_THOUSAND.toLocaleString()} get`, () => {
     for (let i = 0; i < arr.length; i++) {
       bst.get(arr[i]);
     }

test/performance/data-structures/binary-tree/rb-tree.test.ts

@@ -0,0 +1,32 @@
+import {RedBlackTree} from '../../../../src';
+import * as Benchmark from 'benchmark';
+import {getRandomIntArray, magnitude} from '../../../utils';
+
+const suite = new Benchmark.Suite();
+const rbTree = new RedBlackTree();
+const {HUNDRED_THOUSAND} = magnitude;
+const arr = getRandomIntArray(HUNDRED_THOUSAND, 0, HUNDRED_THOUSAND, true);
+
+suite
+  .add(`${HUNDRED_THOUSAND.toLocaleString()} add randomly`, () => {
+    rbTree.clear();
+    for (let i = 0; i < arr.length; i++) {
+      rbTree.add(arr[i]);
+    }
+  })
+  .add(`${HUNDRED_THOUSAND.toLocaleString()} add & 1000 delete randomly`, () => {
+    rbTree.clear();
+    for (let i = 0; i < arr.length; i++) {
+      rbTree.add(arr[i]);
+    }
+    for (let i = 0; i < 1000; i++) {
+      rbTree.delete(arr[i]);
+    }
+  })
+  .add(`${HUNDRED_THOUSAND.toLocaleString()} getNode`, () => {
+    for (let i = 0; i < arr.length; i++) {
+      rbTree.getNode(arr[i]);
+    }
+  });
+
+export {suite};