data-structure-typed 1.35.0 → 1.35.1

package/.github/workflows/ci.yml

@@ -44,6 +44,9 @@ jobs:
       - name: Build and documentation
         run: npm run build
 
+      - name: Update Individuals
+        run: npm run update:individuals
+
       - name: Run tests
         run: npm test
 

package/CHANGELOG.md

@@ -8,7 +8,9 @@ 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.34.9](https://github.com/zrwusa/data-structure-typed/compare/v1.34.1...main) (upcoming)
+## [v1.35.1](https://github.com/zrwusa/data-structure-typed/compare/v1.35.0...main) (upcoming)
+
+## [v1.35.0](https://github.com/zrwusa/data-structure-typed/compare/v1.34.1...v1.35.0) (11 October 2023)
 
 ## [v1.34.1](https://github.com/zrwusa/data-structure-typed/compare/v1.33.4...v1.34.1) (6 October 2023)
 

package/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+## Contributing
+
+**General Rules**
+
+- As much as possible, try to follow the existing format of markdown and code.
+- Don't forget to run `npm run lint` and `npm test` before submitting pull requests.
+- Make sure that **100%** of your code is covered by tests.
+
+
+**Contributing New Data Structures**
+
+- Make your pull requests to be **specific** and **focused**. Instead of
+  contributing "several data structures" all at once contribute them all
+  one by one separately (i.e. one pull request for "RBTree", another one
+  for "AATree" and so on).
+- Provide **README.md** for each of the data structure **with explanations** of
+  the algorithm and **with links** to further readings.
+- Describe what you do in code using **comments**.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-structure-typed",
-  "version": "1.35.0",
+  "version": "1.35.1",
   "description": "Data Structures of Javascript & TypeScript. Binary Tree, BST, Graph, Heap, Priority Queue, Linked List, Queue, Deque, Stack, AVL Tree, Tree Multiset, Trie, Directed Graph, Undirected Graph, Singly Linked List, Doubly Linked List, Max Heap, Max Priority Queue, Min Heap, Min Priority Queue.",
   "main": "dist/index.js",
   "module": "lib/index.js",
@@ -28,7 +28,7 @@
     "check:deps": "dependency-cruiser src",
     "changelog": "auto-changelog",
     "coverage:badge": "istanbul-badges-readme",
-    "ci": "env && npm run lint && npm run build && npm run test && git fetch --tags && npm run changelog"
+    "ci": "env && npm run lint && npm run build && npm run update:individuals && npm run test && git fetch --tags && npm run changelog"
   },
   "repository": {
     "type": "git",
@@ -50,17 +50,17 @@
     "@typescript-eslint/eslint-plugin": "^6.7.4",
     "@typescript-eslint/parser": "^6.7.4",
     "auto-changelog": "^2.4.0",
-    "avl-tree-typed": "^1.34.8",
+    "avl-tree-typed": "^1.35.0",
     "benchmark": "^2.1.4",
-    "binary-tree-typed": "^1.34.8",
-    "bst-typed": "^1.34.8",
+    "binary-tree-typed": "^1.35.0",
+    "bst-typed": "^1.35.0",
     "dependency-cruiser": "^14.1.0",
     "eslint": "^8.50.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-alias": "^1.1.2",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.28.1",
-    "heap-typed": "^1.34.8",
+    "heap-typed": "^1.35.0",
     "istanbul-badges-readme": "^1.8.5",
     "jest": "^29.7.0",
     "prettier": "^3.0.3",

package/test/integration/avl-tree.test.ts

@@ -31,12 +31,12 @@ describe('AVL Tree Test', () => {
     // node15 has type problem. After the uniform design, the generics of containers (DirectedGraph, BST) are based on the type of value. However, this design has a drawback: when I attempt to inherit from the Vertex or BSTNode classes, the types of the results obtained by all methods are those of the parent class.
     expect(node15?.val).toBe(15);
 
-    const dfs = tree.DFS('in', 'node');
+    const dfs = tree.dfs('in', 'node');
     expect(dfs[0].key).toBe(1);
     expect(dfs[dfs.length - 1].key).toBe(16);
 
     tree.perfectlyBalance();
-    const bfs = tree.BFS('node');
+    const bfs = tree.bfs('node');
     expect(tree.isPerfectlyBalanced()).toBe(true);
     expect(bfs[0].key).toBe(8);
     expect(bfs[bfs.length - 1].key).toBe(16);
@@ -95,12 +95,12 @@ describe('AVL Tree Test', () => {
     expect(tree.getHeight()).toBe(1);
 
     expect(tree.isAVLBalanced()).toBe(true);
-    const lastBFSIds = tree.BFS();
+    const lastBFSIds = tree.bfs();
     expect(lastBFSIds[0]).toBe(12);
     expect(lastBFSIds[1]).toBe(2);
     expect(lastBFSIds[2]).toBe(16);
 
-    const lastBFSNodes = tree.BFS('node');
+    const lastBFSNodes = tree.bfs('node');
     expect(lastBFSNodes[0].key).toBe(12);
     expect(lastBFSNodes[1].key).toBe(2);
     expect(lastBFSNodes[2].key).toBe(16);

package/test/integration/bst.test.ts

@@ -44,14 +44,14 @@ describe('Individual package BST operations test', () => {
     const node11 = bst.get(11);
     expect(node11).toBeInstanceOf(BSTNode);
 
-    const dfsInorderNodes = bst.DFS('in', 'node');
+    const dfsInorderNodes = bst.dfs('in', 'node');
     expect(dfsInorderNodes[0].key).toBe(1);
     expect(dfsInorderNodes[dfsInorderNodes.length - 1].key).toBe(16);
 
     bst.perfectlyBalance();
     expect(bst.isPerfectlyBalanced()).toBe(true);
 
-    const bfsNodesAfterBalanced = bst.BFS('node');
+    const bfsNodesAfterBalanced = bst.bfs('node');
     expect(bfsNodesAfterBalanced[0].key).toBe(8);
     expect(bfsNodesAfterBalanced[bfsNodesAfterBalanced.length - 1].key).toBe(16);
 
@@ -169,12 +169,12 @@ describe('Individual package BST operations test', () => {
 
     expect(bst.isAVLBalanced()).toBe(false);
 
-    const bfsIDs = bst.BFS();
+    const bfsIDs = bst.bfs();
     expect(bfsIDs[0]).toBe(2);
     expect(bfsIDs[1]).toBe(12);
     expect(bfsIDs[2]).toBe(16);
 
-    const bfsNodes = bst.BFS('node');
+    const bfsNodes = bst.bfs('node');
     expect(bfsNodes[0].key).toBe(2);
     expect(bfsNodes[1].key).toBe(12);
     expect(bfsNodes[2].key).toBe(16);
@@ -242,14 +242,14 @@ describe('Individual package BST operations test', () => {
     const node11 = objBST.get(11);
     expect(node11).toBeInstanceOf(BSTNode);
 
-    const dfsInorderNodes = objBST.DFS('in', 'node');
+    const dfsInorderNodes = objBST.dfs('in', 'node');
     expect(dfsInorderNodes[0].key).toBe(1);
     expect(dfsInorderNodes[dfsInorderNodes.length - 1].key).toBe(16);
 
     objBST.perfectlyBalance();
     expect(objBST.isPerfectlyBalanced()).toBe(true);
 
-    const bfsNodesAfterBalanced = objBST.BFS('node');
+    const bfsNodesAfterBalanced = objBST.bfs('node');
     expect(bfsNodesAfterBalanced[0].key).toBe(8);
     expect(bfsNodesAfterBalanced[bfsNodesAfterBalanced.length - 1].key).toBe(16);
 
@@ -367,12 +367,12 @@ describe('Individual package BST operations test', () => {
 
     expect(objBST.isAVLBalanced()).toBe(false);
 
-    const bfsIDs = objBST.BFS();
+    const bfsIDs = objBST.bfs();
     expect(bfsIDs[0]).toBe(2);
     expect(bfsIDs[1]).toBe(12);
     expect(bfsIDs[2]).toBe(16);
 
-    const bfsNodes = objBST.BFS('node');
+    const bfsNodes = objBST.bfs('node');
     expect(bfsNodes[0].key).toBe(2);
     expect(bfsNodes[1].key).toBe(12);
     expect(bfsNodes[2].key).toBe(16);

package/test/unit/data-structures/graph/directed-graph.test.ts

@@ -1,4 +1,4 @@
-import {DirectedEdge, DirectedGraph, DirectedVertex, VertexId} from '../../../../src';
+import {DirectedEdge, DirectedGraph, DirectedVertex, VertexKey} from '../../../../src';
 
 describe('DirectedGraph Operation Test', () => {
   let graph: DirectedGraph;
@@ -63,7 +63,7 @@ describe('DirectedGraph Operation Test', () => {
 });
 
 class MyVertex<V extends string> extends DirectedVertex<V> {
-  constructor(key: VertexId, val?: V) {
+  constructor(key: VertexKey, val?: V) {
     super(key, val);
     this._data = val;
   }
@@ -80,7 +80,7 @@ class MyVertex<V extends string> extends DirectedVertex<V> {
 }
 
 class MyEdge<E extends string> extends DirectedEdge<E> {
-  constructor(v1: VertexId, v2: VertexId, weight?: number, val?: E) {
+  constructor(v1: VertexKey, v2: VertexKey, weight?: number, val?: E) {
     super(v1, v2, weight, val);
     this._data = val;
   }
@@ -97,11 +97,11 @@ class MyEdge<E extends string> extends DirectedEdge<E> {
 }
 
 class MyDirectedGraph<V extends MyVertex<string>, E extends MyEdge<string>> extends DirectedGraph<V, E> {
-  createVertex(key: VertexId, val: V['val']): V {
+  createVertex(key: VertexKey, val: V['val']): V {
     return new MyVertex(key, val) as V;
   }
 
-  createEdge(src: VertexId, dest: VertexId, weight?: number, val?: E['val']): E {
+  createEdge(src: VertexKey, dest: VertexKey, weight?: number, val?: E['val']): E {
     return new MyEdge(src, dest, weight ?? 1, val) as E;
   }
 }

package/test/unit/data-structures/graph/overall.test.ts

@@ -29,8 +29,8 @@ describe('Overall Graph Operation Test', () => {
     graph.addEdge('A', 'B');
     graph.addEdge('B', 'C');
 
-    const topologicalOrderIds = graph.topologicalSort();
-    expect(topologicalOrderIds).toEqual(['A', 'B', 'C']);
+    const topologicalOrderKeys = graph.topologicalSort();
+    expect(topologicalOrderKeys).toEqual(['A', 'B', 'C']);
   });
   it('Overall UndirectedGraph Operation Test', () => {
     const graph = new UndirectedGraph();

package/test/unit/data-structures/linked-list/singly-linked-list.test.ts

@@ -384,7 +384,7 @@ describe('SinglyLinkedList Performance Test', () => {
     for (let i = 0; i < magnitude.LINEAR; i++) {
       list.push(i);
     }
-    expect(performance.now() - startPushTime).toBeLessThan(bigO.LINEAR * 10);
+    expect(performance.now() - startPushTime).toBeLessThan(bigO.LINEAR * 20);
 
     const startPopTime = performance.now();
 

package/test/unit/data-structures/graph/index.ts

@@ -1,2 +0,0 @@
-export * from './directed-graph.test';
-export * from './undirected-graph.test';

package/test/unit/data-structures/linked-list/index.ts

@@ -1,4 +0,0 @@
-export * from './singly-linked-list.test';
-export * from './doubly-linked-list.test';
-export * from './linked-list.test';
-export * from './skip-linked-list.test';