stack-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.
Files changed (7) hide show
  1. package/README.md +10 -204
  2. package/dist/index.d.ts +8 -1
  3. package/dist/index.js +10 -15
  4. package/package.json +2 -2
  5. package/tsconfig.json +6 -4
  6. package/dist/stack.d.ts +0 -63
  7. package/dist/stack.js +0 -92
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 Stack 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 stack-typed
22
12
  ```
23
-
24
- ### npm
25
-
13
+ ### yarn
26
14
  ```bash
27
- npm install data-structure-typed
15
+ yarn add stack-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 './stack';
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 { Stack } from 'data-structure-typed';
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
- __exportStar(require("./stack"), exports);
3
+ exports.Stack = 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, "Stack", { enumerable: true, get: function () { return data_structure_typed_1.Stack; } });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stack-typed",
3
- "version": "1.19.3",
3
+ "version": "1.19.6",
4
4
  "description": "Stack. Javascript & Typescript Data Structure.",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -56,7 +56,7 @@
56
56
  "typescript": "^4.9.5"
57
57
  },
58
58
  "dependencies": {
59
- "data-structure-typed": "^1.19.3",
59
+ "data-structure-typed": "1.19.6",
60
60
  "zod": "^3.22.2"
61
61
  }
62
62
  }
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/stack.d.ts DELETED
@@ -1,63 +0,0 @@
1
- /**
2
- * @license MIT
3
- * @copyright Tyler Zeng <zrwusa@gmail.com>
4
- * @class
5
- */
6
- export declare class Stack<T = number> {
7
- protected _elements: T[];
8
- /**
9
- * The constructor initializes an array of elements, which can be provided as an optional parameter.
10
- * @param {T[]} [elements] - The `elements` parameter is an optional parameter of type `T[]`, which represents an array
11
- * of elements of type `T`. It is used to initialize the `_elements` property of the class. If the `elements` parameter
12
- * is provided and is an array, it is assigned to the `_elements
13
- */
14
- constructor(elements?: T[]);
15
- /**
16
- * The function "fromArray" creates a new Stack object from an array of elements.
17
- * @param {T[]} elements - The `elements` parameter is an array of elements of type `T`.
18
- * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
19
- * array.
20
- */
21
- static fromArray<T>(elements: T[]): Stack<T>;
22
- /**
23
- * The function checks if an array is empty and returns a boolean value.
24
- * @returns A boolean value indicating whether the `_elements` array is empty or not.
25
- */
26
- isEmpty(): boolean;
27
- /**
28
- * The size() function returns the number of elements in an array.
29
- * @returns The size of the elements array.
30
- */
31
- size(): number;
32
- /**
33
- * The `peek` function returns the last element of an array, or null if the array is empty.
34
- * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
35
- */
36
- peek(): T | null;
37
- /**
38
- * The push function adds an element to the stack and returns the updated stack.
39
- * @param {T} element - The parameter "element" is of type T, which means it can be any data type.
40
- * @returns The `push` method is returning the updated `Stack<T>` object.
41
- */
42
- push(element: T): Stack<T>;
43
- /**
44
- * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
45
- * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
46
- * array is empty, it returns `null`.
47
- */
48
- pop(): T | null;
49
- /**
50
- * The toArray function returns a copy of the elements in an array.
51
- * @returns An array of type T.
52
- */
53
- toArray(): T[];
54
- /**
55
- * The clear function clears the elements array.
56
- */
57
- clear(): void;
58
- /**
59
- * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
60
- * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
61
- */
62
- clone(): Stack<T>;
63
- }
package/dist/stack.js DELETED
@@ -1,92 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Stack = void 0;
4
- /**
5
- * @license MIT
6
- * @copyright Tyler Zeng <zrwusa@gmail.com>
7
- * @class
8
- */
9
- var Stack = /** @class */ (function () {
10
- /**
11
- * The constructor initializes an array of elements, which can be provided as an optional parameter.
12
- * @param {T[]} [elements] - The `elements` parameter is an optional parameter of type `T[]`, which represents an array
13
- * of elements of type `T`. It is used to initialize the `_elements` property of the class. If the `elements` parameter
14
- * is provided and is an array, it is assigned to the `_elements
15
- */
16
- function Stack(elements) {
17
- this._elements = Array.isArray(elements) ? elements : [];
18
- }
19
- /**
20
- * The function "fromArray" creates a new Stack object from an array of elements.
21
- * @param {T[]} elements - The `elements` parameter is an array of elements of type `T`.
22
- * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
23
- * array.
24
- */
25
- Stack.fromArray = function (elements) {
26
- return new Stack(elements);
27
- };
28
- /**
29
- * The function checks if an array is empty and returns a boolean value.
30
- * @returns A boolean value indicating whether the `_elements` array is empty or not.
31
- */
32
- Stack.prototype.isEmpty = function () {
33
- return this._elements.length === 0;
34
- };
35
- /**
36
- * The size() function returns the number of elements in an array.
37
- * @returns The size of the elements array.
38
- */
39
- Stack.prototype.size = function () {
40
- return this._elements.length;
41
- };
42
- /**
43
- * The `peek` function returns the last element of an array, or null if the array is empty.
44
- * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
45
- */
46
- Stack.prototype.peek = function () {
47
- if (this.isEmpty())
48
- return null;
49
- return this._elements[this._elements.length - 1];
50
- };
51
- /**
52
- * The push function adds an element to the stack and returns the updated stack.
53
- * @param {T} element - The parameter "element" is of type T, which means it can be any data type.
54
- * @returns The `push` method is returning the updated `Stack<T>` object.
55
- */
56
- Stack.prototype.push = function (element) {
57
- this._elements.push(element);
58
- return this;
59
- };
60
- /**
61
- * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
62
- * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
63
- * array is empty, it returns `null`.
64
- */
65
- Stack.prototype.pop = function () {
66
- if (this.isEmpty())
67
- return null;
68
- return this._elements.pop() || null;
69
- };
70
- /**
71
- * The toArray function returns a copy of the elements in an array.
72
- * @returns An array of type T.
73
- */
74
- Stack.prototype.toArray = function () {
75
- return this._elements.slice();
76
- };
77
- /**
78
- * The clear function clears the elements array.
79
- */
80
- Stack.prototype.clear = function () {
81
- this._elements = [];
82
- };
83
- /**
84
- * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
85
- * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
86
- */
87
- Stack.prototype.clone = function () {
88
- return new Stack(this._elements.slice());
89
- };
90
- return Stack;
91
- }());
92
- exports.Stack = Stack;