Data Structure Typed
Data Structures of Javascript & TypeScript.
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.
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)
Built-in classic algorithms
DFS(Depth-First Search), DFSIterative, BFS(Breadth-First Search), morris, Bellman-Ford Algorithm, Dijkstra's Algorithm,
Floyd-Warshall Algorithm, Tarjan's Algorithm.
Installation and Usage
npm
npm i data-structure-typed --save
yarn
yarn add data-structure-typed
import {
BinaryTree , Graph , Queue , Stack , PriorityQueue , BST , Trie , DoublyLinkedList ,
AVLTree , MinHeap , SinglyLinkedList , DirectedGraph , TreeMultiset ,
DirectedVertex , AVLTreeNode
} from 'data-structure-typed' ;
CDN
< script src = 'https://cdn.jsdelivr.net/npm/data-structure-typed/dist/umd/data-structure-typed.min.js' ></ script >
const { Heap } = dataStructureTyped ;
const {
BinaryTree , Graph , Queue , Stack , PriorityQueue , BST , Trie , DoublyLinkedList ,
AVLTree , MinHeap , SinglyLinkedList , DirectedGraph , TreeMultiset ,
DirectedVertex , AVLTreeNode
} = dataStructureTyped ;
API docs & Examples
API Docs
Live Examples
Examples Repository
Code Snippet
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 . get ( 6 ); // BSTNode
bst . getHeight ( 6 ) === 2 ; // true
bst . getHeight () === 5 ; // true
bst . getDepth ( 6 ) === 3 ; // true
bst . getLeftMost () ? . id === 1 ; // true
bst . delete ( 6 );
bst . get ( 6 ); // null
bst . isAVLBalanced (); // true
bst . bfs ()[ 0 ] === 11 ; // true
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 . delete ( 11 );
JS
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 . delete ( 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 . delete ( 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 . delete ( 10 );
avlTree . isAVLBalanced (); // true
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
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
avlTree . delete ( 10 );
avlTree . isAVLBalanced (); // true
Directed Graph simple snippet
TS or JS
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 topologicalOrderIds = graph . topologicalSort (); // ['A', 'B', 'C']
Undirected Graph snippet
TS or JS
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 . id ) // ['A', 'B', 'D']
Data Structures
Standard library data structure comparison
Data Structure Typed
C++ STL
java.util
Python collections
Array<E>
vector<T>
ArrayList<E>
list
DoublyLinkedList<E>
list<T>
LinkedList<E>
deque
SinglyLinkedList<E>
-
-
-
Set<E>
set<T>
HashSet<E>
set
Map<K, V>
map<K, V>
HashMap<K, V>
dict
Map<K, V>
-
-
OrderedDict
Queue<E>
queue<T>
Queue<E>
-
PriorityQueue<E>
priority_queue<T>
PriorityQueue<E>
-
Heap<V>
priority_queue<T>
PriorityQueue<E>
heapq
Stack<E>
stack<T>
Stack<E>
-
Deque<E>
deque<T>
-
-
Trie
-
-
-
HashMap<K, V>
unordered_map<K, V>
HashMap<K, V>
defaultdict
-
multiset<T>
-
-
-
multimap<K, V>
-
-
BinaryTree<K, V>
-
-
-
BST<K, V>
-
-
-
DirectedGraph<V, E>
-
-
-
UndirectedGraph<V, E>
-
-
-
-
unordered_multiset
-
Counter
-
-
LinkedHashSet<E>
-
-
-
LinkedHashMap<K, V>
-
AVLTree<E>
-
TreeSet<E>
-
AVLTree<K, V>
-
TreeMap<K, V>
-
AVLTree<E>
set
TreeSet<E>
-
-
unordered_multimap<K, V>
-
-
-
bitset<N>
-
-
-
unordered_set<T>
HashSet<E>
-
Code design
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)
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.
Benchmark
avl-tree
test name time taken (ms) executions per sec sample deviation 10,000 add randomly 30.33 32.97 3.56e-4 10,000 add & delete randomly 66.10 15.13 0.00 10,000 addMany 39.44 25.35 3.62e-4 10,000 get 27.06 36.96 2.52e-4
binary-tree
test name time taken (ms) executions per sec sample deviation 1,000 add randomly 12.90 77.52 1.09e-4 1,000 add & delete randomly 16.13 61.99 1.61e-4 1,000 addMany 10.74 93.09 1.00e-4 1,000 get 18.09 55.28 1.90e-4 1,000 dfs 71.12 14.06 7.83e-4 1,000 bfs 57.24 17.47 4.17e-4 1,000 morris 37.29 26.81 3.77e-4
bst
test name time taken (ms) executions per sec sample deviation 10,000 add randomly 31.58 31.67 0.00 10,000 add & delete randomly 71.09 14.07 8.99e-4 10,000 addMany 29.68 33.69 0.00 10,000 get 28.55 35.03 0.00
rb-tree
test name time taken (ms) executions per sec sample deviation 100,000 add randomly 84.64 11.82 0.01 100,000 add & 1000 delete randomly 81.32 12.30 0.01 100,000 getNode 61.18 16.35 0.00
directed-graph
test name time taken (ms) executions per sec sample deviation 1,000 addVertex 0.10 9637.47 3.79e-6 1,000 addEdge 6.09 164.18 1.31e-4 1,000 getVertex 0.05 2.14e+4 1.35e-6 1,000 getEdge 23.91 41.82 0.01 tarjan 218.65 4.57 0.01 tarjan all 221.67 4.51 0.00 topologicalSort 184.34 5.42 0.02
heap
test name time taken (ms) executions per sec sample deviation 10,000 add & pop 4.63 215.77 4.49e-5 10,000 fib add & pop 355.19 2.82 0.00
doubly-linked-list
test name time taken (ms) executions per sec sample deviation 1,000,000 unshift 213.53 4.68 0.02 1,000,000 unshift & shift 162.97 6.14 0.02 1,000,000 insertBefore 335.19 2.98 0.09
singly-linked-list
test name time taken (ms) executions per sec sample deviation 10,000 push & pop 231.35 4.32 0.02 10,000 insertBefore 251.49 3.98 0.01
max-priority-queue
test name time taken (ms) executions per sec sample deviation 10,000 refill & poll 11.48 87.14 1.91e-4
deque
test name time taken (ms) executions per sec sample deviation 1,000,000 push 215.14 4.65 0.05 1,000,000 shift 25.15 39.76 0.00
queue
test name time taken (ms) executions per sec sample deviation 1,000,000 push 44.15 22.65 0.01 1,000,000 push & shift 80.87 12.37 0.00
trie
test name time taken (ms) executions per sec sample deviation 100,000 push 61.38 16.29 0.01 100,000 getWords 104.27 9.59 0.02