data-structure-typed 1.46.7 → 1.46.8

package/CHANGELOG.md

@@ -8,7 +8,7 @@ All notable changes to this project will be documented in this file.
 - [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 - [`auto-changelog`](https://github.com/CookPete/auto-changelog)
 
-## [v1.46.7](https://github.com/zrwusa/data-structure-typed/compare/v1.35.0...main) (upcoming)
+## [v1.46.8](https://github.com/zrwusa/data-structure-typed/compare/v1.35.0...main) (upcoming)
 
 ### Changes
 

package/README.md

@@ -11,7 +11,7 @@
 
 Data Structures of Javascript & TypeScript.
 
-Do you envy C++ with [STL](), Python with [collections](), and Java with [java.util]() ? Well, no need to envy anymore! JavaScript and TypeScript now have [data-structure-typed]().
+Do you envy C++ with [STL]() (std::), Python with [collections](), and Java with [java.util]() ? Well, no need to envy anymore! JavaScript and TypeScript now have [data-structure-typed]().
 
 Now you can use this library in Node.js and browser environments in CommonJS(require export.modules = ), ESModule(import export), Typescript(import export), UMD(var Queue = dataStructureTyped.Queue)
 
@@ -24,7 +24,6 @@ Now you can use this library in Node.js and browser environments in CommonJS(req
 
 [//]: # (![Lines](https://img.shields.io/badge/lines-68.6%25-red.svg?style=flat))
 
-
 ## Installation and Usage
 
 ### npm
@@ -117,8 +116,6 @@ const {
 
 ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/map-graph-test.webp)
 
-
-
 ## Code Snippets
 
 ### Binary Search Tree (BST) snippet
@@ -275,107 +272,6 @@ const dijkstraResult = graph.dijkstra('A');
 Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.key) // ['A', 'B', 'D']
 ```
 
-## Built-in classic algorithms
-
-<table>
-  <thead>
-  <tr>
-    <th>Algorithm</th>
-    <th>Function Description</th>
-    <th>Iteration Type</th>
-  </tr>
-  </thead>
-  <tbody>
-  <tr>
-    <td>Binary Tree DFS</td>
-    <td>Traverse a binary tree in a depth-first manner, starting from the root node, first visiting the left subtree,
-      and then the right subtree, using recursion.
-    </td>
-    <td>Recursion + Iteration</td>
-  </tr>
-  <tr>
-    <td>Binary Tree BFS</td>
-    <td>Traverse a binary tree in a breadth-first manner, starting from the root node, visiting nodes level by level
-      from left to right.
-    </td>
-    <td>Iteration</td>
-  </tr>
-  <tr>
-    <td>Graph DFS</td>
-    <td>Traverse a graph in a depth-first manner, starting from a given node, exploring along one path as deeply as
-      possible, and backtracking to explore other paths. Used for finding connected components, paths, etc.
-    </td>
-    <td>Recursion + Iteration</td>
-  </tr>
-  <tr>
-    <td>Binary Tree Morris</td>
-    <td>Morris traversal is an in-order traversal algorithm for binary trees with O(1) space complexity. It allows tree
-      traversal without additional stack or recursion.
-    </td>
-    <td>Iteration</td>
-  </tr>
-  <tr>
-    <td>Graph BFS</td>
-    <td>Traverse a graph in a breadth-first manner, starting from a given node, first visiting nodes directly connected
-      to the starting node, and then expanding level by level. Used for finding shortest paths, etc.
-    </td>
-    <td>Recursion + Iteration</td>
-  </tr>
-  <tr>
-    <td>Graph Tarjan's Algorithm</td>
-    <td>Find strongly connected components in a graph, typically implemented using depth-first search.</td>
-    <td>Recursion</td>
-  </tr>
-  <tr>
-    <td>Graph Bellman-Ford Algorithm</td>
-    <td>Finding the shortest paths from a single source, can handle negative weight edges</td>
-    <td>Iteration</td>
-  </tr>
-  <tr>
-    <td>Graph Dijkstra's Algorithm</td>
-    <td>Finding the shortest paths from a single source, cannot handle negative weight edges</td>
-    <td>Iteration</td>
-  </tr>
-  <tr>
-    <td>Graph Floyd-Warshall Algorithm</td>
-    <td>Finding the shortest paths between all pairs of nodes</td>
-    <td>Iteration</td>
-  </tr>
-  <tr>
-    <td>Graph getCycles</td>
-    <td>Find all cycles in a graph or detect the presence of cycles.</td>
-    <td>Recursion</td>
-  </tr>
-  <tr>
-    <td>Graph getCutVertexes</td>
-    <td>Find cut vertices in a graph, which are nodes that, when removed, increase the number of connected components in
-      the graph.
-    </td>
-    <td>Recursion</td>
-  </tr>
-  <tr>
-    <td>Graph getSCCs</td>
-    <td>Find strongly connected components in a graph, which are subgraphs where any two nodes can reach each other.
-    </td>
-    <td>Recursion</td>
-  </tr>
-  <tr>
-    <td>Graph getBridges</td>
-    <td>Find bridges in a graph, which are edges that, when removed, increase the number of connected components in the
-      graph.
-    </td>
-    <td>Recursion</td>
-  </tr>
-  <tr>
-    <td>Graph topologicalSort</td>
-    <td>Perform topological sorting on a directed acyclic graph (DAG) to find a linear order of nodes such that all
-      directed edges go from earlier nodes to later nodes.
-    </td>
-    <td>Recursion</td>
-  </tr>
-  </tbody>
-</table>
-
 ## API docs & Examples
 
 [API Docs](https://data-structure-typed-docs.vercel.app)
@@ -568,11 +464,8 @@ Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.key) // ['A', 'B', '
 </tbody>
 </table>
 
-
-
 ## Standard library data structure comparison
 
-
 <table>
   <thead>
   <tr>
@@ -754,7 +647,6 @@ Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.key) // ['A', 'B', '
   </tbody>
 </table>
 
-
 ## Benchmark
 
 [//]: # (No deletion!!! Start of Replace Section)
@@ -810,6 +702,106 @@ Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.key) // ['A', 'B', '
 
 [//]: # (No deletion!!! End of Replace Section)
 
+## Built-in classic algorithms
+
+<table>
+  <thead>
+  <tr>
+    <th>Algorithm</th>
+    <th>Function Description</th>
+    <th>Iteration Type</th>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td>Binary Tree DFS</td>
+    <td>Traverse a binary tree in a depth-first manner, starting from the root node, first visiting the left subtree,
+      and then the right subtree, using recursion.
+    </td>
+    <td>Recursion + Iteration</td>
+  </tr>
+  <tr>
+    <td>Binary Tree BFS</td>
+    <td>Traverse a binary tree in a breadth-first manner, starting from the root node, visiting nodes level by level
+      from left to right.
+    </td>
+    <td>Iteration</td>
+  </tr>
+  <tr>
+    <td>Graph DFS</td>
+    <td>Traverse a graph in a depth-first manner, starting from a given node, exploring along one path as deeply as
+      possible, and backtracking to explore other paths. Used for finding connected components, paths, etc.
+    </td>
+    <td>Recursion + Iteration</td>
+  </tr>
+  <tr>
+    <td>Binary Tree Morris</td>
+    <td>Morris traversal is an in-order traversal algorithm for binary trees with O(1) space complexity. It allows tree
+      traversal without additional stack or recursion.
+    </td>
+    <td>Iteration</td>
+  </tr>
+  <tr>
+    <td>Graph BFS</td>
+    <td>Traverse a graph in a breadth-first manner, starting from a given node, first visiting nodes directly connected
+      to the starting node, and then expanding level by level. Used for finding shortest paths, etc.
+    </td>
+    <td>Recursion + Iteration</td>
+  </tr>
+  <tr>
+    <td>Graph Tarjan's Algorithm</td>
+    <td>Find strongly connected components in a graph, typically implemented using depth-first search.</td>
+    <td>Recursion</td>
+  </tr>
+  <tr>
+    <td>Graph Bellman-Ford Algorithm</td>
+    <td>Finding the shortest paths from a single source, can handle negative weight edges</td>
+    <td>Iteration</td>
+  </tr>
+  <tr>
+    <td>Graph Dijkstra's Algorithm</td>
+    <td>Finding the shortest paths from a single source, cannot handle negative weight edges</td>
+    <td>Iteration</td>
+  </tr>
+  <tr>
+    <td>Graph Floyd-Warshall Algorithm</td>
+    <td>Finding the shortest paths between all pairs of nodes</td>
+    <td>Iteration</td>
+  </tr>
+  <tr>
+    <td>Graph getCycles</td>
+    <td>Find all cycles in a graph or detect the presence of cycles.</td>
+    <td>Recursion</td>
+  </tr>
+  <tr>
+    <td>Graph getCutVertexes</td>
+    <td>Find cut vertices in a graph, which are nodes that, when removed, increase the number of connected components in
+      the graph.
+    </td>
+    <td>Recursion</td>
+  </tr>
+  <tr>
+    <td>Graph getSCCs</td>
+    <td>Find strongly connected components in a graph, which are subgraphs where any two nodes can reach each other.
+    </td>
+    <td>Recursion</td>
+  </tr>
+  <tr>
+    <td>Graph getBridges</td>
+    <td>Find bridges in a graph, which are edges that, when removed, increase the number of connected components in the
+      graph.
+    </td>
+    <td>Recursion</td>
+  </tr>
+  <tr>
+    <td>Graph topologicalSort</td>
+    <td>Perform topological sorting on a directed acyclic graph (DAG) to find a linear order of nodes such that all
+      directed edges go from earlier nodes to later nodes.
+    </td>
+    <td>Recursion</td>
+  </tr>
+  </tbody>
+</table>
 
 ## Software Engineering Design Standards
 <table>
@@ -858,3 +850,41 @@ Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.key) // ['A', 'B', '
         <td>Data structure software does not involve load issues.</td>
     </tr>
 </table>
+
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Installation and Usage](#installation-and-usage)
+  - [npm](#npm)
+  - [yarn](#yarn)
+  - [CDN](#cdn)
+    - [development](#development)
+    - [production](#production)
+- [Vivid Examples](#vivid-examples)
+  - [Binary Tree](#binary-tree)
+  - [Binary Tree DFS](#binary-tree-dfs)
+  - [AVL Tree](#avl-tree)
+  - [Tree Multi Map](#tree-multi-map)
+  - [Matrix](#matrix)
+  - [Directed Graph](#directed-graph)
+  - [Map Graph](#map-graph)
+- [Code Snippets](#code-snippets)
+  - [Binary Search Tree (BST) snippet](#binary-search-tree-bst-snippet)
+    - [TS](#ts)
+    - [JS](#js)
+  - [AVLTree snippet](#avltree-snippet)
+    - [TS](#ts-1)
+    - [JS](#js-1)
+  - [Directed Graph simple snippet](#directed-graph-simple-snippet)
+    - [TS or JS](#ts-or-js)
+  - [Undirected Graph snippet](#undirected-graph-snippet)
+    - [TS or JS](#ts-or-js-1)
+- [API docs & Examples](#api-docs--examples)
+- [Data Structures](#data-structures)
+- [Standard library data structure comparison](#standard-library-data-structure-comparison)
+- [Benchmark](#benchmark)
+- [Built-in classic algorithms](#built-in-classic-algorithms)
+- [Software Engineering Design Standards](#software-engineering-design-standards)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-structure-typed",
-  "version": "1.46.7",
+  "version": "1.46.8",
   "description": "Data Structures of Javascript & TypeScript. Heap, Binary Tree, RedBlack Tree, Linked List, Deque, Trie, HashMap, Directed Graph, Undirected Graph, Binary Search Tree(BST), AVL Tree, Priority Queue, Graph, Queue, Tree Multiset, Singly Linked List, Doubly Linked List, Max Heap, Max Priority Queue, Min Heap, Min Priority Queue, Stack.",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
@@ -38,6 +38,7 @@
     "install:all-subs": "npm i avl-tree-typed binary-tree-typed bst-typed deque-typed directed-graph-typed doubly-linked-list-typed graph-typed heap-typed linked-list-typed max-heap-typed max-priority-queue-typed min-heap-typed min-priority-queue-typed priority-queue-typed singly-linked-list-typed stack-typed tree-multimap-typed trie-typed undirected-graph-typed queue-typed --save-dev",
     "changelog": "auto-changelog",
     "coverage:badge": "istanbul-badges-readme",
+    "toc": "doctoc README.md",
     "copy:to-subs": "sh scripts/copy_to_all_subs.sh",
     "publish:subs": "npm run copy:to-subs && sh scripts/publish_all_subs.sh",
     "publish:docs": "sh scripts/publish_docs.sh",
@@ -61,7 +62,6 @@
     "@types/benchmark": "^2.1.3",
     "@types/jest": "^29.5.5",
     "@types/node": "^20.8.2",
-    "@types/underscore": "^1.11.12",
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
     "auto-changelog": "^2.4.0",
@@ -71,6 +71,7 @@
     "bst-typed": "^1.44.0",
     "data-structure-typed": "^1.44.0",
     "dependency-cruiser": "^14.1.0",
+    "doctoc": "^2.2.1",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-alias": "^1.1.2",

package/tsconfig-base.json

@@ -15,7 +15,8 @@
     "skipLibCheck": true,                 // Skip type checking of type libraries.
     "strict": true,                       // Enable strict type checking, including enabling all strict options.
     "traceResolution": false,             // Whether to trace the module resolution process.
-    "types": ["node", "jest"]             // Specifies the name of the type declaration file to include.
+    "types": ["node", "jest"],            // Specifies the name of the type declaration file to include.
+    "typeRoots": ["node_modules/@types", "src/types", "test/types"]
   },
   "compileOnSave": false,                 // Whether to automatically compile when saving.
   "exclude": ["node_modules", "dist"],    // Specify files or directories that should not be included in the compilation.