2023-09-22 03:20:33 +00:00
# Data Structure Typed
2023-10-10 09:22:18 +00:00
2023-09-22 02:40:12 +00:00
2023-10-10 09:22:18 +00:00
2023-10-10 14:18:39 +00:00
Data Structures of Javascript & TypeScript.
2023-11-03 17:21:30 +00:00
Do you envy C++ with [STL](), Python with [collections](), and Java with [java.util]() ? Well, no need to envy anymore! JavaScript and TypeScript now have [data-structure-typed]().
2023-10-10 14:18:39 +00:00
Now you can use this library in Node.js and browser environments in CommonJS(require export.modules = ), ESModule(import export), Typescript(import export), UMD(var Queue = dataStructureTyped.Queue)
2023-09-22 02:40:12 +00:00
2023-10-05 02:37:42 +00:00
[//]: # ( )
[//]: # ( )
[//]: # ( )
[//]: # ( )
2023-09-18 14:04:39 +00:00
## Built-in classic algorithms
2023-09-24 13:31:09 +00:00
DFS(Depth-First Search), DFSIterative, BFS(Breadth-First Search), morris, Bellman-Ford Algorithm, Dijkstra's Algorithm,
Floyd-Warshall Algorithm, Tarjan's Algorithm.
2023-08-29 12:52:15 +00:00
2023-09-22 03:20:33 +00:00
## Installation and Usage
2023-09-24 13:31:09 +00:00
2023-08-30 16:50:23 +00:00
### npm
2023-09-24 13:31:09 +00:00
2023-08-30 16:50:23 +00:00
```bash
2023-10-17 15:52:24 +00:00
npm i data-structure-typed --save
2023-08-30 16:50:23 +00:00
```
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
### yarn
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
```bash
2023-09-12 03:10:09 +00:00
yarn add data-structure-typed
2023-08-28 12:04:43 +00:00
```
2023-09-24 13:31:09 +00:00
2023-10-05 02:37:42 +00:00
```js
import {
BinaryTree, Graph, Queue, Stack, PriorityQueue, BST, Trie, DoublyLinkedList,
AVLTree, MinHeap, SinglyLinkedList, DirectedGraph, TreeMultiset,
DirectedVertex, AVLTreeNode
} from 'data-structure-typed';
```
2023-09-09 15:49:53 +00:00
### CDN
2023-09-24 13:31:09 +00:00
2023-09-09 15:49:53 +00:00
```html
2023-09-24 13:31:09 +00:00
2023-10-27 14:30:52 +00:00
< script src = 'https://cdn.jsdelivr.net/npm/data-structure-typed/dist/umd/data-structure-typed.min.js' > < / script >
2023-09-09 15:49:53 +00:00
```
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```js
2023-10-05 02:37:42 +00:00
const {Heap} = dataStructureTyped;
2023-09-24 13:31:09 +00:00
const {
2023-10-05 02:37:42 +00:00
BinaryTree, Graph, Queue, Stack, PriorityQueue, BST, Trie, DoublyLinkedList,
AVLTree, MinHeap, SinglyLinkedList, DirectedGraph, TreeMultiset,
DirectedVertex, AVLTreeNode
2023-09-24 13:31:09 +00:00
} = dataStructureTyped;
2023-09-09 15:49:53 +00:00
```
2023-09-18 14:04:39 +00:00
2023-09-09 15:49:53 +00:00
## API docs & Examples
[API Docs ](https://data-structure-typed-docs.vercel.app )
2023-09-12 03:43:25 +00:00
[Live Examples ](https://vivid-algorithm.vercel.app )
2023-09-09 15:49:53 +00:00
2023-09-12 03:43:25 +00:00
< a href = "https://github.com/zrwusa/vivid-algorithm" target = "_blank" > Examples Repository< / a >
2023-08-28 12:04:43 +00:00
2023-09-18 14:04:39 +00:00
## Code Snippet
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
### Binary Search Tree (BST) snippet
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
#### TS
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```ts
2023-09-24 13:31:09 +00:00
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); // BSTNode
bst.getHeight(6) === 2; // true
bst.getHeight() === 5; // true
bst.getDepth(6) === 3; // true
bst.getLeftMost()?.id === 1; // true
2023-10-28 07:58:48 +00:00
bst.delete(6);
2023-09-24 13:31:09 +00:00
bst.get(6); // null
bst.isAVLBalanced(); // true
2023-10-10 14:15:01 +00:00
bst.bfs()[0] === 11; // true
2023-09-24 13:31:09 +00:00
2023-09-26 04:49:33 +00:00
const objBST = new BST< BSTNode < { id: number , keyA: number } > >();
2023-09-24 13:31:09 +00:00
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}]);
2023-10-28 07:58:48 +00:00
objBST.delete(11);
2023-08-28 12:04:43 +00:00
```
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
#### JS
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```js
2023-09-24 13:31:09 +00:00
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);
2023-10-28 07:58:48 +00:00
bst.delete(6);
2023-09-24 13:31:09 +00:00
bst.get(6); // null
bst.isAVLBalanced(); // true or false
2023-10-10 14:15:01 +00:00
const bfsIDs = bst.bfs();
2023-09-24 13:31:09 +00:00
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}]);
2023-10-28 07:58:48 +00:00
objBST.delete(11);
2023-09-24 13:31:09 +00:00
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
2023-10-28 07:58:48 +00:00
avlTree.delete(10);
2023-09-24 13:31:09 +00:00
avlTree.isAVLBalanced(); // true
2023-08-28 12:04:43 +00:00
```
2023-09-20 03:39:24 +00:00
### AVLTree snippet
2023-09-24 13:31:09 +00:00
2023-09-20 03:39:24 +00:00
#### TS
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```ts
import {AVLTree} from 'data-structure-typed';
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
2023-10-28 07:58:48 +00:00
avlTree.delete(10);
2023-09-22 03:20:33 +00:00
avlTree.isAVLBalanced(); // true
2023-09-20 03:39:24 +00:00
```
2023-09-24 13:31:09 +00:00
2023-09-20 03:39:24 +00:00
#### JS
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```js
const {AVLTree} = require('data-structure-typed');
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
2023-10-28 07:58:48 +00:00
avlTree.delete(10);
2023-09-22 03:20:33 +00:00
avlTree.isAVLBalanced(); // true
2023-09-20 03:39:24 +00:00
```
2023-08-28 12:04:43 +00:00
### Directed Graph simple snippet
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
#### TS or JS
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```ts
2023-08-28 12:04:43 +00:00
import {DirectedGraph} from 'data-structure-typed';
2023-09-22 03:20:33 +00:00
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
2023-10-28 07:58:48 +00:00
graph.deleteEdgeSrcToDest('A', 'B');
2023-09-22 03:20:33 +00:00
graph.hasEdge('A', 'B'); // false
graph.addVertex('C');
graph.addEdge('A', 'B');
graph.addEdge('B', 'C');
const topologicalOrderIds = graph.topologicalSort(); // ['A', 'B', 'C']
2023-08-28 12:04:43 +00:00
```
### Undirected Graph snippet
2023-09-24 13:31:09 +00:00
2023-08-28 12:04:43 +00:00
#### TS or JS
2023-09-24 13:31:09 +00:00
2023-09-22 03:20:33 +00:00
```ts
2023-08-28 12:04:43 +00:00
import {UndirectedGraph} from 'data-structure-typed';
2023-09-22 03:20:33 +00:00
const graph = new UndirectedGraph();
graph.addVertex('A');
graph.addVertex('B');
graph.addVertex('C');
graph.addVertex('D');
2023-10-28 07:58:48 +00:00
graph.deleteVertex('C');
2023-09-22 03:20:33 +00:00
graph.addEdge('A', 'B');
graph.addEdge('B', 'D');
const dijkstraResult = graph.dijkstra('A');
Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.id) // ['A', 'B', 'D']
2023-08-28 12:04:43 +00:00
```
2023-09-18 14:04:39 +00:00
2023-08-16 16:50:14 +00:00
## Data Structures
2023-09-24 13:31:09 +00:00
2023-08-22 14:50:16 +00:00
< table >
< thead >
< tr >
< th > Data Structure< / th >
< th > Unit Test< / th >
< th > Performance Test< / th >
< th > API Documentation< / th >
< th > Implemented< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > Binary Tree< / td >
2023-09-09 15:49:53 +00:00
< 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 >
2023-08-22 14:50:16 +00:00
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/BinaryTree.html" > < span > Binary Tree< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Binary Search Tree (BST)< / 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/BST.html" > < span > BST< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > AVL Tree< / 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/AVLTree.html" > < span > AVLTree< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Tree Multiset< / 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 >
2023-08-28 10:43:09 +00:00
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/TreeMultiset.html" > < span > TreeMultiset< / span > < / a > < / td >
2023-08-22 14:50:16 +00:00
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Segment Tree< / td >
< td > < / td >
< td > < / td >
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/SegmentTree.html" > < span > SegmentTree< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Binary Indexed Tree< / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< td > < / td >
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/BinaryIndexedTree.html" > < span > BinaryIndexedTree< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Graph< / 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/AbstractGraph.html" > < span > AbstractGraph< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Directed Graph< / 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/DirectedGraph.html" > < span > DirectedGraph< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Undirected Graph< / 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/UndirectedGraph.html" > < span > UndirectedGraph< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Linked List< / 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/SinglyLinkedList.html" > < span > SinglyLinkedList< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Singly Linked List< / 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/SinglyLinkedList.html" > < span > SinglyLinkedList< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Doubly Linked List< / 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/DoublyLinkedList.html" > < span > DoublyLinkedList< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Queue< / 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/Queue.html" > < span > Queue< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Object Deque< / 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/ObjectDeque.html" > < span > ObjectDeque< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Array Deque< / 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/ArrayDeque.html" > < span > ArrayDeque< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Stack< / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< td > < / td >
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/Stack.html" > < span > Stack< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Coordinate Set< / td >
< td > < / td >
< td > < / td >
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/CoordinateSet.html" > < span > CoordinateSet< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Coordinate Map< / td >
< td > < / td >
< td > < / td >
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/CoordinateMap.html" > < span > CoordinateMap< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Heap< / 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/Heap.html" > < span > Heap< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Priority Queue< / 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/PriorityQueue.html" > < span > PriorityQueue< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Max Priority Queue< / 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/MaxPriorityQueue.html" > < span > MaxPriorityQueue< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Min Priority Queue< / 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/MinPriorityQueue.html" > < span > MinPriorityQueue< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< tr >
< td > Trie< / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< td > < / td >
< td > < a href = "https://data-structure-typed-docs.vercel.app/classes/Trie.html" > < span > Trie< / span > < / a > < / td >
< td > < img src = "https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt = "" > < / td >
< / tr >
< / tbody >
< / table >
2023-09-26 09:09:28 +00:00
### Standard library data structure comparison
2023-10-10 09:22:18 +00:00
2023-09-26 09:09:28 +00:00
< table >
< thead >
2023-10-10 09:22:18 +00:00
< tr >
< th > Data Structure Typed< / th >
2023-11-03 17:21:30 +00:00
< th > C++ STL< / th >
2023-10-10 09:22:18 +00:00
< th > java.util< / th >
< th > Python collections< / th >
< / tr >
2023-09-26 09:09:28 +00:00
< / thead >
< tbody >
2023-10-10 09:22:18 +00:00
< tr >
< td > Array< E> < / td >
< td > vector< T> < / td >
< td > ArrayList< E> < / td >
< td > list< / td >
< / tr >
< tr >
< td > DoublyLinkedList< E> < / td >
< td > list< T> < / td >
< td > LinkedList< E> < / td >
< td > deque< / td >
< / tr >
< tr >
< td > SinglyLinkedList< E> < / td >
< td > -< / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > Set< E> < / td >
< td > set< T> < / td >
< td > HashSet< E> < / td >
< td > set< / td >
< / tr >
< tr >
< td > Map< K, V> < / td >
< td > map< K, V> < / td >
< td > HashMap< K, V> < / td >
< td > dict< / td >
< / tr >
< tr >
< td > Map< K, V> < / td >
< td > -< / td >
< td > -< / td >
< td > OrderedDict< / td >
< / tr >
< tr >
< td > Queue< E> < / td >
< td > queue< T> < / td >
< td > Queue< E> < / td >
< td > -< / td >
< / tr >
< tr >
< td > PriorityQueue< E> < / td >
< td > priority_queue< T> < / td >
< td > PriorityQueue< E> < / td >
< td > -< / td >
< / tr >
< tr >
< td > Heap< V> < / td >
< td > priority_queue< T> < / td >
< td > PriorityQueue< E> < / td >
< td > heapq< / td >
< / tr >
< tr >
< td > Stack< E> < / td >
< td > stack< T> < / td >
< td > Stack< E> < / td >
< td > -< / td >
< / tr >
< tr >
< td > Deque< E> < / td >
< td > deque< T> < / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > Trie< / td >
< td > -< / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > HashMap< K, V> < / td >
< td > unordered_map< K, V> < / td >
< td > HashMap< K, V> < / td >
< td > defaultdict< / td >
< / tr >
< tr >
< td > -< / td >
< td > multiset< T> < / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > -< / td >
< td > multimap< K, V> < / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > BinaryTree< K, V> < / td >
< td > -< / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > BST< K, V> < / td >
< td > -< / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > DirectedGraph< V, E> < / td >
< td > -< / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > UndirectedGraph< V, E> < / td >
< td > -< / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > -< / td >
< td > unordered_multiset< / td >
< td > -< / td >
< td > Counter< / td >
< / tr >
< tr >
< td > -< / td >
< td > -< / td >
< td > LinkedHashSet< E> < / td >
< td > -< / td >
< / tr >
< tr >
< td > -< / td >
< td > -< / td >
< td > LinkedHashMap< K, V> < / td >
< td > -< / td >
< / tr >
< tr >
< td > AVLTree< E> < / td >
< td > -< / td >
< td > TreeSet< E> < / td >
< td > -< / td >
< / tr >
< tr >
< td > AVLTree< K, V> < / td >
< td > -< / td >
< td > TreeMap< K, V> < / td >
< td > -< / td >
< / tr >
< tr >
< td > AVLTree< E> < / td >
< td > set< / td >
< td > TreeSet< E> < / td >
< td > -< / td >
< / tr >
< tr >
< td > -< / td >
< td > unordered_multimap< K, V> < / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > -< / td >
< td > bitset< N> < / td >
< td > -< / td >
< td > -< / td >
< / tr >
< tr >
< td > -< / td >
< td > unordered_set< T> < / td >
< td > HashSet< E> < / td >
< td > -< / td >
< / tr >
2023-09-26 09:09:28 +00:00
< / tbody >
< / table >
2023-09-19 09:00:25 +00:00
## Code design
2023-09-24 13:31:09 +00:00
2023-10-21 12:03:54 +00:00
### Adhere to ES6 standard naming conventions for APIs.
Standardize API conventions by using 'add' and 'delete' for element manipulation methods in all data structures.
Opt for concise and clear method names, avoiding excessive length while ensuring explicit intent.
### Object-oriented programming(OOP)
2023-09-24 13:31:09 +00:00
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.
2023-09-19 09:00:25 +00:00
2023-11-02 13:38:10 +00:00
## Benchmark
2023-11-04 02:19:09 +00:00
[//]: # (Start of Replace Section)
2023-11-04 02:00:51 +00:00
< div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > avl-tree< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 10,000 add randomly< / td > < td > 30.18< / td > < td > 33.13< / td > < td > 2.75e-4< / td > < / tr > < tr > < td > 10,000 add & delete randomly< / td > < td > 65.65< / td > < td > 15.23< / td > < td > 0.00< / td > < / tr > < tr > < td > 10,000 addMany< / td > < td > 39.56< / td > < td > 25.28< / td > < td > 3.25e-4< / td > < / tr > < tr > < td > 10,000 get< / td > < td > 26.57< / td > < td > 37.63< / td > < td > 1.92e-4< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > binary-tree< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 1,000 add randomly< / td > < td > 13.00< / td > < td > 76.93< / td > < td > 3.84e-4< / td > < / tr > < tr > < td > 1,000 add & delete randomly< / td > < td > 16.11< / td > < td > 62.06< / td > < td > 3.76e-4< / td > < / tr > < tr > < td > 1,000 addMany< / td > < td > 10.63< / td > < td > 94.04< / td > < td > 1.30e-4< / td > < / tr > < tr > < td > 1,000 get< / td > < td > 18.24< / td > < td > 54.84< / td > < td > 5.04e-4< / td > < / tr > < tr > < td > 1,000 dfs< / td > < td > 69.77< / td > < td > 14.33< / td > < td > 4.07e-4< / td > < / tr > < tr > < td > 1,000 bfs< / td > < td > 54.49< / td > < td > 18.35< / td > < td > 4.96e-4< / td > < / tr > < tr > < td > 1,000 morris< / td > < td > 37.10< / td > < td > 26.96< / td > < td > 2.35e-4< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > bst< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 10,000 add randomly< / td > < td > 31.88< / td > < td > 31.37< / td > < td > 3.10e-4< / td > < / tr > < tr > < td > 10,000 add & delete randomly< / td > < td > 73.08< / td > < td > 13.68< / td > < td > 0.01< / td > < / tr > < tr > < td > 10,000 addMany< / td > < td > 28.80< / td > < td > 34.73< / td > < td > 0.00< / td > < / tr > < tr > < td > 10,000 get< / td > < td > 27.59< / td > < td > 36.25< / td > < td > 2.19e-4< / td > < / tr > < / table > < / div >
2023-11-04 09:28:52 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > rb-tree< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 100,000 add randomly< / td > < td > 70.97< / td > < td > 14.09< / td > < td > 0.00< / td > < / tr > < tr > < td > 100,000 add & 1000 delete randomly< / td > < td > 82.03< / td > < td > 12.19< / td > < td > 0.01< / td > < / tr > < tr > < td > 100,000 getNode< / td > < td > 59.75< / td > < td > 16.74< / td > < td > 0.00< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > directed-graph< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 1,000 addVertex< / td > < td > 0.10< / td > < td > 9894.62< / td > < td > 1.57e-6< / td > < / tr > < tr > < td > 1,000 addEdge< / td > < td > 6.17< / td > < td > 162.15< / td > < td > 0.00< / td > < / tr > < tr > < td > 1,000 getVertex< / td > < td > 0.05< / td > < td > 2.17e+4< / td > < td > 4.06e-7< / td > < / tr > < tr > < td > 1,000 getEdge< / td > < td > 23.50< / td > < td > 42.56< / td > < td > 0.00< / td > < / tr > < tr > < td > tarjan< / td > < td > 223.18< / td > < td > 4.48< / td > < td > 0.01< / td > < / tr > < tr > < td > tarjan all< / td > < td > 226.10< / td > < td > 4.42< / td > < td > 0.01< / td > < / tr > < tr > < td > topologicalSort< / td > < td > 186.20< / td > < td > 5.37< / td > < td > 0.02< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > heap< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 10,000 add & pop< / td > < td > 4.64< / td > < td > 215.30< / td > < td > 4.51e-5< / td > < / tr > < tr > < td > 10,000 fib add & pop< / td > < td > 351.83< / td > < td > 2.84< / td > < td > 0.00< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > doubly-linked-list< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 1,000,000 unshift< / td > < td > 216.19< / td > < td > 4.63< / td > < td > 0.04< / td > < / tr > < tr > < td > 1,000,000 unshift & shift< / td > < td > 164.84< / td > < td > 6.07< / td > < td > 0.02< / td > < / tr > < tr > < td > 1,000,000 insertBefore< / td > < td > 325.14< / td > < td > 3.08< / td > < td > 0.07< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > singly-linked-list< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 10,000 push & pop< / td > < td > 213.24< / td > < td > 4.69< / td > < td > 0.01< / td > < / tr > < tr > < td > 10,000 insertBefore< / td > < td > 247.69< / td > < td > 4.04< / td > < td > 0.01< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > max-priority-queue< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 10,000 refill & poll< / td > < td > 11.50< / td > < td > 86.97< / td > < td > 1.99e-4< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > deque< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 1,000,000 push< / td > < td > 223.30< / td > < td > 4.48< / td > < td > 0.08< / td > < / tr > < tr > < td > 1,000,000 shift< / td > < td > 24.86< / td > < td > 40.23< / td > < td > 0.00< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > queue< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 1,000,000 push< / td > < td > 42.26< / td > < td > 23.66< / td > < td > 0.01< / td > < / tr > < tr > < td > 1,000,000 push & shift< / td > < td > 79.22< / td > < td > 12.62< / td > < td > 0.00< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div > < div class = "json-to-html-collapse clearfix 0" >
< div class = 'collapsible level0' > < span class = 'json-to-html-label' > trie< / span > < / div >
2023-11-05 13:19:59 +00:00
< div class = "content" > < table > < tr > < th > test name< / th > < th > time taken (ms)< / th > < th > executions per sec< / th > < th > sample deviation< / th > < / tr > < tr > < td > 100,000 push< / td > < td > 52.92< / td > < td > 18.90< / td > < td > 0.00< / td > < / tr > < tr > < td > 100,000 getWords< / td > < td > 83.37< / td > < td > 11.99< / td > < td > 0.00< / td > < / tr > < / table > < / div >
2023-11-03 17:21:30 +00:00
< / div >
2023-11-04 02:19:09 +00:00
[//]: # (End of Replace Section)
