heap-typed
Advanced tools
Comparing version 1.19.3 to 1.19.5
@@ -1,3 +0,8 @@ | ||
export * from './heap'; | ||
export * from './max-heap'; | ||
export * from './min-heap'; | ||
/** | ||
* data-structure-typed | ||
* | ||
* @author Tyler Zeng | ||
* @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com> | ||
* @license MIT License | ||
*/ | ||
export { HeapItem, Heap, MaxHeap, MinHeap } from 'data-structure-typed'; |
"use strict"; | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
var desc = Object.getOwnPropertyDescriptor(m, k); | ||
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { | ||
desc = { enumerable: true, get: function() { return m[k]; } }; | ||
} | ||
Object.defineProperty(o, k2, desc); | ||
}) : (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
o[k2] = m[k]; | ||
})); | ||
var __exportStar = (this && this.__exportStar) || function(m, exports) { | ||
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p); | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
__exportStar(require("./heap"), exports); | ||
__exportStar(require("./max-heap"), exports); | ||
__exportStar(require("./min-heap"), exports); | ||
exports.MinHeap = exports.MaxHeap = exports.Heap = exports.HeapItem = void 0; | ||
/** | ||
* data-structure-typed | ||
* | ||
* @author Tyler Zeng | ||
* @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com> | ||
* @license MIT License | ||
*/ | ||
var data_structure_typed_1 = require("data-structure-typed"); | ||
Object.defineProperty(exports, "HeapItem", { enumerable: true, get: function () { return data_structure_typed_1.HeapItem; } }); | ||
Object.defineProperty(exports, "Heap", { enumerable: true, get: function () { return data_structure_typed_1.Heap; } }); | ||
Object.defineProperty(exports, "MaxHeap", { enumerable: true, get: function () { return data_structure_typed_1.MaxHeap; } }); | ||
Object.defineProperty(exports, "MinHeap", { enumerable: true, get: function () { return data_structure_typed_1.MinHeap; } }); |
{ | ||
"name": "heap-typed", | ||
"version": "1.19.3", | ||
"version": "1.19.5", | ||
"description": "Heap. Javascript & Typescript Data Structure.", | ||
@@ -60,5 +60,5 @@ "main": "dist/index.js", | ||
"dependencies": { | ||
"data-structure-typed": "^1.19.3", | ||
"data-structure-typed": "^1.19.5", | ||
"zod": "^3.22.2" | ||
} | ||
} |
214
README.md
# What | ||
## Brief | ||
Javascript & TypeScript Data Structure Library. | ||
This is a standalone Heap 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 | ||
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 | ||
## Algorithms list only a few out, you can discover more in API docs | ||
DFS, DFSIterative, BFS, morris, Bellman-Ford Algorithm, Dijkstra's Algorithm, Floyd-Warshall Algorithm, Tarjan's Algorithm | ||
## 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. | ||
# How | ||
## install | ||
### yarn | ||
### npm | ||
```bash | ||
yarn add data-structure-typed | ||
npm i heap-typed | ||
``` | ||
### npm | ||
### yarn | ||
```bash | ||
npm install data-structure-typed | ||
yarn add heap-typed | ||
``` | ||
### Binary Search Tree (BST) snippet | ||
### snippet | ||
#### TS | ||
```typescript | ||
import {BST, BSTNode} from 'data-structure-typed'; | ||
const bst = new BST(); | ||
bst.add(11); | ||
bst.add(3); | ||
bst.addMany([15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]); | ||
bst.size === 16; // true | ||
bst.has(6); // true | ||
const node6 = bst.get(6); | ||
bst.getHeight(6) === 2; // true | ||
bst.getHeight() === 5; // true | ||
bst.getDepth(6) === 3; // true | ||
const leftMost = bst.getLeftMost(); | ||
leftMost?.id === 1; // true | ||
expect(leftMost?.id).toBe(1); | ||
bst.remove(6); | ||
bst.get(6); // null | ||
bst.isAVLBalanced(); // true or false | ||
const bfsIDs = bst.BFS(); | ||
bfsIDs[0] === 11; // true | ||
expect(bfsIDs[0]).toBe(11); | ||
const objBST = new BST<BSTNode<{ id: number, keyA: number }>>(); | ||
objBST.add(11, {id: 11, keyA: 11}); | ||
objBST.add(3, {id: 3, keyA: 3}); | ||
objBST.addMany([{id: 15, keyA: 15}, {id: 1, keyA: 1}, {id: 8, keyA: 8}, | ||
{id: 13, keyA: 13}, {id: 16, keyA: 16}, {id: 2, keyA: 2}, | ||
{id: 6, keyA: 6}, {id: 9, keyA: 9}, {id: 12, keyA: 12}, | ||
{id: 14, keyA: 14}, {id: 4, keyA: 4}, {id: 7, keyA: 7}, | ||
{id: 10, keyA: 10}, {id: 5, keyA: 5}]); | ||
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 | ||
``` | ||
#### JS | ||
```javascript | ||
const {BST, BSTNode} = require('data-structure-typed'); | ||
const bst = new BST(); | ||
bst.add(11); | ||
bst.add(3); | ||
bst.addMany([15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]); | ||
bst.size === 16; // true | ||
bst.has(6); // true | ||
const node6 = bst.get(6); | ||
bst.getHeight(6) === 2; // true | ||
bst.getHeight() === 5; // true | ||
bst.getDepth(6) === 3; // true | ||
const leftMost = bst.getLeftMost(); | ||
leftMost?.id === 1; // true | ||
expect(leftMost?.id).toBe(1); | ||
bst.remove(6); | ||
bst.get(6); // null | ||
bst.isAVLBalanced(); // true or false | ||
const bfsIDs = bst.BFS(); | ||
bfsIDs[0] === 11; // true | ||
expect(bfsIDs[0]).toBe(11); | ||
const objBST = new BST(); | ||
objBST.add(11, {id: 11, keyA: 11}); | ||
objBST.add(3, {id: 3, keyA: 3}); | ||
objBST.addMany([{id: 15, keyA: 15}, {id: 1, keyA: 1}, {id: 8, keyA: 8}, | ||
{id: 13, keyA: 13}, {id: 16, keyA: 16}, {id: 2, keyA: 2}, | ||
{id: 6, keyA: 6}, {id: 9, keyA: 9}, {id: 12, keyA: 12}, | ||
{id: 14, keyA: 14}, {id: 4, keyA: 4}, {id: 7, keyA: 7}, | ||
{id: 10, keyA: 10}, {id: 5, keyA: 5}]); | ||
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 | ||
``` | ||
### Directed Graph simple snippet | ||
#### TS or JS | ||
```typescript | ||
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'] | ||
``` | ||
### Undirected Graph snippet | ||
#### TS or JS | ||
```typescript | ||
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'] | ||
``` | ||
![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/dfs-pre-order.webp) | ||
![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/test-graphs.webp) | ||
![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/cut-off-trees-for-golf.webp) | ||
![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/examples/parenthesis-check.webp) | ||
## API docs & Examples | ||
@@ -185,6 +35,2 @@ | ||
<a href="https://data-structure-typed-examples.vercel.app" target="_blank">Live Examples</a> | ||
[//]: # ([Examples Repository](https://github.com/zrwusa/data-structure-typed-examples)) | ||
<a href="https://github.com/zrwusa/data-structure-typed-examples" target="_blank">Examples Repository</a> | ||
@@ -207,6 +53,6 @@ | ||
<td>Binary Tree</td> | ||
<td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""> | ||
</img></td> | ||
<td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""> | ||
</img></td> | ||
<td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""/> | ||
</td> | ||
<td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""/> | ||
</td> | ||
<td><a href="https://data-structure-typed-docs.vercel.app/classes/BinaryTree.html"><span>Binary Tree</span></a></td> | ||
@@ -658,46 +504,6 @@ <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/binary-tree/bst-rotation.gif)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/binary-tree/avl-tree-inserting.gif)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan.webp)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-list.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-list-pros-cons.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-matrix.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/adjacency-matrix-pros-cons.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/dfs-can-do.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/edge-list.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/edge-list-pros-cons.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/max-flow.jpg)) | ||
[//]: # () | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/mst.jpg)) | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan-articulation-point-bridge.png)) | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan-complicate-simple.png)) | ||
[//]: # (![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/graph/tarjan-strongly-connected-component.png)) | ||
@@ -6,5 +6,6 @@ { | ||
"module": "commonjs", | ||
"target": "es5", | ||
"target": "es6", | ||
"lib": [ | ||
"esnext", | ||
// "es2015", | ||
"esnext" | ||
], | ||
@@ -34,6 +35,7 @@ "strict": true, | ||
"exclude": [ | ||
// "node_modules/data-structure-typed", | ||
// "node_modules/data-structure-typed", | ||
"node_modules", | ||
"dist" | ||
] | ||
} | ||
} | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
38164
7
490
507
Updateddata-structure-typed@^1.19.5