min-priority-queue-typed 1.19.3 → 1.19.6
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.
- package/README.md +10 -204
- package/dist/index.d.ts +8 -1
- package/dist/index.js +10 -15
- package/package.json +2 -2
- package/tsconfig.json +6 -4
- package/dist/min-priority-queue.d.ts +0 -15
- package/dist/min-priority-queue.js +0 -68
package/README.md
CHANGED
|
@@ -1,180 +1,30 @@
|
|
|
1
1
|
# What
|
|
2
|
-
|
|
3
2
|
## Brief
|
|
4
|
-
|
|
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 Min Priority Queue 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
|
-
###
|
|
19
|
-
|
|
9
|
+
### npm
|
|
20
10
|
```bash
|
|
21
|
-
|
|
11
|
+
npm i min-priority-queue-typed
|
|
22
12
|
```
|
|
23
|
-
|
|
24
|
-
### npm
|
|
25
|
-
|
|
13
|
+
### yarn
|
|
26
14
|
```bash
|
|
27
|
-
|
|
15
|
+
yarn add min-priority-queue-typed
|
|
28
16
|
```
|
|
29
17
|
|
|
30
|
-
###
|
|
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
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
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](https://github.com/zrwusa/data-structure-typed-examples))
|
|
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
|
-
</
|
|
208
|
-
<td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""
|
|
209
|
-
</
|
|
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
|
|
|
655
501
|
|
|
656
|
-
[//]: # ()
|
|
657
|
-
|
|
658
|
-
[//]: # ()
|
|
659
|
-
[//]: # ()
|
|
660
|
-
|
|
661
|
-
[//]: # ()
|
|
662
|
-
[//]: # ()
|
|
663
|
-
|
|
664
|
-
[//]: # ()
|
|
665
|
-
[//]: # ()
|
|
666
|
-
|
|
667
|
-
[//]: # ()
|
|
668
|
-
[//]: # ()
|
|
669
|
-
|
|
670
|
-
[//]: # ()
|
|
671
|
-
[//]: # ()
|
|
672
|
-
|
|
673
|
-
[//]: # ()
|
|
674
|
-
[//]: # ()
|
|
675
|
-
|
|
676
|
-
[//]: # ()
|
|
677
|
-
[//]: # ()
|
|
678
|
-
|
|
679
|
-
[//]: # ()
|
|
680
|
-
[//]: # ()
|
|
681
|
-
|
|
682
|
-
[//]: # ()
|
|
683
|
-
[//]: # ()
|
|
684
|
-
|
|
685
|
-
[//]: # ()
|
|
686
|
-
[//]: # ()
|
|
687
|
-
|
|
688
|
-
[//]: # ()
|
|
689
|
-
[//]: # ()
|
|
690
|
-
|
|
691
|
-
[//]: # ()
|
|
692
|
-
|
|
693
|
-
[//]: # ()
|
|
694
|
-
|
|
695
|
-
[//]: # ()
|
|
696
502
|
|
|
697
503
|
|
|
698
504
|
|
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -1,17 +1,12 @@
|
|
|
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
|
-
|
|
3
|
+
exports.MinPriorityQueue = 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, "MinPriorityQueue", { enumerable: true, get: function () { return data_structure_typed_1.MinPriorityQueue; } });
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "min-priority-queue-typed",
|
|
3
|
-
"version": "1.19.
|
|
3
|
+
"version": "1.19.6",
|
|
4
4
|
"description": "Min Priority Queue. Javascript & Typescript Data Structure.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"typescript": "^4.9.5"
|
|
55
55
|
},
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"data-structure-typed": "
|
|
57
|
+
"data-structure-typed": "1.19.6",
|
|
58
58
|
"zod": "^3.22.2"
|
|
59
59
|
}
|
|
60
60
|
}
|
package/tsconfig.json
CHANGED
|
@@ -3,9 +3,10 @@
|
|
|
3
3
|
"declaration": true,
|
|
4
4
|
"outDir": "./dist",
|
|
5
5
|
"module": "commonjs",
|
|
6
|
-
"target": "
|
|
6
|
+
"target": "es6",
|
|
7
7
|
"lib": [
|
|
8
|
-
"
|
|
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
|
+
|
|
@@ -1,15 +0,0 @@
|
|
|
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
|
-
import { PriorityQueue } from 'data-structure-typed';
|
|
9
|
-
import type { PriorityQueueOptions } from 'data-structure-typed';
|
|
10
|
-
export declare class MinPriorityQueue<T = number> extends PriorityQueue<T> {
|
|
11
|
-
constructor(options?: Omit<PriorityQueueOptions<number>, 'comparator'>);
|
|
12
|
-
constructor(options: PriorityQueueOptions<T>);
|
|
13
|
-
static heapify<T extends number>(options?: Omit<PriorityQueueOptions<T>, 'comparator'>): MinPriorityQueue<T>;
|
|
14
|
-
static heapify<T>(options: PriorityQueueOptions<T>): MinPriorityQueue<T>;
|
|
15
|
-
}
|
|
@@ -1,68 +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 __assign = (this && this.__assign) || function () {
|
|
18
|
-
__assign = Object.assign || function(t) {
|
|
19
|
-
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
20
|
-
s = arguments[i];
|
|
21
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
22
|
-
t[p] = s[p];
|
|
23
|
-
}
|
|
24
|
-
return t;
|
|
25
|
-
};
|
|
26
|
-
return __assign.apply(this, arguments);
|
|
27
|
-
};
|
|
28
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.MinPriorityQueue = void 0;
|
|
30
|
-
/**
|
|
31
|
-
* data-structure-typed
|
|
32
|
-
*
|
|
33
|
-
* @author Tyler Zeng
|
|
34
|
-
* @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
|
|
35
|
-
* @license MIT License
|
|
36
|
-
*/
|
|
37
|
-
var data_structure_typed_1 = require("data-structure-typed");
|
|
38
|
-
var MinPriorityQueue = /** @class */ (function (_super) {
|
|
39
|
-
__extends(MinPriorityQueue, _super);
|
|
40
|
-
/**
|
|
41
|
-
* The constructor initializes a priority queue with an optional comparator function.
|
|
42
|
-
* @param [options] - The `options` parameter is an optional object that can contain various configuration options for
|
|
43
|
-
* the `PriorityQueue` constructor.
|
|
44
|
-
*/
|
|
45
|
-
function MinPriorityQueue(options) {
|
|
46
|
-
return _super.call(this, __assign(__assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator) ? options.comparator : function (a, b) {
|
|
47
|
-
var aKey = a, bKey = b;
|
|
48
|
-
return aKey - bKey;
|
|
49
|
-
} })) || this;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* The function `heapify` creates a new MinPriorityQueue instance and sets the comparator function based on the options
|
|
53
|
-
* provided, and then fixes the heap structure of the queue.
|
|
54
|
-
* @param options - The `options` parameter is an object that contains configuration options for creating a priority
|
|
55
|
-
* queue. It can have the following properties:
|
|
56
|
-
* @returns a MinPriorityQueue object.
|
|
57
|
-
*/
|
|
58
|
-
MinPriorityQueue.heapify = function (options) {
|
|
59
|
-
var minPQ = new MinPriorityQueue(__assign(__assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator) ? options.comparator : function (a, b) {
|
|
60
|
-
var aKey = a, bKey = b;
|
|
61
|
-
return aKey - bKey;
|
|
62
|
-
} }));
|
|
63
|
-
minPQ._fix();
|
|
64
|
-
return minPQ;
|
|
65
|
-
};
|
|
66
|
-
return MinPriorityQueue;
|
|
67
|
-
}(data_structure_typed_1.PriorityQueue));
|
|
68
|
-
exports.MinPriorityQueue = MinPriorityQueue;
|