test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
100,000 add | 6.34 | 157.78 | 1.90e-4 |
100,000 add & poll | 31.39 | 31.86 | 8.18e-4 |
# data-structure-typed ![npm](https://img.shields.io/npm/dm/data-structure-typed) ![GitHub contributors](https://img.shields.io/github/contributors/zrwusa/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](https://img.shields.io/npm/v/data-structure-typed) [//]: # (![npm bundle size](https://img.shields.io/bundlephobia/min/data-structure-typed)) [//]: # (
) ## Installation and Usage ### npm ```bash npm i data-structure-typed --save ``` ### yarn ```bash yarn add data-structure-typed ``` ```js 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 ```bash 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 [//]: # (![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)) ### Performance Performance surpasses that of native JS/TSMethod | 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) |
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 |
Data Structure | Unit Test | Perf Test | API Doc | NPM | Downloads |
---|---|---|---|---|---|
Binary Tree | View | View | |||
Binary Search Tree (BST) | View | View | |||
AVL Tree | View | View | |||
Red Black Tree | View | View | |||
Tree Multimap | View | View | |||
Heap | View | View | |||
Priority Queue | View | View | |||
Max Priority Queue | View | View | |||
Min Priority Queue | View | View | |||
Trie | View | View | |||
Graph | View | View | |||
Directed Graph | View | View | |||
Undirected Graph | View | View | |||
Queue | View | View | |||
Deque | View | View | |||
Hash Map | View | ||||
Linked List | View | View | |||
Singly Linked List | View | View | |||
Doubly Linked List | View | View | |||
Stack | View | View | |||
Segment Tree | View | ||||
Binary Indexed Tree | View |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
100,000 add | 6.34 | 157.78 | 1.90e-4 |
100,000 add & poll | 31.39 | 31.86 | 8.18e-4 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
100,000 add | 59.64 | 16.77 | 0.00 |
100,000 add randomly | 73.67 | 13.57 | 0.00 |
100,000 get | 89.91 | 11.12 | 0.00 |
100,000 iterator | 26.08 | 38.34 | 0.00 |
100,000 add & delete orderly | 145.44 | 6.88 | 0.00 |
100,000 add & delete randomly | 204.81 | 4.88 | 0.00 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000,000 push | 40.84 | 24.48 | 0.00 |
100,000 push & shift | 4.83 | 207.16 | 5.59e-4 |
Native JS Array 100,000 push & shift | 2376.78 | 0.42 | 0.34 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000,000 push | 24.73 | 40.44 | 0.00 |
1,000,000 push & pop | 30.08 | 33.24 | 0.00 |
1,000,000 push & shift | 30.53 | 32.75 | 0.00 |
100,000 push & shift | 3.19 | 313.76 | 3.01e-4 |
Native JS Array 100,000 push & shift | 2184.78 | 0.46 | 0.19 |
100,000 unshift & shift | 2.94 | 339.72 | 3.66e-4 |
Native JS Array 100,000 unshift & shift | 4196.69 | 0.24 | 0.37 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000,000 set | 117.77 | 8.49 | 0.03 |
Native JS Map 1,000,000 set | 200.53 | 4.99 | 0.00 |
Native JS Set 1,000,000 add | 172.75 | 5.79 | 0.03 |
1,000,000 set & get | 117.61 | 8.50 | 0.02 |
Native JS Map 1,000,000 set & get | 265.24 | 3.77 | 0.01 |
Native JS Set 1,000,000 add & has | 168.61 | 5.93 | 0.01 |
1,000,000 ObjKey set & get | 325.91 | 3.07 | 0.04 |
Native JS Map 1,000,000 ObjKey set & get | 301.51 | 3.32 | 0.03 |
Native JS Set 1,000,000 ObjKey add & has | 274.47 | 3.64 | 0.04 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
100,000 push | 42.93 | 23.29 | 8.30e-4 |
100,000 getWords | 82.14 | 12.17 | 0.00 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
100,000 add | 231.62 | 4.32 | 0.00 |
100,000 add randomly | 304.23 | 3.29 | 0.00 |
100,000 get | 113.93 | 8.78 | 0.00 |
100,000 iterator | 30.37 | 32.92 | 0.00 |
100,000 add & delete orderly | 395.02 | 2.53 | 0.02 |
100,000 add & delete randomly | 542.16 | 1.84 | 0.00 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
10,000 RBTree add randomly | 6.02 | 166.10 | 9.19e-5 |
10,000 RBTree get randomly | 7.96 | 125.61 | 7.80e-5 |
10,000 RBTree add & delete randomly | 16.66 | 60.02 | 1.52e-4 |
10,000 AVLTree add randomly | 21.64 | 46.21 | 1.93e-4 |
10,000 AVLTree get randomly | 8.40 | 119.09 | 1.34e-4 |
10,000 AVLTree add & delete randomly | 40.84 | 24.49 | 2.56e-4 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000 addVertex | 0.10 | 9892.74 | 8.38e-7 |
1,000 addEdge | 6.07 | 164.74 | 1.70e-4 |
1,000 getVertex | 0.05 | 2.13e+4 | 2.16e-6 |
1,000 getEdge | 38.66 | 25.87 | 0.02 |
tarjan | 208.11 | 4.81 | 0.01 |
topologicalSort | 184.45 | 5.42 | 0.02 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000,000 push | 218.49 | 4.58 | 0.04 |
1,000,000 unshift | 213.52 | 4.68 | 0.06 |
1,000,000 unshift & shift | 155.82 | 6.42 | 0.02 |
1,000,000 addBefore | 325.79 | 3.07 | 0.08 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000,000 push & shift | 191.94 | 5.21 | 0.04 |
10,000 push & pop | 214.82 | 4.66 | 0.01 |
10,000 addBefore | 247.53 | 4.04 | 0.00 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
100,000 add | 26.63 | 37.56 | 1.30e-4 |
100,000 add & poll | 76.82 | 13.02 | 0.00 |
test name | time taken (ms) | executions per sec | sample deviation |
---|---|---|---|
1,000,000 push | 38.58 | 25.92 | 0.00 |
1,000,000 push & pop | 46.06 | 21.71 | 0.00 |
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> | - | - |
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 |
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. |