Find a file
2024-09-19 17:20:58 +12:00
.github Update issue templates 2024-01-08 21:48:29 +08:00
scripts chore: loop to check if remote package is exist 2024-09-03 09:28:46 +12:00
src style: optimization of code style of HashMap 2024-09-19 17:20:58 +12:00
test fix(trie): trie returns invalid string when only the fist character matches, and the second doesn't match 2024-09-03 00:49:53 +09:00
.auto-changelog [project] quality of package improved. v1.3.6 published 2023-09-21 14:40:39 +08:00
.auto-changelog-template.hbs [project] quality of package improved. v1.3.6 published 2023-09-21 14:40:39 +08:00
.dependency-cruiser.js refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
.editorconfig refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
.eslintrc.js style: Change ESLint configuration from error type to warning type. Format the code. 2023-11-16 11:55:40 +08:00
.gitattributes test coverage report supported. Code quality enhanced and support multiple environments such as ES6 (ESModule), ES5 (CommonJS), and a single file for both browser and Node.js environments (UMD). Supported for source maps. CODE-OF-CONDUCT.md, COMMANDS.md, SECURITY.md, .gitattributes added. 2023-09-22 00:53:34 +08:00
.gitignore [benchmark] generated a performance testing report. 2023-11-02 09:24:06 +08:00
.npmignore [test] test coverage enriched to 90.37% 2023-10-29 21:52:27 +08:00
.npmrc [pkg] ci to publish 2023-09-26 20:21:20 +08:00
.prettierignore feat: Replace the AVLTree with a Red-Black Tree to implement TreeMultiMap, preserving the implementation of TreeMultiMap using AVLTree and renaming it as AVLTreeMultiMap. 2024-01-08 22:22:41 +08:00
.prettierrc.js style: Prettier version updated. Code style adhered to Prettier strictly. 2024-08-27 10:56:04 +12:00
.travis.yml [project] Integrate the CI commands into a single command and uniformly invoke this CI command across different platforms. 2023-10-18 16:05:55 +08:00
CHANGELOG.md release: v1.52.3 2024-09-03 10:22:22 +12:00
CODE_OF_CONDUCT.md refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
COMMANDS.md refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
CONTRIBUTING.md refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
jest.config.js refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
jest.integration.config.js [project] Decouple integration testing from the CI workflow. 2023-11-01 18:19:49 +08:00
LICENSE [BinaryTree] isMergeDuplicatedNodeById removed, [MapGraph] MapGraph added 2023-09-07 21:00:22 +08:00
package-lock.json release: v1.52.3 2024-09-03 10:22:22 +12:00
package.json release: v1.52.3 2024-09-03 10:22:22 +12:00
POSTS_zh-CN.md feat: Restore the TreeNode data structure. Add number utilities to the utils module. docs: Update POSTS_zh-CN.md. 2024-01-17 22:27:38 +08:00
README.md style: Prettier version updated. Code style adhered to Prettier strictly. 2024-08-27 10:56:04 +12:00
README_zh-CN.md feat: Replace the AVLTree with a Red-Black Tree to implement TreeMultiMap, preserving the implementation of TreeMultiMap using AVLTree and renaming it as AVLTreeMultiMap. 2024-01-08 22:22:41 +08:00
SECURITY.md refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
SPECIFICATION.md Refactor: Standardize addition and removal methods for all sequential data structures to push, pop, shift, unshift. 2024-01-09 12:04:50 +08:00
SPECIFICATION_zh-CN.md Refactor: Standardize addition and removal methods for all sequential data structures to push, pop, shift, unshift. 2024-01-09 12:04:50 +08:00
SPONSOR.md refactor: Directly constrain the methods clear, map, and filter in the base class. 2024-01-06 17:50:00 +08:00
SPONSOR_zh-CN.md Refactor: Standardize addition and removal methods for all sequential data structures to push, pop, shift, unshift. 2024-01-09 12:04:50 +08:00
tsconfig-base.json Refactor: All binary tree data structures now support the toEntryFn for extracting key and value from raw data at once, avoiding users from having to traverse data multiple times, thus improving performance. Chore: Explicitly use the override keyword. 2024-01-26 18:20:15 +08:00
tsconfig-cjs.json refactor: Explicitly call the super.addMany method. chore: reformat project configs 2023-11-25 20:59:34 +08:00
tsconfig-mjs.json chore: Correct the packaging configuration files of different modules. 2023-11-13 23:51:43 +08:00
tsconfig.json fix: Implemented a high-performance HashMap comparable to the native Map. All test cases are standardized using 'it' instead of 'test'. Enabled tsconfig's sourceMap configuration for correct line numbers in IDE testing. 2023-11-15 23:17:55 +08:00
tsup.config.js chore: To avoid sacrificing performance, UMD modules use ES6 style. 2023-11-20 19:24:53 +08:00
typedoc.json refactor: Remove the _addTo method from BinaryTree and TreeMultiMap. 2023-12-22 19:59:38 +08:00

data-structure-typed

npm GitHub contributors npm package minimized gzipped size (select exports) GitHub top language GITHUB Star eslint NPM npm

Installation and Usage

npm

npm i data-structure-typed --save

yarn

yarn add data-structure-typed
import {
  Heap, Graph, Queue, Deque, PriorityQueue, BST, Trie, DoublyLinkedList,
  AVLTree, SinglyLinkedList, DirectedGraph, RedBlackTree, TreeMultiMap,
  DirectedVertex, Stack, AVLTreeNode
} from 'data-structure-typed';

If you only want to use a specific data structure independently, you can install it separately, for example, by running

npm i heap-typed --save

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

Performance

Performance surpasses that of native JS/TS

Method Time Taken Data Scale Belongs To big O
Queue.push & shift 5.83 ms 100K Ours O(1)
Array.push & shift 2829.59 ms 100K Native JS O(n)
Deque.unshift & shift 2.44 ms 100K Ours O(1)
Array.unshift & shift 4750.37 ms 100K Native JS O(n)
HashMap.set 122.51 ms 1M Ours O(1)
Map.set 223.80 ms 1M Native JS O(1)
Set.add 185.06 ms 1M Native JS O(1)

Plain language explanations

Data Structure Plain Language Definition Diagram
Linked List (Singly Linked List) A line of bunnies, where each bunny holds the tail of the bunny in front of it (each bunny only knows the name of the bunny behind it). You want to find a bunny named Pablo, and you have to start searching from the first bunny. If it's not Pablo, you continue following that bunny's tail to the next one. So, you might need to search n times to find Pablo (O(n) time complexity). If you want to insert a bunny named Remi between Pablo and Vicky, it's very simple. You just need to let Vicky release Pablo's tail, let Remi hold Pablo's tail, and then let Vicky hold Remi's tail (O(1) time complexity). singly linked list
Array A line of numbered bunnies. If you want to find the bunny named Pablo, you can directly shout out Pablo's number 0680 (finding the element directly through array indexing, O(1) time complexity). However, if you don't know Pablo's number, you still need to search one by one (O(n) time complexity). Moreover, if you want to add a bunny named Vicky behind Pablo, you will need to renumber all the bunnies after Vicky (O(n) time complexity). array
Queue A line of numbered bunnies with a sticky note on the first bunny. For this line with a sticky note on the first bunny, whenever we want to remove a bunny from the front of the line, we only need to move the sticky note to the face of the next bunny without actually removing the bunny to avoid renumbering all the bunnies behind (removing from the front is also O(1) time complexity). For the tail of the line, we don't need to worry because each new bunny added to the tail is directly given a new number (O(1) time complexity) without needing to renumber all the previous bunnies. queue
Deque A line of grouped, numbered bunnies with a sticky note on the first bunny. For this line, we manage it by groups. Each time we remove a bunny from the front of the line, we only move the sticky note to the next bunny. This way, we don't need to renumber all the bunnies behind the first bunny each time a bunny is removed. Only when all members of a group are removed do we reassign numbers and regroup. The tail is handled similarly. This is a strategy of delaying and batching operations to offset the drawbacks of the Array data structure that requires moving all elements behind when inserting or deleting elements in the middle. deque
Doubly Linked List A line of bunnies where each bunny holds the tail of the bunny in front (each bunny knows the names of the two adjacent bunnies). This provides the Singly Linked List the ability to search forward, and that's all. For example, if you directly come to the bunny Remi in the line and ask her where Vicky is, she will say the one holding my tail behind me, and if you ask her where Pablo is, she will say right in front. doubly linked list
Stack A line of bunnies in a dead-end tunnel, where bunnies can only be removed from the tunnel entrance (end), and new bunnies can only be added at the entrance (end) as well. stack
Binary Tree As the name suggests, it's a tree where each node has at most two children. When you add consecutive data such as [4, 2, 6, 1, 3, 5, 7], it will be a complete binary tree. When you add data like [4, 2, 6, null, 1, 3, null, 5, null, 7], you can specify whether any left or right child node is null, and the shape of the tree is fully controllable. binary tree
Binary Search Tree (BST) A tree-like rabbit colony composed of doubly linked lists where each rabbit has at most two tails. These rabbits are disciplined and obedient, arranged in their positions according to a certain order. The most important data structure in a binary tree (the core is that the time complexity for insertion, deletion, modification, and search is O(log n)). The data stored in a BST is structured and ordered, not in strict order like 1, 2, 3, 4, 5, but maintaining that all nodes in the left subtree are less than the node, and all nodes in the right subtree are greater than the node. This order provides O(log n) time complexity for insertion, deletion, modification, and search. Reducing O(n) to O(log n) is the most common algorithm complexity optimization in the computer field, an exponential improvement in efficiency. It's also the most efficient way to organize unordered data into ordered data (most sorting algorithms only maintain O(n log n)). Of course, the binary search trees we provide support organizing data in both ascending and descending order. Remember that basic BSTs do not have self-balancing capabilities, and if you sequentially add sorted data to this data structure, it will degrade into a list, thus losing the O(log n) capability. Of course, our addMany method is specially handled to prevent degradation. However, for practical applications, please use Red-black Tree or AVL Tree as much as possible, as they inherently have self-balancing functions. binary search tree
Red-black Tree A tree-like rabbit colony composed of doubly linked lists, where each rabbit has at most two tails. These rabbits are not only obedient but also intelligent, automatically arranging their positions in a certain order. A self-balancing binary search tree. Each node is marked with a red-black label. Ensuring that no path is more than twice as long as any other (maintaining a certain balance to improve the speed of search, addition, and deletion). red-black tree
AVL Tree A tree-like rabbit colony composed of doubly linked lists, where each rabbit has at most two tails. These rabbits are not only obedient but also intelligent, automatically arranging their positions in a certain order, and they follow very strict rules. A self-balancing binary search tree. Each node is marked with a balance factor, representing the height difference between its left and right subtrees. The absolute value of the balance factor does not exceed 1 (maintaining stricter balance, which makes search efficiency higher than Red-black Tree, but insertion and deletion operations will be more complex and relatively less efficient). avl tree
Heap A special type of complete binary tree, often stored in an array, where the children nodes of the node at index i are at indices 2i+1 and 2i+2. Naturally, the parent node of any node is at ⌊(i1)/2⌋. heap
Priority Queue It's actually a Heap. priority queue
Graph The base class for Directed Graph and Undirected Graph, providing some common methods. graph
Directed Graph A network-like bunny group where each bunny can have up to n tails (Singly Linked List). directed graph
Undirected Graph A network-like bunny group where each bunny can have up to n tails (Doubly Linked List). undirected graph

Conciseness and uniformity

In java.utils, you need to memorize a table for all sequential data structures(Queue, Deque, LinkedList),

Java ArrayList Java Queue Java ArrayDeque Java LinkedList
add offer push push
remove poll removeLast removeLast
remove poll removeFirst removeFirst
add(0, element) offerFirst unshift unshift

whereas in our data-structure-typed, you only need to remember four methods: push, pop, shift, and unshift for all sequential data structures(Queue, Deque, DoublyLinkedList, SinglyLinkedList and Array).

Data structures available

We provide data structures that are not available in JS/TS

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

Vivid Examples

AVL Tree

Try it out, or you can run your own code using our visual tool

Tree Multi Map

Try it out

Directed Graph

Try it out

Map Graph

Try it out

Code Snippets

Red Black Tree snippet

TS

import { RedBlackTree } from 'data-structure-typed';

const rbTree = new RedBlackTree<number>();
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

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

Free conversion between data structures.

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

Binary Search Tree (BST) snippet

import { BST, BSTNode } from 'data-structure-typed';

const bst = new BST<number>();
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<number, { height: number, age: number }>();

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

import { AVLTree } from 'data-structure-typed';

const avlTree = new AVLTree<number>();
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

import { DirectedGraph } from 'data-structure-typed';

const graph = new DirectedGraph<string>();

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

import { UndirectedGraph } from 'data-structure-typed';

const graph = new UndirectedGraph<string>();
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']


API docs & Examples

API Docs

Live Examples

Examples Repository

Benchmark

MacBook Pro (15-inch, 2018)

Processor 2.2 GHz 6-Core Intel Core i7

Memory 16 GB 2400 MHz DDR4

Graphics Radeon Pro 555X 4 GB

Intel UHD Graphics 630 1536 MB

macOS Big Sur

Version 11.7.9

heap
test nametime taken (ms)executions per secsample deviation
100,000 add8.07123.930.00
100,000 add & poll45.3222.070.01
rb-tree
test nametime taken (ms)executions per secsample deviation
100,000 add77.0312.980.00
100,000 add randomly83.2612.010.00
100,000 get120.258.320.01
100,000 iterator26.3237.990.01
100,000 add & delete orderly161.686.190.01
100,000 add & delete randomly268.633.720.03
queue
test nametime taken (ms)executions per secsample deviation
1,000,000 push45.5521.960.02
100,000 push & shift5.54180.360.00
Native JS Array 100,000 push & shift2467.710.410.20
deque
test nametime taken (ms)executions per secsample deviation
1,000,000 push25.3639.430.00
1,000,000 push & pop32.1331.120.00
1,000,000 push & shift33.4229.920.00
100,000 push & shift3.59278.923.21e-4
Native JS Array 100,000 push & shift2427.030.410.21
100,000 unshift & shift3.56280.813.81e-4
Native JS Array 100,000 unshift & shift4464.180.220.07
hash-map
test nametime taken (ms)executions per secsample deviation
1,000,000 set313.053.190.07
Native JS Map 1,000,000 set224.484.450.05
Native JS Set 1,000,000 add203.464.910.05
1,000,000 set & get281.793.550.07
Native JS Map 1,000,000 set & get289.573.450.03
Native JS Set 1,000,000 add & has195.735.110.02
1,000,000 ObjKey set & get348.392.870.03
Native JS Map 1,000,000 ObjKey set & get315.233.170.04
Native JS Set 1,000,000 ObjKey add & has335.832.980.06
trie
test nametime taken (ms)executions per secsample deviation
100,000 push48.0920.790.00
100,000 getWords93.1710.730.01
avl-tree
test nametime taken (ms)executions per secsample deviation
100,000 add278.913.590.01
100,000 add randomly350.652.850.02
100,000 get154.976.450.03
100,000 iterator34.7828.750.02
100,000 add & delete orderly445.452.240.00
100,000 add & delete randomly616.611.620.03
binary-tree-overall
test nametime taken (ms)executions per secsample deviation
10,000 RBTree add randomly7.07141.457.19e-4
10,000 RBTree get randomly9.33107.211.48e-4
10,000 RBTree add & delete randomly18.6053.773.93e-4
10,000 AVLTree add randomly30.3932.910.01
10,000 AVLTree get randomly10.7093.490.00
10,000 AVLTree add & delete randomly46.0421.720.00
directed-graph
test nametime taken (ms)executions per secsample deviation
1,000 addVertex0.137502.536.69e-5
1,000 addEdge7.93126.130.00
1,000 getVertex0.052.19e+41.17e-5
1,000 getEdge18.6553.610.00
tarjan158.866.300.01
topologicalSort141.917.050.01
doubly-linked-list
test nametime taken (ms)executions per secsample deviation
1,000,000 push211.264.730.03
1,000,000 unshift216.904.610.07
1,000,000 unshift & shift208.454.800.05
1,000,000 addBefore316.553.160.06
singly-linked-list
test nametime taken (ms)executions per secsample deviation
1,000,000 push & shift222.814.490.08
10,000 push & pop235.914.240.01
10,000 addBefore250.573.990.01
priority-queue
test nametime taken (ms)executions per secsample deviation
100,000 add27.6436.178.81e-4
100,000 add & poll75.5213.249.91e-4
stack
test nametime taken (ms)executions per secsample deviation
1,000,000 push40.4724.710.01
1,000,000 push & pop47.4721.070.01

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 getCutVertices 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

We strictly adhere to computer science theory and software development standards. Our LinkedList is designed in the traditional sense of the LinkedList data structure, and we refrain from substituting it with a Deque solely for the purpose of showcasing performance test data. However, we have also implemented a Deque based on a dynamic array concurrently.

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.

supported module system

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

CDN

Copy the line below into the head tag in an HTML document.

development


<script src='https://cdn.jsdelivr.net/npm/data-structure-typed/dist/umd/data-structure-typed.js'></script>

production


<script src='https://cdn.jsdelivr.net/npm/data-structure-typed/dist/umd/data-structure-typed.min.js'></script>

Copy the code below into the script tag of your HTML, and you're good to go with your development.

const { Heap } = dataStructureTyped;
const {
  BinaryTree, Graph, Queue, Stack, PriorityQueue, BST, Trie, DoublyLinkedList,
  AVLTree, MinHeap, SinglyLinkedList, DirectedGraph, TreeMultiMap,
  DirectedVertex, AVLTreeNode
} = dataStructureTyped;