data-structure-typed 1.32.0 → 1.32.2

package/.github/workflows/ci.yml

@@ -4,6 +4,17 @@ on:
   push:
     branches:
       - main
+    # Ignore changes in folders with generated contents or documentation.
+    # Need to match git add parameters below.
+    paths-ignore:
+      - 'lib/**'
+      - 'dist/**'
+      - 'docs/**'
+      - 'coverage/**'
+      - '**/*.md'
+    pull_request:
+      branches:
+        - main
 
 jobs:
   build:
@@ -26,5 +37,5 @@ jobs:
       - name: Build
         run: npm run build
 
-      - name: Run tests
+      - name: Run tests and documentation
         run: npm test

package/.prettierrc.js

@@ -1,6 +1,6 @@
 module.exports = {
   arrowParens: 'avoid',
-  bracketSpacing: true,
+  bracketSpacing: false,
   htmlWhitespaceSensitivity: 'css',
   insertPragma: false,
   bracketSameLine: false,

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.32.0](https://github.com/zrwusa/data-structure-typed/compare/v1.12.9...main) (upcoming)
+## [v1.32.2](https://github.com/zrwusa/data-structure-typed/compare/v1.12.9...main) (upcoming)
 
 ## [v1.12.9](https://github.com/zrwusa/data-structure-typed/compare/v1.12.8...v1.12.9) (14 August 2023)
 

package/README.md

@@ -1,4 +1,11 @@
-# What
+# Data Structure Typed
+
+![License](https://img.shields.io/badge/License-MIT-blue.svg)
+![Language](https://img.shields.io/github/languages/top/zrwusa/data-structure-typed)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/zrwusa/data-structure-typed)
+![Branches](https://img.shields.io/badge/branches-97.54%25-brightgreen.svg?style=flat)
+![npm](https://aleen42.github.io/badges/src/npm.svg)
+![eslint](https://aleen42.github.io/badges/src/eslint.svg)
 
 ## Brief
 Data Structures of Javascript & TypeScript.  
@@ -8,8 +15,7 @@ DFS(Depth-First Search), DFSIterative, BFS(Breadth-First Search),
 morris, Bellman-Ford Algorithm, Dijkstra's Algorithm, Floyd-Warshall Algorithm, 
 Tarjan's Algorithm.
 
-# How
-## install
+## Installation and Usage
 ### npm
 ```bash
 npm install data-structure-typed --save
@@ -22,7 +28,7 @@ yarn add data-structure-typed
 ```html
 <script src="https://cdn.jsdelivr.net/npm/data-structure-typed/umd/bundle.min.js"></script>
 ```
-```javascript
+```js
 const {AVLTree} = dataStructureTyped;
 const {Heap, MinHeap, SinglyLinkedList, Stack, AVLTreeNode, BST, Trie, DirectedGraph, DirectedVertex, TreeMultiset} = dataStructureTyped;
 ```
@@ -46,7 +52,7 @@ const {Heap, MinHeap, SinglyLinkedList, Stack, AVLTreeNode, BST, Trie, DirectedG
 ## Code Snippet
 ### Binary Search Tree (BST) snippet
 #### TS
-```typescript
+```ts
     import {BST, BSTNode} from 'data-structure-typed';
 
     const bst = new BST();
@@ -66,7 +72,6 @@ const {Heap, MinHeap, SinglyLinkedList, Stack, AVLTreeNode, BST, Trie, DirectedG
     bst.get(6);                     // null
     bst.isAVLBalanced();            // true
     bst.BFS()[0] === 11;            // true
-    
 
     const objBST = new BST<BSTNode<{ id: number, keyA: number }>>();
     objBST.add(11, {id: 11, keyA: 11});
@@ -81,7 +86,7 @@ const {Heap, MinHeap, SinglyLinkedList, Stack, AVLTreeNode, BST, Trie, DirectedG
     objBST.remove(11);
 ```
 #### JS
-```javascript
+```js
     const {BST, BSTNode} = require('data-structure-typed');
 
     const bst = new BST();
@@ -116,84 +121,80 @@ const {Heap, MinHeap, SinglyLinkedList, Stack, AVLTreeNode, BST, Trie, DirectedG
     
     objBST.remove(11);
     
-    
     const avlTree = new AVLTree();
     avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
     avlTree.isAVLBalanced();    // true
     avlTree.remove(10);
     avlTree.isAVLBalanced();    // true
-
 ```
 
 ### AVLTree snippet
 #### TS
-```typescript
-    import {AVLTree} from 'data-structure-typed';
-
-    const avlTree = new AVLTree();
-    avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
-    avlTree.isAVLBalanced();    // true
-    avlTree.remove(10);
-    avlTree.isAVLBalanced();    // true
-
+```ts
+import {AVLTree} from 'data-structure-typed';
+
+const avlTree = new AVLTree();
+avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
+avlTree.isAVLBalanced();    // true
+avlTree.remove(10);
+avlTree.isAVLBalanced();    // true
 ```
 #### JS
-```javascript
-    const {AVLTree} = require('data-structure-typed');
-
-    const avlTree = new AVLTree();
-    avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
-    avlTree.isAVLBalanced();    // true
-    avlTree.remove(10);
-    avlTree.isAVLBalanced();    // true
-
+```js
+const {AVLTree} = require('data-structure-typed');
+
+const avlTree = new AVLTree();
+avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
+avlTree.isAVLBalanced();    // true
+avlTree.remove(10);
+avlTree.isAVLBalanced();    // true
 ```
 
 ### Directed Graph simple snippet
 #### TS or JS
-```typescript
+```ts
 import {DirectedGraph} from 'data-structure-typed';
 
-    const graph = new DirectedGraph();
-    
-    graph.addVertex('A');
-    graph.addVertex('B');
-    
-    graph.hasVertex('A');       // true
-    graph.hasVertex('B');       // true
-    graph.hasVertex('C');       // false
-    
-    graph.addEdge('A', 'B');
-    graph.hasEdge('A', 'B');    // true
-    graph.hasEdge('B', 'A');    // false
-    
-    graph.removeEdgeSrcToDest('A', 'B');
-    graph.hasEdge('A', 'B');    // false
-    
-    graph.addVertex('C');
-    
-    graph.addEdge('A', 'B');
-    graph.addEdge('B', 'C');
-    
-    const topologicalOrderIds = graph.topologicalSort(); // ['A', 'B', 'C']
+const graph = new DirectedGraph();
+
+graph.addVertex('A');
+graph.addVertex('B');
+
+graph.hasVertex('A');       // true
+graph.hasVertex('B');       // true
+graph.hasVertex('C');       // false
+
+graph.addEdge('A', 'B');
+graph.hasEdge('A', 'B');    // true
+graph.hasEdge('B', 'A');    // false
+
+graph.removeEdgeSrcToDest('A', 'B');
+graph.hasEdge('A', 'B');    // false
+
+graph.addVertex('C');
+
+graph.addEdge('A', 'B');
+graph.addEdge('B', 'C');
+
+const topologicalOrderIds = graph.topologicalSort(); // ['A', 'B', 'C']
 ```
 
 ### Undirected Graph snippet
 #### TS or JS
-```typescript
+```ts
 import {UndirectedGraph} from 'data-structure-typed';
 
-    const graph = new UndirectedGraph();
-    graph.addVertex('A');
-    graph.addVertex('B');
-    graph.addVertex('C');
-    graph.addVertex('D');
-    graph.removeVertex('C');
-    graph.addEdge('A', 'B');
-    graph.addEdge('B', 'D');
-    
-    const dijkstraResult = graph.dijkstra('A');
-    Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.id) // ['A', 'B', 'D']
+const graph = new UndirectedGraph();
+graph.addVertex('A');
+graph.addVertex('B');
+graph.addVertex('C');
+graph.addVertex('D');
+graph.removeVertex('C');
+graph.addEdge('A', 'B');
+graph.addEdge('B', 'D');
+
+const dijkstraResult = graph.dijkstra('A');
+Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.id) // ['A', 'B', 'D']
 ```
 
 ## Data Structures
@@ -320,20 +321,6 @@ import {UndirectedGraph} from 'data-structure-typed';
 <td><a href="https://data-structure-typed-docs.vercel.app/classes/Stack.html"><span>Stack</span></a></td>
 <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td>
 </tr>
-
-[//]: # (<tr>)
-
-[//]: # (<td>Hash</td>)
-
-[//]: # (<td></td>)
-
-[//]: # (<td></td>)
-
-[//]: # (<td><a href="https://data-structure-typed-docs.vercel.app/classes/HashTable.html"><span>HashTable</span></a></td>)
-
-[//]: # (<td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td>)
-
-[//]: # (</tr>)
 <tr>
 <td>Coordinate Set</td>
 <td></td>
@@ -386,100 +373,6 @@ import {UndirectedGraph} from 'data-structure-typed';
 </tbody>
 </table>
 
-[//]: # (## API docs)
-
-[//]: # (<ul>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/AVLTree.html" rel="nofollow"><span>AVLTree</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/AVLTreeNode.html" rel="nofollow"><span>AVLTreeNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractEdge.html" rel="nofollow"><span>AbstractEdge</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractGraph.html" rel="nofollow"><span>AbstractGraph</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/AbstractVertex.html" rel="nofollow"><span>AbstractVertex</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/ArrayDeque.html" rel="nofollow"><span>ArrayDeque</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/BST.html" rel="nofollow"><span>BST</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/BSTNode.html" rel="nofollow"><span>BSTNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryIndexedTree.html" rel="nofollow"><span>BinaryIndexedTree</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTree.html" rel="nofollow"><span>BinaryTree</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTreeNode.html" rel="nofollow"><span>BinaryTreeNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Character.html" rel="nofollow"><span>Character</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/CoordinateMap.html" rel="nofollow"><span>CoordinateMap</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/CoordinateSet.html" rel="nofollow"><span>CoordinateSet</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Deque.html" rel="nofollow"><span>Deque</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/DirectedEdge.html" rel="nofollow"><span>DirectedEdge</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/DirectedGraph.html" rel="nofollow"><span>DirectedGraph</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/DirectedVertex.html" rel="nofollow"><span>DirectedVertex</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/DoublyLinkedList.html" rel="nofollow"><span>DoublyLinkedList</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/DoublyLinkedListNode.html" rel="nofollow"><span>DoublyLinkedListNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Heap.html" rel="nofollow"><span>Heap</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Matrix2D.html" rel="nofollow"><span>Matrix2D</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/MatrixNTI2D.html" rel="nofollow"><span>MatrixNTI2D</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/MaxHeap.html" rel="nofollow"><span>MaxHeap</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/MaxPriorityQueue.html" rel="nofollow"><span>MaxPriorityQueue</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/MinHeap.html" rel="nofollow"><span>MinHeap</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/MinPriorityQueue.html" rel="nofollow"><span>MinPriorityQueue</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Navigator.html" rel="nofollow"><span>Navigator</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/ObjectDeque.html" rel="nofollow"><span>ObjectDeque</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/PriorityQueue.html" rel="nofollow"><span>PriorityQueue</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Queue.html" rel="nofollow"><span>Queue</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/SegmentTree.html" rel="nofollow"><span>SegmentTree</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/SegmentTreeNode.html" rel="nofollow"><span>SegmentTreeNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/SinglyLinkedList.html" rel="nofollow"><span>SinglyLinkedList</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/SinglyLinkedListNode.html" rel="nofollow"><span>SinglyLinkedListNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Stack.html" rel="nofollow"><span>Stack</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/TreeMultiSet.html" rel="nofollow"><span>TreeMultiSet</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Trie.html" rel="nofollow"><span>Trie</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/TrieNode.html" rel="nofollow"><span>TrieNode</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedEdge.html" rel="nofollow"><span>UndirectedEdge</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedGraph.html" rel="nofollow"><span>UndirectedGraph</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/UndirectedVertex.html" rel="nofollow"><span>UndirectedVertex</span></a></li>)
-
-[//]: # (<li><a href="https://data-structure-typed-docs.vercel.app/classes/Vector2D.html" rel="nofollow"><span>Vector2D</span></a></li>)
-
-[//]: # (</ul>)
-
-# Why
-
 ## Code design
 By strictly adhering to object-oriented design (BinaryTree -> BST -> AVLTree -> TreeMultiset), you can seamlessly inherit the existing data structures to implement the customized ones you need. Object-oriented design stands as the optimal approach to data structure design.
 
@@ -742,9 +635,3 @@ By strictly adhering to object-oriented design (BinaryTree -> BST -> AVLTree ->
 </tr>
 </tbody>
 </table>
-
-[//]: # (![overview diagram]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/assets/overview-diagram-of-data-structures.png?raw=true&#41;)
-
-![complexities](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/assets/complexities-diff.jpg?raw=true)
-
-![complexities of data structures](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/assets/data-structure-complexities.jpg?raw=true)