# data-structure-typed ![npm](https://img.shields.io/npm/v/data-structure-typed) ![npm](https://img.shields.io/npm/dm/data-structure-typed) ![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/data-structure-typed) ![GitHub top language](https://img.shields.io/github/languages/top/zrwusa/data-structure-typed) ![GITHUB Star](https://img.shields.io/github/stars/zrwusa/data-structure-typed) ![eslint](https://aleen42.github.io/badges/src/eslint.svg) ![NPM](https://img.shields.io/npm/l/data-structure-typed) [//]: # (![npm bundle size](https://img.shields.io/bundlephobia/min/data-structure-typed))

## Why Do you envy C++ with [STL]() (std::), Python with [collections](), and Java with [java.util]() ? Well, no need to envy anymore! JavaScript and TypeScript now have [data-structure-typed]().**`Benchmark`** compared with C++ STL. **`API standards`** aligned with ES6 and Java. **`Usability`** is comparable to Python [//]: # (![Branches](https://img.shields.io/badge/branches-55.47%25-red.svg?style=flat)) [//]: # (![Statements](https://img.shields.io/badge/statements-67%25-red.svg?style=flat)) [//]: # (![Functions](https://img.shields.io/badge/functions-66.38%25-red.svg?style=flat)) [//]: # (![Lines](https://img.shields.io/badge/lines-68.6%25-red.svg?style=flat)) ### We provide data structures that are not available in JS/TS Heap, Binary Tree, RedBlack Tree, Linked List, Deque, Trie, Directed Graph, Undirected Graph, BST, AVL Tree, Priority Queue, Queue, Tree Multiset, Linked List. ### Performance surpasses that of native JS/TS

Method	Time Taken (ms)	Scale	Belongs To
Queue.push & shift	5.83	100,000	data-structure-typed
Array.push & shift	2829.59	100,000	Native JS
Deque.unshift & shift	2.44	100,000	data-structure-typed
Array.unshift & shift	4750.37	100,000	Native JS
HashMap.set	122.51	1,000,000	data-structure-typed
Map.set	223.80	1,000,000	Native JS
Set.add	185.06	1,000,000	Native JS

## Installation and Usage Now you can use it in Node.js and browser environments CommonJS:**`require export.modules =`** ESModule: **`import export`** Typescript: **`import export`** UMD: **`var Deque = dataStructureTyped.Deque`** ### npm ```bash npm i data-structure-typed --save ``` ### yarn ```bash yarn add data-structure-typed ``` ```js import { BinaryTree, Graph, Queue, Stack, PriorityQueue, BST, Trie, DoublyLinkedList, AVLTree, MinHeap, SinglyLinkedList, DirectedGraph, TreeMultimap, DirectedVertex, AVLTreeNode } from 'data-structure-typed'; ``` ### CDN Copy the line below into the head tag in an HTML document. #### development ```html ``` #### production ```html ``` Copy the code below into the script tag of your HTML, and you're good to go with your development. ```js const {Heap} = dataStructureTyped; const { BinaryTree, Graph, Queue, Stack, PriorityQueue, BST, Trie, DoublyLinkedList, AVLTree, MinHeap, SinglyLinkedList, DirectedGraph, TreeMultimap, DirectedVertex, AVLTreeNode } = dataStructureTyped; ``` ## Vivid Examples ### Binary Tree [Try it out](https://vivid-algorithm.vercel.app/), or you can run your own code using our [visual tool](https://github.com/zrwusa/vivid-algorithm) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/binary-tree-array-to-binary-tree.webp) ### Binary Tree DFS [Try it out](https://vivid-algorithm.vercel.app/) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/binary-tree-dfs-in-order.webp) ### AVL Tree [Try it out](https://vivid-algorithm.vercel.app/) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/avl-tree-test.webp) ### Tree Multi Map [Try it out](https://vivid-algorithm.vercel.app/) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/tree-multiset-test.webp) ### Matrix [Try it out](https://vivid-algorithm.vercel.app/algorithm/graph/) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/matrix-cut-off-tree-for-golf.webp) ### Directed Graph [Try it out](https://vivid-algorithm.vercel.app/algorithm/graph/) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/directed-graph-test.webp) ### Map Graph [Try it out](https://vivid-algorithm.vercel.app/algorithm/graph/) ![](https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/examples/videos/webp_output/map-graph-test.webp) ## Code Snippets ### RedBlackTree snippet #### TS ```ts import {RedBlackTree} from 'data-structure-typed'; const rbTree = new RedBlackTree(); rbTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]) rbTree.isAVLBalanced(); // true rbTree.delete(10); rbTree.isAVLBalanced(); // true rbTree.print() // ___6________ // / \ // ___4_ ___11________ // / \ / \ // _2_ 5 _8_ ____14__ // / \ / \ / \ // 1 3 7 9 12__ 15__ // \ \ // 13 16 ``` #### JS ```js import {RedBlackTree} from 'data-structure-typed'; const rbTree = new RedBlackTree(); rbTree.addMany([11, 3, 15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5]) rbTree.isAVLBalanced(); // true rbTree.delete(10); rbTree.isAVLBalanced(); // true rbTree.print() // ___6________ // / \ // ___4_ ___11________ // / \ / \ // _2_ 5 _8_ ____14__ // / \ / \ / \ // 1 3 7 9 12__ 15__ // \ \ // 13 16 ``` ### Binary Search Tree (BST) snippet ```ts 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.getNode(6); // BSTNode bst.getHeight(6) === 2; // true bst.getHeight() === 5; // true bst.getDepth(6) === 3; // true bst.getLeftMost()?.key === 1; // true bst.delete(6); bst.get(6); // undefined bst.isAVLBalanced(); // true bst.bfs()[0] === 11; // true bst.print() // ______________11_____ // / \ // ___3_______ _13_____ // / \ / \ // 1_ _____8____ 12 _15__ // \ / \ / \ // 2 4_ _10 14 16 // \ / // 5_ 9 // \ // 7 const objBST = new BST(); objBST.add(11, { "name": "Pablo", "age": 15 }); objBST.add(3, { "name": "Kirk", "age": 1 }); objBST.addMany([15, 1, 8, 13, 16, 2, 6, 9, 12, 14, 4, 7, 10, 5], [ { "name": "Alice", "age": 15 }, { "name": "Bob", "age": 1 }, { "name": "Charlie", "age": 8 }, { "name": "David", "age": 13 }, { "name": "Emma", "age": 16 }, { "name": "Frank", "age": 2 }, { "name": "Grace", "age": 6 }, { "name": "Hannah", "age": 9 }, { "name": "Isaac", "age": 12 }, { "name": "Jack", "age": 14 }, { "name": "Katie", "age": 4 }, { "name": "Liam", "age": 7 }, { "name": "Mia", "age": 10 }, { "name": "Noah", "age": 5 } ] ); objBST.delete(11); ``` ### AVLTree snippet ```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 avlTree.delete(10); avlTree.isAVLBalanced(); // true ``` ### Directed Graph simple snippet ```ts 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.deleteEdgeSrcToDest('A', 'B'); graph.hasEdge('A', 'B'); // false graph.addVertex('C'); graph.addEdge('A', 'B'); graph.addEdge('B', 'C'); const topologicalOrderKeys = graph.topologicalSort(); // ['A', 'B', 'C'] ``` ### Undirected Graph snippet ```ts import {UndirectedGraph} from 'data-structure-typed'; const graph = new UndirectedGraph(); graph.addVertex('A'); graph.addVertex('B'); graph.addVertex('C'); graph.addVertex('D'); graph.deleteVertex('C'); graph.addEdge('A', 'B'); graph.addEdge('B', 'D'); const dijkstraResult = graph.dijkstra('A'); Array.from(dijkstraResult?.seen ?? []).map(vertex => vertex.key) // ['A', 'B', 'D'] ``` ### Free conversion between data structures. ```js const orgArr = [6, 1, 2, 7, 5, 3, 4, 9, 8]; const orgStrArr = ["trie", "trial", "trick", "trip", "tree", "trend", "triangle", "track", "trace", "transmit"]; const entries = [[6, 6], [1, 1], [2, 2], [7, 7], [5, 5], [3, 3], [4, 4], [9, 9], [8, 8]]; const queue = new Queue(orgArr); queue.print(); // [6, 1, 2, 7, 5, 3, 4, 9, 8] const deque = new Deque(orgArr); deque.print(); // [6, 1, 2, 7, 5, 3, 4, 9, 8] const sList = new SinglyLinkedList(orgArr); sList.print(); // [6, 1, 2, 7, 5, 3, 4, 9, 8] const dList = new DoublyLinkedList(orgArr); dList.print(); // [6, 1, 2, 7, 5, 3, 4, 9, 8] const stack = new Stack(orgArr); stack.print(); // [6, 1, 2, 7, 5, 3, 4, 9, 8] const minHeap = new MinHeap(orgArr); minHeap.print(); // [1, 5, 2, 7, 6, 3, 4, 9, 8] const maxPQ = new MaxPriorityQueue(orgArr); maxPQ.print(); // [9, 8, 4, 7, 5, 2, 3, 1, 6] const biTree = new BinaryTree(entries); biTree.print(); // ___6___ // / \ // ___1_ _2_ // / \ / \ // _7_ 5 3 4 // / \ // 9 8 const bst = new BST(entries); bst.print(); // _____5___ // / \ // _2_ _7_ // / \ / \ // 1 3_ 6 8_ // \ \ // 4 9 const rbTree = new RedBlackTree(entries); rbTree.print(); // ___4___ // / \ // _2_ _6___ // / \ / \ // 1 3 5 _8_ // / \ // 7 9 const avl = new AVLTree(entries); avl.print(); // ___4___ // / \ // _2_ _6___ // / \ / \ // 1 3 5 _8_ // / \ // 7 9 const treeMulti = new TreeMultimap(entries); treeMulti.print(); // ___4___ // / \ // _2_ _6___ // / \ / \ // 1 3 5 _8_ // / \ // 7 9 const hm = new HashMap(entries); hm.print() // [[6, 6], [1, 1], [2, 2], [7, 7], [5, 5], [3, 3], [4, 4], [9, 9], [8, 8]] const rbTreeH = new RedBlackTree(hm); rbTreeH.print(); // ___4___ // / \ // _2_ _6___ // / \ / \ // 1 3 5 _8_ // / \ // 7 9 const pq = new MinPriorityQueue(orgArr); pq.print(); // [1, 5, 2, 7, 6, 3, 4, 9, 8] const bst1 = new BST(pq); bst1.print(); // _____5___ // / \ // _2_ _7_ // / \ / \ // 1 3_ 6 8_ // \ \ // 4 9 const dq1 = new Deque(orgArr); dq1.print(); // [6, 1, 2, 7, 5, 3, 4, 9, 8] const rbTree1 = new RedBlackTree(dq1); rbTree1.print(); // _____5___ // / \ // _2___ _7___ // / \ / \ // 1 _4 6 _9 // / / // 3 8 const trie2 = new Trie(orgStrArr); trie2.print(); // ['trie', 'trial', 'triangle', 'trick', 'trip', 'tree', 'trend', 'track', 'trace', 'transmit'] const heap2 = new Heap(trie2, { comparator: (a, b) => Number(a) - Number(b) }); heap2.print(); // ['transmit', 'trace', 'tree', 'trend', 'track', 'trial', 'trip', 'trie', 'trick', 'triangle'] const dq2 = new Deque(heap2); dq2.print(); // ['transmit', 'trace', 'tree', 'trend', 'track', 'trial', 'trip', 'trie', 'trick', 'triangle'] const entries2 = dq2.map((el, i) => [i, el]); const avl2 = new AVLTree(entries2); avl2.print(); // ___3_______ // / \ // _1_ ___7_ // / \ / \ // 0 2 _5_ 8_ // / \ \ // 4 6 9 ``` ## API docs & Examples [API Docs](https://data-structure-typed-docs.vercel.app) [Live Examples](https://vivid-algorithm.vercel.app) Examples Repository ## Data Structures

Data Structure	Unit Test	Performance Test	API Docs
Binary Tree			View
Binary Search Tree (BST)			View
AVL Tree			View
Red Black Tree			View
Tree Multimap			View
Heap			View
Priority Queue			View
Max Priority Queue			View
Min Priority Queue			View
Trie			View
Graph			View
Directed Graph			View
Undirected Graph			View
Queue			View
Deque			View
Hash Map			View
Linked List			View
Singly Linked List			View
Doubly Linked List			View
Stack			View
Segment Tree			View
Binary Indexed Tree			View

## The corresponding relationships between data structures in different language standard libraries.

Data Structure Typed	C++ STL	java.util	Python collections
Heap<E>	-	-	heapq
PriorityQueue<E>	priority_queue<T>	PriorityQueue<E>	-
Deque<E>	deque<T>	ArrayDeque<E>	deque
Queue<E>	queue<T>	Queue<E>	-
HashMap<K, V>	unordered_map<K, V>	HashMap<K, V>	defaultdict
DoublyLinkedList<E>	list<T>	LinkedList<E>	-
SinglyLinkedList<E>	-	-	-
BinaryTree<K, V>	-	-	-
BST<K, V>	-	-	-
RedBlackTree<E>	set<T>	TreeSet<E>	-
RedBlackTree<K, V>	map<K, V>	TreeMap<K, V>	-
TreeMultimap<K, V>	multimap<K, V>	-	-
TreeMultimap<E>	multiset<T>	-	-
Trie	-	-	-
DirectedGraph<V, E>	-	-	-
UndirectedGraph<V, E>	-	-	-
PriorityQueue<E>	priority_queue<T>	PriorityQueue<E>	-
Array<E>	vector<T>	ArrayList<E>	list
Stack<E>	stack<T>	Stack<E>	-
HashMap<E>	unordered_set<T>	HashSet<E>	set
-	unordered_multiset	-	Counter
LinkedHashMap<K, V>	-	LinkedHashMap<K, V>	OrderedDict
-	unordered_multimap<K, V>	-	-
-	bitset<N>	-	-

## Built-in classic algorithms

Algorithm	Function Description	Iteration Type
Binary Tree DFS	Traverse a binary tree in a depth-first manner, starting from the root node, first visiting the left subtree, and then the right subtree, using recursion.	Recursion + Iteration
Binary Tree BFS	Traverse a binary tree in a breadth-first manner, starting from the root node, visiting nodes level by level from left to right.	Iteration
Graph DFS	Traverse a graph in a depth-first manner, starting from a given node, exploring along one path as deeply as possible, and backtracking to explore other paths. Used for finding connected components, paths, etc.	Recursion + Iteration
Binary Tree Morris	Morris traversal is an in-order traversal algorithm for binary trees with O(1) space complexity. It allows tree traversal without additional stack or recursion.	Iteration
Graph BFS	Traverse a graph in a breadth-first manner, starting from a given node, first visiting nodes directly connected to the starting node, and then expanding level by level. Used for finding shortest paths, etc.	Recursion + Iteration
Graph Tarjan's Algorithm	Find strongly connected components in a graph, typically implemented using depth-first search.	Recursion
Graph Bellman-Ford Algorithm	Finding the shortest paths from a single source, can handle negative weight edges	Iteration
Graph Dijkstra's Algorithm	Finding the shortest paths from a single source, cannot handle negative weight edges	Iteration
Graph Floyd-Warshall Algorithm	Finding the shortest paths between all pairs of nodes	Iteration
Graph getCycles	Find all cycles in a graph or detect the presence of cycles.	Recursion
Graph getCutVertexes	Find cut vertices in a graph, which are nodes that, when removed, increase the number of connected components in the graph.	Recursion
Graph getSCCs	Find strongly connected components in a graph, which are subgraphs where any two nodes can reach each other.	Recursion
Graph getBridges	Find bridges in a graph, which are edges that, when removed, increase the number of connected components in the graph.	Recursion
Graph topologicalSort	Perform topological sorting on a directed acyclic graph (DAG) to find a linear order of nodes such that all directed edges go from earlier nodes to later nodes.	Recursion

## Software Engineering Design Standards

Principle	Description
Practicality	Follows ES6 and ESNext standards, offering unified and considerate optional parameters, and simplifies method names.
Extensibility	Adheres to OOP (Object-Oriented Programming) principles, allowing inheritance for all data structures.
Modularization	Includes data structure modularization and independent NPM packages.
Efficiency	All methods provide time and space complexity, comparable to native JS performance.
Maintainability	Follows open-source community development standards, complete documentation, continuous integration, and adheres to TDD (Test-Driven Development) patterns.
Testability	Automated and customized unit testing, performance testing, and integration testing.
Portability	Plans for porting to Java, Python, and C++, currently achieved to 80%.
Reusability	Fully decoupled, minimized side effects, and adheres to OOP.
Security	Carefully designed security for member variables and methods. Read-write separation. Data structure software does not need to consider other security aspects.
Scalability	Data structure software does not involve load issues.

## Benchmark [//]: # (No deletion!!! Start of Replace Section)

avl-tree

test name	time taken (ms)	executions per sec	sample deviation
10,000 add randomly	48.42	20.65	0.00
10,000 add & delete randomly	107.72	9.28	0.02
10,000 addMany	55.40	18.05	6.22e-4
10,000 get	53.89	18.56	0.02

binary-tree

test name	time taken (ms)	executions per sec	sample deviation
1,000 add randomly	17.75	56.35	2.23e-4
1,000 add & delete randomly	25.58	39.10	0.01
1,000 addMany	19.65	50.89	0.00
1,000 get	21.03	47.55	0.01
1,000 has	19.81	50.48	0.01
1,000 dfs	183.37	5.45	0.03
1,000 bfs	65.61	15.24	0.02
1,000 morris	231.00	4.33	0.06

bst

test name	time taken (ms)	executions per sec	sample deviation
10,000 add randomly	49.96	20.02	7.65e-4
10,000 add & delete randomly	116.77	8.56	0.02
10,000 addMany	49.06	20.38	0.01
10,000 get	49.06	20.38	7.13e-4

rb-tree

test name	time taken (ms)	executions per sec	sample deviation
100,000 add	83.42	11.99	0.01
100,000 add & delete randomly	243.05	4.11	0.07
100,000 getNode	218.87	4.57	0.05
100,000 add & iterator	124.22	8.05	0.01

comparison

test name	time taken (ms)	executions per sec	sample deviation
SRC PQ 10,000 add	0.15	6710.40	1.90e-5
CJS PQ 10,000 add	0.16	6407.42	4.25e-5
MJS PQ 10,000 add	0.62	1602.37	1.51e-4
SRC PQ 10,000 add & poll	3.67	272.42	0.00
CJS PQ 10,000 add & poll	3.95	252.90	0.00
MJS PQ 10,000 add & poll	3.33	300.28	8.65e-5

directed-graph

test name	time taken (ms)	executions per sec	sample deviation
1,000 addVertex	0.11	8958.10	3.30e-5
1,000 addEdge	6.37	156.98	1.96e-4
1,000 getVertex	0.05	2.04e+4	8.22e-6
1,000 getEdge	24.49	40.83	0.00
tarjan	235.54	4.25	0.04
tarjan all	6766.74	0.15	0.32
topologicalSort	197.52	5.06	0.04

hash-map

test name	time taken (ms)	executions per sec	sample deviation
1,000,000 set	117.82	8.49	0.05
Native Map 1,000,000 set	220.92	4.53	0.03
Native Set 1,000,000 add	187.44	5.34	0.02
1,000,000 set & get	125.44	7.97	0.04
Native Map 1,000,000 set & get	300.10	3.33	0.06
Native Set 1,000,000 add & has	200.88	4.98	0.02
1,000,000 ObjKey set & get	361.00	2.77	0.06
Native Map 1,000,000 ObjKey set & get	335.34	2.98	0.09
Native Set 1,000,000 ObjKey add & has	261.28	3.83	0.07

heap

test name	time taken (ms)	executions per sec	sample deviation
100,000 add & poll	80.43	12.43	0.00
100,000 add & dfs	36.95	27.07	0.00
10,000 fib add & pop	386.63	2.59	0.05

doubly-linked-list

test name	time taken (ms)	executions per sec	sample deviation
1,000,000 push	235.15	4.25	0.07
1,000,000 unshift	245.36	4.08	0.08
1,000,000 unshift & shift	175.53	5.70	0.03
1,000,000 addBefore	319.21	3.13	0.06

singly-linked-list

test name	time taken (ms)	executions per sec	sample deviation
1,000,000 push & shift	202.02	4.95	0.04
10,000 push & pop	228.77	4.37	0.04
10,000 addBefore	274.25	3.65	0.05

max-priority-queue

test name	time taken (ms)	executions per sec	sample deviation
10,000 refill & poll	9.39	106.51	0.00

priority-queue

test name	time taken (ms)	executions per sec	sample deviation
100,000 add & poll	114.36	8.74	0.02

deque

test name	time taken (ms)	executions per sec	sample deviation
1,000,000 push	14.81	67.51	0.00
1,000,000 push & pop	25.34	39.47	0.01
100,000 push & shift	2.49	400.86	7.97e-4
Native Array 100,000 push & shift	2390.92	0.42	0.17
100,000 unshift & shift	2.48	403.14	6.46e-4
Native Array 100,000 unshift & shift	4462.41	0.22	0.34

queue

test name	time taken (ms)	executions per sec	sample deviation
1,000,000 push	51.99	19.24	0.03
100,000 push & shift	5.23	191.34	7.00e-4
Native Array 100,000 push & shift	2400.96	0.42	0.28
Native Array 100,000 push & pop	4.36	229.52	1.14e-4

stack

test name	time taken (ms)	executions per sec	sample deviation
1,000,000 push	43.55	22.96	0.01
1,000,000 push & pop	55.29	18.09	0.01

trie

test name	time taken (ms)	executions per sec	sample deviation
100,000 push	48.66	20.55	0.00
100,000 getWords	95.09	10.52	0.01

[//]: # (No deletion!!! End of Replace Section)