undirected-graph-typed 1.19.3 → 1.19.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +10 -204
  2. package/dist/index.d.ts +8 -1
  3. package/dist/index.js +12 -15
  4. package/package.json +2 -2
  5. package/tsconfig.json +6 -4
  6. package/dist/undirected-graph.d.ts +0 -127
  7. package/dist/undirected-graph.js +0 -341
package/README.md CHANGED
@@ -1,180 +1,30 @@
1
1
  # What
2
-
3
2
  ## Brief
4
- Javascript & TypeScript Data Structure Library.
5
-
6
- Binary Tree, Binary Search Tree (BST), AVL Tree, Tree Multiset, Segment Tree, Binary Indexed Tree, Graph, Directed Graph, Undirected Graph, Linked List, Singly Linked List, Doubly Linked List, Queue, Object Deque, Array Deque, Stack, Hash, Coordinate Set, Coordinate Map, Heap, Priority Queue, Max Priority Queue, Min Priority Queue, Trie
7
-
8
- ## Algorithms list only a few out, you can discover more in API docs
3
+ This is a standalone Undirected Graph data structure from the data-structure-typed collection. If you wish to access more data structures or advanced features, you can transition to directly installing the complete [data-structure-typed](https://www.npmjs.com/package/data-structure-typed) package
9
4
 
10
- DFS, DFSIterative, BFS, morris, Bellman-Ford Algorithm, Dijkstra's Algorithm, Floyd-Warshall Algorithm, Tarjan's Algorithm
11
-
12
- ## Code design
13
- 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.
14
5
 
15
6
  # How
16
7
 
17
8
  ## install
18
- ### yarn
19
-
9
+ ### npm
20
10
  ```bash
21
- yarn add data-structure-typed
11
+ npm i undirected-graph-typed
22
12
  ```
23
-
24
- ### npm
25
-
13
+ ### yarn
26
14
  ```bash
27
- npm install data-structure-typed
15
+ yarn add undirected-graph-typed
28
16
  ```
29
17
 
30
- ### Binary Search Tree (BST) snippet
31
-
18
+ ### snippet
32
19
  #### TS
33
20
  ```typescript
34
- import {BST, BSTNode} from 'data-structure-typed';
35
-
36
- const bst = new BST();
37
- bst.add(11);
38
- bst.add(3);
39
- bst.addMany([15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]);
40
- bst.size === 16; // true
41
- bst.has(6); // true
42
- const node6 = bst.get(6);
43
- bst.getHeight(6) === 2; // true
44
- bst.getHeight() === 5; // true
45
- bst.getDepth(6) === 3; // true
46
- const leftMost = bst.getLeftMost();
47
- leftMost?.id === 1; // true
48
- expect(leftMost?.id).toBe(1);
49
- bst.remove(6);
50
- bst.get(6); // null
51
- bst.isAVLBalanced(); // true or false
52
- const bfsIDs = bst.BFS();
53
- bfsIDs[0] === 11; // true
54
- expect(bfsIDs[0]).toBe(11);
55
-
56
- const objBST = new BST<BSTNode<{ id: number, keyA: number }>>();
57
- objBST.add(11, {id: 11, keyA: 11});
58
- objBST.add(3, {id: 3, keyA: 3});
59
-
60
- objBST.addMany([{id: 15, keyA: 15}, {id: 1, keyA: 1}, {id: 8, keyA: 8},
61
- {id: 13, keyA: 13}, {id: 16, keyA: 16}, {id: 2, keyA: 2},
62
- {id: 6, keyA: 6}, {id: 9, keyA: 9}, {id: 12, keyA: 12},
63
- {id: 14, keyA: 14}, {id: 4, keyA: 4}, {id: 7, keyA: 7},
64
- {id: 10, keyA: 10}, {id: 5, keyA: 5}]);
65
-
66
- objBST.remove(11);
67
-
68
-
69
- const avlTree = new AVLTree();
70
- avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
71
- avlTree.isAVLBalanced(); // true
72
- avlTree.remove(10);
73
- avlTree.isAVLBalanced(); // true
74
21
 
75
22
  ```
76
23
  #### JS
77
24
  ```javascript
78
- const {BST, BSTNode} = require('data-structure-typed');
79
-
80
- const bst = new BST();
81
- bst.add(11);
82
- bst.add(3);
83
- bst.addMany([15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]);
84
- bst.size === 16; // true
85
- bst.has(6); // true
86
- const node6 = bst.get(6);
87
- bst.getHeight(6) === 2; // true
88
- bst.getHeight() === 5; // true
89
- bst.getDepth(6) === 3; // true
90
- const leftMost = bst.getLeftMost();
91
- leftMost?.id === 1; // true
92
- expect(leftMost?.id).toBe(1);
93
- bst.remove(6);
94
- bst.get(6); // null
95
- bst.isAVLBalanced(); // true or false
96
- const bfsIDs = bst.BFS();
97
- bfsIDs[0] === 11; // true
98
- expect(bfsIDs[0]).toBe(11);
99
-
100
- const objBST = new BST();
101
- objBST.add(11, {id: 11, keyA: 11});
102
- objBST.add(3, {id: 3, keyA: 3});
103
-
104
- objBST.addMany([{id: 15, keyA: 15}, {id: 1, keyA: 1}, {id: 8, keyA: 8},
105
- {id: 13, keyA: 13}, {id: 16, keyA: 16}, {id: 2, keyA: 2},
106
- {id: 6, keyA: 6}, {id: 9, keyA: 9}, {id: 12, keyA: 12},
107
- {id: 14, keyA: 14}, {id: 4, keyA: 4}, {id: 7, keyA: 7},
108
- {id: 10, keyA: 10}, {id: 5, keyA: 5}]);
109
-
110
- objBST.remove(11);
111
-
112
-
113
- const avlTree = new AVLTree();
114
- avlTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5])
115
- avlTree.isAVLBalanced(); // true
116
- avlTree.remove(10);
117
- avlTree.isAVLBalanced(); // true
118
-
119
- ```
120
-
121
- ### Directed Graph simple snippet
122
25
 
123
- #### TS or JS
124
- ```typescript
125
- import {DirectedGraph} from 'data-structure-typed';
126
-
127
- const graph = new DirectedGraph();
128
-
129
- graph.addVertex('A');
130
- graph.addVertex('B');
131
-
132
- graph.hasVertex('A'); // true
133
- graph.hasVertex('B'); // true
134
- graph.hasVertex('C'); // false
135
-
136
- graph.addEdge('A', 'B');
137
- graph.hasEdge('A', 'B'); // true
138
- graph.hasEdge('B', 'A'); // false
139
-
140
- graph.removeEdgeSrcToDest('A', 'B');
141
- graph.hasEdge('A', 'B'); // false
142
-
143
- graph.addVertex('C');
144
-
145
- graph.addEdge('A', 'B');
146
- graph.addEdge('B', 'C');
147
-
148
- const topologicalOrderIds = graph.topologicalSort(); // ['A', 'B', 'C']
149
- ```
150
-
151
- ### Undirected Graph snippet
152
-
153
- #### TS or JS
154
- ```typescript
155
- import {UndirectedGraph} from 'data-structure-typed';
156
-
157
- const graph = new UndirectedGraph();
158
- graph.addVertex('A');
159
- graph.addVertex('B');
160
- graph.addVertex('C');
161
- graph.addVertex('D');
162
- graph.removeVertex('C');
163
- graph.addEdge('A', 'B');
164
- graph.addEdge('B', 'D');
165
-
166
- const dijkstraResult = graph.dijkstra('A');
167
- Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.id) // ['A', 'B', 'D']
168
26
  ```
169
27
 
170
- ![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/dfs-pre-order.webp)
171
-
172
- ![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/test-graphs.webp)
173
-
174
- ![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/cut-off-trees-for-golf.webp)
175
-
176
- ![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/parenthesis-check.webp)
177
-
178
28
 
179
29
  ## API docs & Examples
180
30
 
@@ -182,10 +32,6 @@ import {UndirectedGraph} from 'data-structure-typed';
182
32
 
183
33
  [Live Examples](https://data-structure-typed-examples.vercel.app)
184
34
 
185
- <a href="https://data-structure-typed-examples.vercel.app" target="_blank">Live Examples</a>
186
-
187
- [//]: # ([Examples Repository]&#40;https://github.com/zrwusa/data-structure-typed-examples&#41;)
188
-
189
35
  <a href="https://github.com/zrwusa/data-structure-typed-examples" target="_blank">Examples Repository</a>
190
36
 
191
37
  ## Data Structures
@@ -203,10 +49,10 @@ import {UndirectedGraph} from 'data-structure-typed';
203
49
  <tbody>
204
50
  <tr>
205
51
  <td>Binary Tree</td>
206
- <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt="">
207
- </img></td>
208
- <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt="">
209
- </img></td>
52
+ <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""/>
53
+ </td>
54
+ <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""/>
55
+ </td>
210
56
  <td><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTree.html"><span>Binary Tree</span></a></td>
211
57
  <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td>
212
58
  </tr>
@@ -653,46 +499,6 @@ import {UndirectedGraph} from 'data-structure-typed';
653
499
 
654
500
  ![complexities of data structures](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/assets/data-structure-complexities.jpg)
655
501
 
656
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/binary-tree/bst-rotation.gif&#41;)
657
-
658
- [//]: # ()
659
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/binary-tree/avl-tree-inserting.gif&#41;)
660
-
661
- [//]: # ()
662
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan.webp&#41;)
663
-
664
- [//]: # ()
665
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-list.jpg&#41;)
666
-
667
- [//]: # ()
668
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-list-pros-cons.jpg&#41;)
669
-
670
- [//]: # ()
671
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-matrix.jpg&#41;)
672
-
673
- [//]: # ()
674
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-matrix-pros-cons.jpg&#41;)
675
-
676
- [//]: # ()
677
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/dfs-can-do.jpg&#41;)
678
-
679
- [//]: # ()
680
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/edge-list.jpg&#41;)
681
-
682
- [//]: # ()
683
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/edge-list-pros-cons.jpg&#41;)
684
-
685
- [//]: # ()
686
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/max-flow.jpg&#41;)
687
-
688
- [//]: # ()
689
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/mst.jpg&#41;)
690
-
691
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan-articulation-point-bridge.png&#41;)
692
-
693
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan-complicate-simple.png&#41;)
694
-
695
- [//]: # (![]&#40;https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan-strongly-connected-component.png&#41;)
696
502
 
697
503
 
698
504
 
package/dist/index.d.ts CHANGED
@@ -1 +1,8 @@
1
- export * from './undirected-graph';
1
+ /**
2
+ * data-structure-typed
3
+ *
4
+ * @author Tyler Zeng
5
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
6
+ * @license MIT License
7
+ */
8
+ export { UndirectedVertex, UndirectedEdge, UndirectedGraph } from 'data-structure-typed';
package/dist/index.js CHANGED
@@ -1,17 +1,14 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
2
  Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./undirected-graph"), exports);
3
+ exports.UndirectedGraph = exports.UndirectedEdge = exports.UndirectedVertex = void 0;
4
+ /**
5
+ * data-structure-typed
6
+ *
7
+ * @author Tyler Zeng
8
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
9
+ * @license MIT License
10
+ */
11
+ var data_structure_typed_1 = require("data-structure-typed");
12
+ Object.defineProperty(exports, "UndirectedVertex", { enumerable: true, get: function () { return data_structure_typed_1.UndirectedVertex; } });
13
+ Object.defineProperty(exports, "UndirectedEdge", { enumerable: true, get: function () { return data_structure_typed_1.UndirectedEdge; } });
14
+ Object.defineProperty(exports, "UndirectedGraph", { enumerable: true, get: function () { return data_structure_typed_1.UndirectedGraph; } });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "undirected-graph-typed",
3
- "version": "1.19.3",
3
+ "version": "1.19.5",
4
4
  "description": "Undirected Graph. Javascript & Typescript Data Structure.",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -57,7 +57,7 @@
57
57
  "typescript": "^4.9.5"
58
58
  },
59
59
  "dependencies": {
60
- "data-structure-typed": "^1.19.3",
60
+ "data-structure-typed": "^1.19.5",
61
61
  "zod": "^3.22.2"
62
62
  }
63
63
  }
package/tsconfig.json CHANGED
@@ -3,9 +3,10 @@
3
3
  "declaration": true,
4
4
  "outDir": "./dist",
5
5
  "module": "commonjs",
6
- "target": "es5",
6
+ "target": "es6",
7
7
  "lib": [
8
- "esnext",
8
+ // "es2015",
9
+ "esnext"
9
10
  ],
10
11
  "strict": true,
11
12
  "esModuleInterop": true,
@@ -30,8 +31,9 @@
30
31
  "src",
31
32
  ],
32
33
  "exclude": [
33
- // "node_modules/data-structure-typed",
34
+ // "node_modules/data-structure-typed",
34
35
  "node_modules",
35
36
  "dist"
36
37
  ]
37
- }
38
+ }
39
+
package/dist/undirected-graph.d.ts DELETED
@@ -1,127 +0,0 @@
1
- import { AbstractEdge, AbstractGraph, AbstractVertex } from 'data-structure-typed';
2
- import type { VertexId } from 'data-structure-typed';
3
- import { IUNDirectedGraph } from 'data-structure-typed';
4
- export declare class UndirectedVertex<T = number> extends AbstractVertex<T> {
5
- /**
6
- * The constructor function initializes a vertex with an optional value.
7
- * @param {VertexId} id - The `id` parameter is of type `VertexId` and represents the identifier of the vertex. It is
8
- * used to uniquely identify the vertex within a graph or network.
9
- * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to initialize the value of the
10
- * vertex. If no value is provided, the vertex will be initialized with a default value.
11
- */
12
- constructor(id: VertexId, val?: T);
13
- }
14
- export declare class UndirectedEdge<T = number> extends AbstractEdge<T> {
15
- /**
16
- * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
17
- * value.
18
- * @param {VertexId} v1 - The first vertex ID of the edge.
19
- * @param {VertexId} v2 - The parameter `v2` is a `VertexId`, which represents the identifier of the second vertex in a
20
- * graph edge.
21
- * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
22
- * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to store a value associated
23
- * with the edge.
24
- */
25
- constructor(v1: VertexId, v2: VertexId, weight?: number, val?: T);
26
- private _vertices;
27
- get vertices(): [VertexId, VertexId];
28
- set vertices(v: [VertexId, VertexId]);
29
- }
30
- export declare class UndirectedGraph<V extends UndirectedVertex<any> = UndirectedVertex, E extends UndirectedEdge<any> = UndirectedEdge> extends AbstractGraph<V, E> implements IUNDirectedGraph<V, E> {
31
- /**
32
- * The constructor initializes a new Map object to store edges.
33
- */
34
- constructor();
35
- protected _edges: Map<V, E[]>;
36
- get edges(): Map<V, E[]>;
37
- /**
38
- * The function creates a new vertex with an optional value and returns it.
39
- * @param {VertexId} id - The `id` parameter is the unique identifier for the vertex. It is used to distinguish one
40
- * vertex from another in the graph.
41
- * @param [val] - The `val` parameter is an optional value that can be assigned to the vertex. If a value is provided,
42
- * it will be used as the value of the vertex. If no value is provided, the `id` parameter will be used as the value of
43
- * the vertex.
44
- * @returns The method is returning a new instance of the `UndirectedVertex` class, casted as type `V`.
45
- */
46
- createVertex(id: VertexId, val?: V['val']): V;
47
- /**
48
- * The function creates an undirected edge between two vertices with an optional weight and value.
49
- * @param {VertexId} v1 - The parameter `v1` represents the first vertex of the edge.
50
- * @param {VertexId} v2 - The parameter `v2` represents the second vertex of the edge.
51
- * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. If
52
- * no weight is provided, it defaults to 1.
53
- * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type and
54
- * is used to store additional information or data associated with the edge.
55
- * @returns a new instance of the `UndirectedEdge` class, which is casted as type `E`.
56
- */
57
- createEdge(v1: VertexId, v2: VertexId, weight?: number, val?: E['val']): E;
58
- /**
59
- * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
60
- * @param {V | null | VertexId} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `V` (vertex
61
- * object), `null`, or `VertexId` (a string or number representing the ID of a vertex).
62
- * @param {V | null | VertexId} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
63
- * object), `null`, or `VertexId` (vertex ID).
64
- * @returns an edge (E) or null.
65
- */
66
- getEdge(v1: V | null | VertexId, v2: V | null | VertexId): E | null;
67
- /**
68
- * The function removes an edge between two vertices in a graph and returns the removed edge.
69
- * @param {V | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
70
- * @param {V | VertexId} v2 - V | VertexId - This parameter can be either a vertex object (V) or a vertex ID
71
- * (VertexId). It represents the second vertex of the edge that needs to be removed.
72
- * @returns the removed edge (E) if it exists, or null if either of the vertices (V) does not exist.
73
- */
74
- removeEdgeBetween(v1: V | VertexId, v2: V | VertexId): E | null;
75
- /**
76
- * The removeEdge function removes an edge between two vertices in a graph.
77
- * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
78
- * @returns The method is returning either the removed edge (of type E) or null if the edge was not found.
79
- */
80
- removeEdge(edge: E): E | null;
81
- /**
82
- * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edges connected to that
83
- * vertex.
84
- * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
85
- * @returns The function `degreeOf` returns the degree of a vertex in a graph. The degree of a vertex is the number of
86
- * edges connected to that vertex.
87
- */
88
- degreeOf(vertexOrId: VertexId | V): number;
89
- /**
90
- * The function returns the edges of a given vertex or vertex ID.
91
- * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`. A `VertexId` is a
92
- * unique identifier for a vertex in a graph, while `V` represents the type of the vertex.
93
- * @returns an array of edges.
94
- */
95
- edgesOf(vertexOrId: VertexId | V): E[];
96
- /**
97
- * The function "edgeSet" returns an array of unique edges from a set of edges.
98
- * @returns The method `edgeSet()` returns an array of type `E[]`.
99
- */
100
- edgeSet(): E[];
101
- /**
102
- * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
103
- * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
104
- * (`VertexId`).
105
- * @returns an array of vertices (V[]).
106
- */
107
- getNeighbors(vertexOrId: V | VertexId): V[];
108
- /**
109
- * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge exists in the graph, otherwise
110
- * it returns null.
111
- * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
112
- * @returns The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
113
- * graph. If the edge does not exist, it returns `null`.
114
- */
115
- getEndsOfEdge(edge: E): [V, V] | null;
116
- /**
117
- * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
118
- * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
119
- * @returns a boolean value.
120
- */
121
- protected _addEdgeOnly(edge: E): boolean;
122
- /**
123
- * The function sets the edges of a graph.
124
- * @param v - A map where the keys are of type V and the values are arrays of type E.
125
- */
126
- protected _setEdges(v: Map<V, E[]>): void;
127
- }
package/dist/undirected-graph.js DELETED
@@ -1,341 +0,0 @@
1
- "use strict";
2
- var __extends = (this && this.__extends) || (function () {
3
- var extendStatics = function (d, b) {
4
- extendStatics = Object.setPrototypeOf ||
5
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
6
- function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
7
- return extendStatics(d, b);
8
- };
9
- return function (d, b) {
10
- if (typeof b !== "function" && b !== null)
11
- throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
12
- extendStatics(d, b);
13
- function __() { this.constructor = d; }
14
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
15
- };
16
- })();
17
- var __read = (this && this.__read) || function (o, n) {
18
- var m = typeof Symbol === "function" && o[Symbol.iterator];
19
- if (!m) return o;
20
- var i = m.call(o), r, ar = [], e;
21
- try {
22
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
23
- }
24
- catch (error) { e = { error: error }; }
25
- finally {
26
- try {
27
- if (r && !r.done && (m = i["return"])) m.call(i);
28
- }
29
- finally { if (e) throw e.error; }
30
- }
31
- return ar;
32
- };
33
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
34
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
35
- if (ar || !(i in from)) {
36
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
37
- ar[i] = from[i];
38
- }
39
- }
40
- return to.concat(ar || Array.prototype.slice.call(from));
41
- };
42
- var __values = (this && this.__values) || function(o) {
43
- var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
44
- if (m) return m.call(o);
45
- if (o && typeof o.length === "number") return {
46
- next: function () {
47
- if (o && i >= o.length) o = void 0;
48
- return { value: o && o[i++], done: !o };
49
- }
50
- };
51
- throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
52
- };
53
- Object.defineProperty(exports, "__esModule", { value: true });
54
- exports.UndirectedGraph = exports.UndirectedEdge = exports.UndirectedVertex = void 0;
55
- /**
56
- * data-structure-typed
57
- *
58
- * @author Tyler Zeng
59
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
60
- * @license MIT License
61
- */
62
- var data_structure_typed_1 = require("data-structure-typed");
63
- var data_structure_typed_2 = require("data-structure-typed");
64
- var UndirectedVertex = /** @class */ (function (_super) {
65
- __extends(UndirectedVertex, _super);
66
- /**
67
- * The constructor function initializes a vertex with an optional value.
68
- * @param {VertexId} id - The `id` parameter is of type `VertexId` and represents the identifier of the vertex. It is
69
- * used to uniquely identify the vertex within a graph or network.
70
- * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to initialize the value of the
71
- * vertex. If no value is provided, the vertex will be initialized with a default value.
72
- */
73
- function UndirectedVertex(id, val) {
74
- return _super.call(this, id, val) || this;
75
- }
76
- return UndirectedVertex;
77
- }(data_structure_typed_2.AbstractVertex));
78
- exports.UndirectedVertex = UndirectedVertex;
79
- var UndirectedEdge = /** @class */ (function (_super) {
80
- __extends(UndirectedEdge, _super);
81
- /**
82
- * The constructor function creates an instance of a class with two vertex IDs, an optional weight, and an optional
83
- * value.
84
- * @param {VertexId} v1 - The first vertex ID of the edge.
85
- * @param {VertexId} v2 - The parameter `v2` is a `VertexId`, which represents the identifier of the second vertex in a
86
- * graph edge.
87
- * @param {number} [weight] - The weight parameter is an optional number that represents the weight of the edge.
88
- * @param {T} [val] - The "val" parameter is an optional parameter of type T. It is used to store a value associated
89
- * with the edge.
90
- */
91
- function UndirectedEdge(v1, v2, weight, val) {
92
- var _this = _super.call(this, weight, val) || this;
93
- _this._vertices = [v1, v2];
94
- return _this;
95
- }
96
- Object.defineProperty(UndirectedEdge.prototype, "vertices", {
97
- get: function () {
98
- return this._vertices;
99
- },
100
- set: function (v) {
101
- this._vertices = v;
102
- },
103
- enumerable: false,
104
- configurable: true
105
- });
106
- return UndirectedEdge;
107
- }(data_structure_typed_2.AbstractEdge));
108
- exports.UndirectedEdge = UndirectedEdge;
109
- var UndirectedGraph = /** @class */ (function (_super) {
110
- __extends(UndirectedGraph, _super);
111
- /**
112
- * The constructor initializes a new Map object to store edges.
113
- */
114
- function UndirectedGraph() {
115
- var _this = _super.call(this) || this;
116
- _this._edges = new Map();
117
- return _this;
118
- }
119
- Object.defineProperty(UndirectedGraph.prototype, "edges", {
120
- get: function () {
121
- return this._edges;
122
- },
123
- enumerable: false,
124
- configurable: true
125
- });
126
- /**
127
- * The function creates a new vertex with an optional value and returns it.
128
- * @param {VertexId} id - The `id` parameter is the unique identifier for the vertex. It is used to distinguish one
129
- * vertex from another in the graph.
130
- * @param [val] - The `val` parameter is an optional value that can be assigned to the vertex. If a value is provided,
131
- * it will be used as the value of the vertex. If no value is provided, the `id` parameter will be used as the value of
132
- * the vertex.
133
- * @returns The method is returning a new instance of the `UndirectedVertex` class, casted as type `V`.
134
- */
135
- UndirectedGraph.prototype.createVertex = function (id, val) {
136
- return new UndirectedVertex(id, val !== null && val !== void 0 ? val : id);
137
- };
138
- /**
139
- * The function creates an undirected edge between two vertices with an optional weight and value.
140
- * @param {VertexId} v1 - The parameter `v1` represents the first vertex of the edge.
141
- * @param {VertexId} v2 - The parameter `v2` represents the second vertex of the edge.
142
- * @param {number} [weight] - The `weight` parameter is an optional number that represents the weight of the edge. If
143
- * no weight is provided, it defaults to 1.
144
- * @param [val] - The `val` parameter is an optional value that can be assigned to the edge. It can be of any type and
145
- * is used to store additional information or data associated with the edge.
146
- * @returns a new instance of the `UndirectedEdge` class, which is casted as type `E`.
147
- */
148
- UndirectedGraph.prototype.createEdge = function (v1, v2, weight, val) {
149
- return new UndirectedEdge(v1, v2, weight !== null && weight !== void 0 ? weight : 1, val);
150
- };
151
- /**
152
- * The function `getEdge` returns the first edge that connects two vertices, or null if no such edge exists.
153
- * @param {V | null | VertexId} v1 - The parameter `v1` represents a vertex or vertex ID. It can be of type `V` (vertex
154
- * object), `null`, or `VertexId` (a string or number representing the ID of a vertex).
155
- * @param {V | null | VertexId} v2 - The parameter `v2` represents a vertex or vertex ID. It can be of type `V` (vertex
156
- * object), `null`, or `VertexId` (vertex ID).
157
- * @returns an edge (E) or null.
158
- */
159
- UndirectedGraph.prototype.getEdge = function (v1, v2) {
160
- var _a;
161
- var edges = [];
162
- if (v1 !== null && v2 !== null) {
163
- var vertex1 = this._getVertex(v1);
164
- var vertex2_1 = this._getVertex(v2);
165
- if (vertex1 && vertex2_1) {
166
- edges = (_a = this._edges.get(vertex1)) === null || _a === void 0 ? void 0 : _a.filter(function (e) { return e.vertices.includes(vertex2_1.id); });
167
- }
168
- }
169
- return edges ? edges[0] || null : null;
170
- };
171
- /**
172
- * The function removes an edge between two vertices in a graph and returns the removed edge.
173
- * @param {V | VertexId} v1 - The parameter `v1` represents either a vertex object (`V`) or a vertex ID (`VertexId`).
174
- * @param {V | VertexId} v2 - V | VertexId - This parameter can be either a vertex object (V) or a vertex ID
175
- * (VertexId). It represents the second vertex of the edge that needs to be removed.
176
- * @returns the removed edge (E) if it exists, or null if either of the vertices (V) does not exist.
177
- */
178
- UndirectedGraph.prototype.removeEdgeBetween = function (v1, v2) {
179
- var vertex1 = this._getVertex(v1);
180
- var vertex2 = this._getVertex(v2);
181
- if (!vertex1 || !vertex2) {
182
- return null;
183
- }
184
- var v1Edges = this._edges.get(vertex1);
185
- var removed = null;
186
- if (v1Edges) {
187
- removed = (0, data_structure_typed_1.arrayRemove)(v1Edges, function (e) { return e.vertices.includes(vertex2.id); })[0] || null;
188
- }
189
- var v2Edges = this._edges.get(vertex2);
190
- if (v2Edges) {
191
- (0, data_structure_typed_1.arrayRemove)(v2Edges, function (e) { return e.vertices.includes(vertex1.id); });
192
- }
193
- return removed;
194
- };
195
- /**
196
- * The removeEdge function removes an edge between two vertices in a graph.
197
- * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
198
- * @returns The method is returning either the removed edge (of type E) or null if the edge was not found.
199
- */
200
- UndirectedGraph.prototype.removeEdge = function (edge) {
201
- return this.removeEdgeBetween(edge.vertices[0], edge.vertices[1]);
202
- };
203
- /**
204
- * The function `degreeOf` returns the degree of a vertex in a graph, which is the number of edges connected to that
205
- * vertex.
206
- * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`.
207
- * @returns The function `degreeOf` returns the degree of a vertex in a graph. The degree of a vertex is the number of
208
- * edges connected to that vertex.
209
- */
210
- UndirectedGraph.prototype.degreeOf = function (vertexOrId) {
211
- var _a;
212
- var vertex = this._getVertex(vertexOrId);
213
- if (vertex) {
214
- return ((_a = this._edges.get(vertex)) === null || _a === void 0 ? void 0 : _a.length) || 0;
215
- }
216
- else {
217
- return 0;
218
- }
219
- };
220
- /**
221
- * The function returns the edges of a given vertex or vertex ID.
222
- * @param {VertexId | V} vertexOrId - The parameter `vertexOrId` can be either a `VertexId` or a `V`. A `VertexId` is a
223
- * unique identifier for a vertex in a graph, while `V` represents the type of the vertex.
224
- * @returns an array of edges.
225
- */
226
- UndirectedGraph.prototype.edgesOf = function (vertexOrId) {
227
- var vertex = this._getVertex(vertexOrId);
228
- if (vertex) {
229
- return this._edges.get(vertex) || [];
230
- }
231
- else {
232
- return [];
233
- }
234
- };
235
- /**
236
- * The function "edgeSet" returns an array of unique edges from a set of edges.
237
- * @returns The method `edgeSet()` returns an array of type `E[]`.
238
- */
239
- UndirectedGraph.prototype.edgeSet = function () {
240
- var edgeSet = new Set();
241
- this._edges.forEach(function (edges) {
242
- edges.forEach(function (edge) {
243
- edgeSet.add(edge);
244
- });
245
- });
246
- return __spreadArray([], __read(edgeSet), false);
247
- };
248
- /**
249
- * The function "getNeighbors" returns an array of neighboring vertices for a given vertex or vertex ID.
250
- * @param {V | VertexId} vertexOrId - The parameter `vertexOrId` can be either a vertex object (`V`) or a vertex ID
251
- * (`VertexId`).
252
- * @returns an array of vertices (V[]).
253
- */
254
- UndirectedGraph.prototype.getNeighbors = function (vertexOrId) {
255
- var e_1, _a;
256
- var neighbors = [];
257
- var vertex = this._getVertex(vertexOrId);
258
- if (vertex) {
259
- var neighborEdges = this.edgesOf(vertex);
260
- try {
261
- for (var neighborEdges_1 = __values(neighborEdges), neighborEdges_1_1 = neighborEdges_1.next(); !neighborEdges_1_1.done; neighborEdges_1_1 = neighborEdges_1.next()) {
262
- var edge = neighborEdges_1_1.value;
263
- var neighbor = this._getVertex(edge.vertices.filter(function (e) { return e !== vertex.id; })[0]);
264
- if (neighbor) {
265
- neighbors.push(neighbor);
266
- }
267
- }
268
- }
269
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
270
- finally {
271
- try {
272
- if (neighborEdges_1_1 && !neighborEdges_1_1.done && (_a = neighborEdges_1.return)) _a.call(neighborEdges_1);
273
- }
274
- finally { if (e_1) throw e_1.error; }
275
- }
276
- }
277
- return neighbors;
278
- };
279
- /**
280
- * The function "getEndsOfEdge" returns the vertices at the ends of an edge if the edge exists in the graph, otherwise
281
- * it returns null.
282
- * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
283
- * @returns The function `getEndsOfEdge` returns an array containing two vertices `[V, V]` if the edge exists in the
284
- * graph. If the edge does not exist, it returns `null`.
285
- */
286
- UndirectedGraph.prototype.getEndsOfEdge = function (edge) {
287
- if (!this.hasEdge(edge.vertices[0], edge.vertices[1])) {
288
- return null;
289
- }
290
- var v1 = this._getVertex(edge.vertices[0]);
291
- var v2 = this._getVertex(edge.vertices[1]);
292
- if (v1 && v2) {
293
- return [v1, v2];
294
- }
295
- else {
296
- return null;
297
- }
298
- };
299
- /**
300
- * The function adds an edge to the graph by updating the adjacency list with the vertices of the edge.
301
- * @param {E} edge - The parameter "edge" is of type E, which represents an edge in a graph.
302
- * @returns a boolean value.
303
- */
304
- UndirectedGraph.prototype._addEdgeOnly = function (edge) {
305
- var e_2, _a;
306
- try {
307
- for (var _b = __values(edge.vertices), _c = _b.next(); !_c.done; _c = _b.next()) {
308
- var end = _c.value;
309
- var endVertex = this._getVertex(end);
310
- if (endVertex === null)
311
- return false;
312
- if (endVertex) {
313
- var edges = this._edges.get(endVertex);
314
- if (edges) {
315
- edges.push(edge);
316
- }
317
- else {
318
- this._edges.set(endVertex, [edge]);
319
- }
320
- }
321
- }
322
- }
323
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
324
- finally {
325
- try {
326
- if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
327
- }
328
- finally { if (e_2) throw e_2.error; }
329
- }
330
- return true;
331
- };
332
- /**
333
- * The function sets the edges of a graph.
334
- * @param v - A map where the keys are of type V and the values are arrays of type E.
335
- */
336
- UndirectedGraph.prototype._setEdges = function (v) {
337
- this._edges = v;
338
- };
339
- return UndirectedGraph;
340
- }(data_structure_typed_2.AbstractGraph));
341
- exports.UndirectedGraph = UndirectedGraph;