data-structure-typed 1.41.8 → 1.42.0

package/benchmark/report.json

@@ -3,27 +3,27 @@
     "benchmarks": [
       {
         "test name": "10,000 add randomly",
-        "time taken (ms)": "30.29",
-        "executions per sec": "33.01",
-        "sample deviation": "3.64e-4"
+        "time taken (ms)": "34.10",
+        "executions per sec": "29.32",
+        "sample deviation": "0.00"
       },
       {
         "test name": "10,000 add & delete randomly",
-        "time taken (ms)": "68.10",
-        "executions per sec": "14.68",
+        "time taken (ms)": "74.44",
+        "executions per sec": "13.43",
         "sample deviation": "0.00"
       },
       {
         "test name": "10,000 addMany",
-        "time taken (ms)": "39.54",
-        "executions per sec": "25.29",
-        "sample deviation": "4.07e-4"
+        "time taken (ms)": "44.65",
+        "executions per sec": "22.39",
+        "sample deviation": "0.00"
       },
       {
         "test name": "10,000 get",
-        "time taken (ms)": "26.72",
-        "executions per sec": "37.42",
-        "sample deviation": "3.77e-4"
+        "time taken (ms)": "30.76",
+        "executions per sec": "32.51",
+        "sample deviation": "0.00"
       }
     ],
     "testName": "avl-tree"
@@ -32,45 +32,45 @@
     "benchmarks": [
       {
         "test name": "1,000 add randomly",
-        "time taken (ms)": "12.88",
-        "executions per sec": "77.63",
-        "sample deviation": "1.02e-4"
+        "time taken (ms)": "13.23",
+        "executions per sec": "75.58",
+        "sample deviation": "2.94e-4"
       },
       {
         "test name": "1,000 add & delete randomly",
-        "time taken (ms)": "15.90",
-        "executions per sec": "62.88",
-        "sample deviation": "1.08e-4"
+        "time taken (ms)": "16.29",
+        "executions per sec": "61.38",
+        "sample deviation": "7.50e-4"
       },
       {
         "test name": "1,000 addMany",
-        "time taken (ms)": "10.59",
-        "executions per sec": "94.41",
-        "sample deviation": "8.39e-5"
+        "time taken (ms)": "10.58",
+        "executions per sec": "94.51",
+        "sample deviation": "1.17e-4"
       },
       {
         "test name": "1,000 get",
-        "time taken (ms)": "18.01",
-        "executions per sec": "55.53",
-        "sample deviation": "1.95e-4"
+        "time taken (ms)": "18.09",
+        "executions per sec": "55.28",
+        "sample deviation": "3.74e-4"
       },
       {
         "test name": "1,000 dfs",
-        "time taken (ms)": "69.11",
-        "executions per sec": "14.47",
-        "sample deviation": "6.47e-4"
+        "time taken (ms)": "71.97",
+        "executions per sec": "13.89",
+        "sample deviation": "0.00"
       },
       {
         "test name": "1,000 bfs",
-        "time taken (ms)": "54.42",
-        "executions per sec": "18.38",
-        "sample deviation": "4.20e-4"
+        "time taken (ms)": "57.49",
+        "executions per sec": "17.39",
+        "sample deviation": "5.01e-4"
       },
       {
         "test name": "1,000 morris",
-        "time taken (ms)": "37.14",
-        "executions per sec": "26.92",
-        "sample deviation": "2.27e-4"
+        "time taken (ms)": "37.35",
+        "executions per sec": "26.78",
+        "sample deviation": "2.94e-4"
       }
     ],
     "testName": "binary-tree"
@@ -79,27 +79,27 @@
     "benchmarks": [
       {
         "test name": "10,000 add randomly",
-        "time taken (ms)": "28.48",
-        "executions per sec": "35.11",
-        "sample deviation": "2.29e-4"
+        "time taken (ms)": "33.54",
+        "executions per sec": "29.81",
+        "sample deviation": "3.61e-4"
       },
       {
         "test name": "10,000 add & delete randomly",
-        "time taken (ms)": "64.82",
-        "executions per sec": "15.43",
-        "sample deviation": "0.01"
+        "time taken (ms)": "75.05",
+        "executions per sec": "13.33",
+        "sample deviation": "0.00"
       },
       {
         "test name": "10,000 addMany",
-        "time taken (ms)": "28.74",
-        "executions per sec": "34.80",
-        "sample deviation": "9.06e-4"
+        "time taken (ms)": "31.50",
+        "executions per sec": "31.74",
+        "sample deviation": "4.90e-4"
       },
       {
         "test name": "10,000 get",
-        "time taken (ms)": "27.38",
-        "executions per sec": "36.52",
-        "sample deviation": "1.82e-4"
+        "time taken (ms)": "34.92",
+        "executions per sec": "28.64",
+        "sample deviation": "0.01"
       }
     ],
     "testName": "bst"
@@ -108,21 +108,21 @@
     "benchmarks": [
       {
         "test name": "100,000 add randomly",
-        "time taken (ms)": "72.30",
-        "executions per sec": "13.83",
-        "sample deviation": "0.00"
+        "time taken (ms)": "80.61",
+        "executions per sec": "12.41",
+        "sample deviation": "0.01"
       },
       {
         "test name": "100,000 add & 1000 delete randomly",
-        "time taken (ms)": "81.37",
-        "executions per sec": "12.29",
+        "time taken (ms)": "86.72",
+        "executions per sec": "11.53",
         "sample deviation": "0.01"
       },
       {
         "test name": "100,000 getNode",
-        "time taken (ms)": "59.48",
-        "executions per sec": "16.81",
-        "sample deviation": "9.29e-4"
+        "time taken (ms)": "75.09",
+        "executions per sec": "13.32",
+        "sample deviation": "0.03"
       }
     ],
     "testName": "rb-tree"
@@ -131,45 +131,45 @@
     "benchmarks": [
       {
         "test name": "1,000 addVertex",
-        "time taken (ms)": "0.10",
-        "executions per sec": "9786.77",
-        "sample deviation": "5.56e-7"
+        "time taken (ms)": "0.12",
+        "executions per sec": "8506.54",
+        "sample deviation": "3.38e-5"
       },
       {
         "test name": "1,000 addEdge",
-        "time taken (ms)": "6.02",
-        "executions per sec": "166.04",
-        "sample deviation": "1.27e-4"
+        "time taken (ms)": "6.96",
+        "executions per sec": "143.61",
+        "sample deviation": "0.00"
       },
       {
         "test name": "1,000 getVertex",
         "time taken (ms)": "0.05",
-        "executions per sec": "2.18e+4",
-        "sample deviation": "3.02e-7"
+        "executions per sec": "1.85e+4",
+        "sample deviation": "2.60e-5"
       },
       {
         "test name": "1,000 getEdge",
-        "time taken (ms)": "23.41",
-        "executions per sec": "42.71",
-        "sample deviation": "0.00"
+        "time taken (ms)": "23.99",
+        "executions per sec": "41.69",
+        "sample deviation": "0.01"
       },
       {
         "test name": "tarjan",
-        "time taken (ms)": "223.51",
-        "executions per sec": "4.47",
-        "sample deviation": "0.01"
+        "time taken (ms)": "205.07",
+        "executions per sec": "4.88",
+        "sample deviation": "0.04"
       },
       {
         "test name": "tarjan all",
-        "time taken (ms)": "224.89",
-        "executions per sec": "4.45",
-        "sample deviation": "0.00"
+        "time taken (ms)": "211.45",
+        "executions per sec": "4.73",
+        "sample deviation": "0.04"
       },
       {
         "test name": "topologicalSort",
-        "time taken (ms)": "181.90",
-        "executions per sec": "5.50",
-        "sample deviation": "0.00"
+        "time taken (ms)": "186.95",
+        "executions per sec": "5.35",
+        "sample deviation": "0.06"
       }
     ],
     "testName": "directed-graph"
@@ -178,15 +178,15 @@
     "benchmarks": [
       {
         "test name": "10,000 add & pop",
-        "time taken (ms)": "4.62",
-        "executions per sec": "216.33",
-        "sample deviation": "3.06e-5"
+        "time taken (ms)": "5.03",
+        "executions per sec": "198.77",
+        "sample deviation": "0.00"
       },
       {
         "test name": "10,000 fib add & pop",
-        "time taken (ms)": "351.41",
-        "executions per sec": "2.85",
-        "sample deviation": "0.00"
+        "time taken (ms)": "373.81",
+        "executions per sec": "2.68",
+        "sample deviation": "0.03"
       }
     ],
     "testName": "heap"
@@ -195,21 +195,21 @@
     "benchmarks": [
       {
         "test name": "1,000,000 unshift",
-        "time taken (ms)": "214.84",
-        "executions per sec": "4.65",
-        "sample deviation": "0.04"
+        "time taken (ms)": "231.55",
+        "executions per sec": "4.32",
+        "sample deviation": "0.03"
       },
       {
         "test name": "1,000,000 unshift & shift",
-        "time taken (ms)": "167.11",
-        "executions per sec": "5.98",
-        "sample deviation": "0.04"
+        "time taken (ms)": "163.44",
+        "executions per sec": "6.12",
+        "sample deviation": "0.01"
       },
       {
         "test name": "1,000,000 insertBefore",
-        "time taken (ms)": "335.78",
-        "executions per sec": "2.98",
-        "sample deviation": "0.07"
+        "time taken (ms)": "301.21",
+        "executions per sec": "3.32",
+        "sample deviation": "0.03"
       }
     ],
     "testName": "doubly-linked-list"
@@ -218,15 +218,15 @@
     "benchmarks": [
       {
         "test name": "10,000 push & pop",
-        "time taken (ms)": "212.53",
-        "executions per sec": "4.71",
+        "time taken (ms)": "216.27",
+        "executions per sec": "4.62",
         "sample deviation": "0.01"
       },
       {
         "test name": "10,000 insertBefore",
-        "time taken (ms)": "243.94",
-        "executions per sec": "4.10",
-        "sample deviation": "0.00"
+        "time taken (ms)": "252.18",
+        "executions per sec": "3.97",
+        "sample deviation": "0.01"
       }
     ],
     "testName": "singly-linked-list"
@@ -235,9 +235,9 @@
     "benchmarks": [
       {
         "test name": "10,000 refill & poll",
-        "time taken (ms)": "11.43",
-        "executions per sec": "87.50",
-        "sample deviation": "1.84e-4"
+        "time taken (ms)": "11.56",
+        "executions per sec": "86.52",
+        "sample deviation": "2.35e-4"
       }
     ],
     "testName": "max-priority-queue"
@@ -246,14 +246,14 @@
     "benchmarks": [
       {
         "test name": "1,000,000 push",
-        "time taken (ms)": "216.07",
-        "executions per sec": "4.63",
+        "time taken (ms)": "222.98",
+        "executions per sec": "4.48",
         "sample deviation": "0.05"
       },
       {
         "test name": "1,000,000 shift",
-        "time taken (ms)": "24.97",
-        "executions per sec": "40.05",
+        "time taken (ms)": "26.01",
+        "executions per sec": "38.44",
         "sample deviation": "0.00"
       }
     ],
@@ -263,15 +263,15 @@
     "benchmarks": [
       {
         "test name": "1,000,000 push",
-        "time taken (ms)": "42.57",
-        "executions per sec": "23.49",
+        "time taken (ms)": "44.93",
+        "executions per sec": "22.26",
         "sample deviation": "0.01"
       },
       {
         "test name": "1,000,000 push & shift",
-        "time taken (ms)": "79.94",
-        "executions per sec": "12.51",
-        "sample deviation": "9.99e-4"
+        "time taken (ms)": "80.87",
+        "executions per sec": "12.37",
+        "sample deviation": "0.00"
       }
     ],
     "testName": "queue"
@@ -280,15 +280,15 @@
     "benchmarks": [
       {
         "test name": "100,000 push",
-        "time taken (ms)": "54.02",
-        "executions per sec": "18.51",
-        "sample deviation": "0.00"
+        "time taken (ms)": "57.22",
+        "executions per sec": "17.48",
+        "sample deviation": "0.01"
       },
       {
         "test name": "100,000 getWords",
-        "time taken (ms)": "82.83",
-        "executions per sec": "12.07",
-        "sample deviation": "0.00"
+        "time taken (ms)": "99.32",
+        "executions per sec": "10.07",
+        "sample deviation": "0.01"
       }
     ],
     "testName": "trie"

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

@@ -238,67 +238,18 @@ export declare class BinaryTree<V = any, N extends BinaryTreeNode<V, N> = Binary
      * @returns a boolean value.
      */
     isBST(iterationType?: IterationType): boolean;
-    /**
-     * The function `subTreeTraverse` traverses a binary tree and applies a callback function to each
-     * node, either recursively or iteratively.
-     * @param callback - The `callback` parameter is a function that will be called on each node in the
-     * subtree traversal. It takes a single argument, which is the current node being traversed, and
-     * returns a value. The return values from each callback invocation will be collected and returned as
-     * an array.
-     * @param {BTNKey | N | null} beginRoot - The `beginRoot` parameter is the starting point
-     * for traversing the subtree. It can be either a node object, a key value of a node, or `null` to
-     * start from the root of the tree.
-     * @param iterationType - The `iterationType` parameter determines the type of traversal to be
-     * performed on the binary tree. It can have two possible values:
-     * @returns The function `subTreeTraverse` returns an array of `ReturnType<BTNCallback<N>>`.
-     */
-    subTreeTraverse<C extends BTNCallback<N>>(callback?: C, beginRoot?: BTNKey | N | null, iterationType?: IterationType): ReturnType<C>[];
-    /**
-     * The `dfs` function performs a depth-first search traversal on a binary tree, executing a callback
-     * function on each node according to a specified order pattern.
-     * @param callback - The `callback` parameter is a function that will be called on each node during
-     * the depth-first search traversal. It takes a node as input and returns a value. The default value
-     * is `this.defaultOneParamCallback`, which is a callback function defined elsewhere in the code.
-     * @param {DFSOrderPattern} [pattern=in] - The `pattern` parameter determines the order in which the
-     * nodes are visited during the depth-first search. There are three possible values for `pattern`:
-     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the depth-first
-     * search. It determines where the search will begin in the tree or graph structure. If `beginRoot`
-     * is `null`, an empty array will be returned.
-     * @param {IterationType} iterationType - The `iterationType` parameter determines the type of
-     * iteration used in the depth-first search algorithm. It can have two possible values:
-     * @returns The function `dfs` returns an array of `ReturnType<BTNCallback<N>>` values.
-     */
-    dfs<C extends BTNCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
-    /**
-     * The bfs function performs a breadth-first search traversal on a binary tree, executing a callback
-     * function on each node.
-     * @param callback - The `callback` parameter is a function that will be called for each node in the
-     * breadth-first search. It takes a node of type `N` as its argument and returns a value of type
-     * `ReturnType<BTNCallback<N>>`. The default value for this parameter is `this.defaultOneParamCallback
-     * @param {N | null} beginRoot - The `beginRoot` parameter is the starting node for the breadth-first
-     * search. It determines from which node the search will begin. If `beginRoot` is `null`, the search
-     * will not be performed and an empty array will be returned.
-     * @param iterationType - The `iterationType` parameter determines the type of iteration to be used
-     * in the breadth-first search (BFS) algorithm. It can have two possible values:
-     * @returns The function `bfs` returns an array of `ReturnType<BTNCallback<N>>[]`.
-     */
-    bfs<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[];
-    /**
-     * The `listLevels` function takes a binary tree node and a callback function, and returns an array
-     * of arrays representing the levels of the tree.
-     * @param {C} callback - The `callback` parameter is a function that will be called on each node in
-     * the tree. It takes a node as input and returns a value. The return type of the callback function
-     * is determined by the generic type `C`.
-     * @param {N | null} beginRoot - The `beginRoot` parameter represents the starting node of the binary tree
-     * traversal. It can be any node in the binary tree. If no node is provided, the traversal will start
-     * from the root node of the binary tree.
-     * @param iterationType - The `iterationType` parameter determines whether the tree traversal is done
-     * recursively or iteratively. It can have two possible values:
-     * @returns The function `listLevels` returns an array of arrays, where each inner array represents a
-     * level in a binary tree. Each inner array contains the return type of the provided callback
-     * function `C` applied to the nodes at that level.
-     */
-    listLevels<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType): ReturnType<C>[][];
+    subTreeTraverse<C extends BTNCallback<N>>(callback?: C, beginRoot?: BTNKey | N | null, iterationType?: IterationType, includeNull?: false): ReturnType<C>[];
+    subTreeTraverse<C extends BTNCallback<N>>(callback?: C, beginRoot?: BTNKey | N | null, iterationType?: IterationType, includeNull?: undefined): ReturnType<C>[];
+    subTreeTraverse<C extends BTNCallback<N | null>>(callback?: C, beginRoot?: BTNKey | N | null, iterationType?: IterationType, includeNull?: true): ReturnType<C>[];
+    dfs<C extends BTNCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType, includeNull?: false): ReturnType<C>[];
+    dfs<C extends BTNCallback<N>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType, includeNull?: undefined): ReturnType<C>[];
+    dfs<C extends BTNCallback<N | null>>(callback?: C, pattern?: DFSOrderPattern, beginRoot?: N | null, iterationType?: IterationType, includeNull?: true): ReturnType<C>[];
+    bfs<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType, includeNull?: false): ReturnType<C>[];
+    bfs<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType, includeNull?: undefined): ReturnType<C>[];
+    bfs<C extends BTNCallback<N | null>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType, includeNull?: true): ReturnType<C>[];
+    listLevels<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType, includeNull?: false): ReturnType<C>[][];
+    listLevels<C extends BTNCallback<N>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType, includeNull?: undefined): ReturnType<C>[][];
+    listLevels<C extends BTNCallback<N | null>>(callback?: C, beginRoot?: N | null, iterationType?: IterationType, includeNull?: true): ReturnType<C>[][];
     /**
      * The function returns the predecessor node of a given node in a binary tree.
      * @param {N} node - The parameter "node" represents a node in a binary tree.