mirror of
https://github.com/zrwusa/data-structure-typed.git
synced 2024-11-09 23:54:04 +00:00
1134 lines
44 KiB
Markdown
1134 lines
44 KiB
Markdown
# data-structure-typed
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[//]: # ()
|
|
|
|
[//]: # (<p><a href="https://github.com/zrwusa/data-structure-typed/blob/main/README.md">English</a> | <a href="https://github.com/zrwusa/data-structure-typed/blob/main/README_zh-CN.md">简体中文</a></p>)
|
|
|
|
|
|
## 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
|
|
|
|
|
|
[//]: # ()
|
|
|
|
[//]: # ()
|
|
|
|
[//]: # ()
|
|
|
|
[//]: # ()
|
|
|
|
### Performance
|
|
|
|
Performance surpasses that of native JS/TS
|
|
|
|
<table style="display: table; width:100%; table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Time Taken</th>
|
|
<th>Data Scale</th>
|
|
<th>Belongs To</th>
|
|
<th>big O</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Queue.push & shift</td>
|
|
<td>5.83 ms</td>
|
|
<td>100K</td>
|
|
<td>Ours</td>
|
|
<td>O(1)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Array.push & shift</td>
|
|
<td>2829.59 ms</td>
|
|
<td>100K</td>
|
|
<td>Native JS</td>
|
|
<td>O(n)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Deque.unshift & shift</td>
|
|
<td>2.44 ms</td>
|
|
<td>100K</td>
|
|
<td>Ours</td>
|
|
<td>O(1)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Array.unshift & shift</td>
|
|
<td>4750.37 ms</td>
|
|
<td>100K</td>
|
|
<td>Native JS</td>
|
|
<td>O(n)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>HashMap.set</td>
|
|
<td>122.51 ms</td>
|
|
<td>1M</td>
|
|
<td>Ours</td>
|
|
<td>O(1)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Map.set</td>
|
|
<td>223.80 ms</td>
|
|
<td>1M</td>
|
|
<td>Native JS</td>
|
|
<td>O(1)</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Set.add</td>
|
|
<td>185.06 ms</td>
|
|
<td>1M</td>
|
|
<td>Native JS</td>
|
|
<td>O(1)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
### Conciseness and uniformity
|
|
In [java.utils](), you need to memorize a table for all sequential data structures(Queue, Deque, LinkedList),
|
|
|
|
<table style="display: table; width:100%; table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th>Java ArrayList</th>
|
|
<th>Java Queue</th>
|
|
<th>Java ArrayDeque</th>
|
|
<th>Java LinkedList</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>add</td>
|
|
<td>offer</td>
|
|
<td>push</td>
|
|
<td>push</td>
|
|
</tr>
|
|
<tr>
|
|
<td>remove</td>
|
|
<td>poll</td>
|
|
<td>removeLast</td>
|
|
<td>removeLast</td>
|
|
</tr>
|
|
<tr>
|
|
<td>remove</td>
|
|
<td>poll</td>
|
|
<td>removeFirst</td>
|
|
<td>removeFirst</td>
|
|
</tr>
|
|
<tr>
|
|
<td>add(0, element)</td>
|
|
<td>offerFirst</td>
|
|
<td>unshift</td>
|
|
<td>unshift</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
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
|
|
|
|
<table style="display: table; width:100%; table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th>Data Structure</th>
|
|
<th>Unit Test</th>
|
|
<th>Perf Test</th>
|
|
<th>API Doc</th>
|
|
<th>NPM</th>
|
|
<th>Downloads</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Binary 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/BinaryTree.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/binary-tree-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/binary-tree-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/bst-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/bst-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/avl-tree-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/avl-tree-typed"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Red Black 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/RedBlackTree.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/red-black-tree-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/red-black-tree-typed"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Tree Multimap</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/TreeMultiMap.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/tree-multimap-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/tree-multimap-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/heap-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/heap-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/priority-queue-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/priority-queue-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/max-priority-queue-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/max-priority-queue-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/min-priority-queue-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/min-priority-queue-typed"></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><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/Trie.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/trie-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/trie-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/graph-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/graph-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/directed-graph-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/directed-graph-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/undirected-graph-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/undirected-graph-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/queue-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/queue-typed"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>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/Deque.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/deque-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/deque-typed"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Hash Map</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/HashMap.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/hashmap-typed"><span></span></a></td>
|
|
<td></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/linked-list-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/linked-list-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/singly-linked-list-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/singly-linked-list-typed"></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/doubly-linked-list-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/doubly-linked-list-typed"></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><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/Stack.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/stack-typed"><span>NPM</span></a></td>
|
|
<td><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/stack-typed"></td>
|
|
</tr>
|
|
<tr>
|
|
<td>Segment 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/SegmentTree.html"><span>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/segment-tree-typed"><span></span></a></td>
|
|
<td></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>Docs</span></a></td>
|
|
<td><a href="https://www.npmjs.com/package/binary-indexed-tree-typed"><span></span></a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## Vivid Examples
|
|
|
|
### AVL 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)
|
|
|
|
|
|
|
|
### Tree Multi Map
|
|
|
|
[Try it out](https://vivid-algorithm.vercel.app/)
|
|
|
|
|
|
|
|
### Directed Graph
|
|
|
|
[Try it out](https://vivid-algorithm.vercel.app/algorithm/graph/)
|
|
|
|
|
|
|
|
### Map Graph
|
|
|
|
[Try it out](https://vivid-algorithm.vercel.app/algorithm/graph/)
|
|
|
|
|
|
|
|
## Code Snippets
|
|
|
|
### Red Black Tree snippet
|
|
|
|
#### TS
|
|
|
|
```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
|
|
|
|
```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.
|
|
|
|
```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
|
|
```
|
|
|
|
### Binary Search Tree (BST) snippet
|
|
|
|
```ts
|
|
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
|
|
|
|
```ts
|
|
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
|
|
|
|
```ts
|
|
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
|
|
|
|
```ts
|
|
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](https://data-structure-typed-docs.vercel.app)
|
|
|
|
[Live Examples](https://vivid-algorithm.vercel.app)
|
|
|
|
<a href="https://github.com/zrwusa/vivid-algorithm" target="_blank">Examples Repository</a>
|
|
|
|
## 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
|
|
|
|
|
|
[//]: # (No deletion!!! Start of Replace Section)
|
|
<div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>heap</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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</td><td>6.09</td><td>164.12</td><td>1.35e-4</td></tr><tr><td>100,000 add & poll</td><td>34.55</td><td>28.94</td><td>6.43e-4</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>rb-tree</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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</td><td>76.73</td><td>13.03</td><td>0.00</td></tr><tr><td>100,000 add randomly</td><td>80.67</td><td>12.40</td><td>0.00</td></tr><tr><td>100,000 get</td><td>110.86</td><td>9.02</td><td>0.00</td></tr><tr><td>100,000 iterator</td><td>24.99</td><td>40.02</td><td>0.00</td></tr><tr><td>100,000 add & delete orderly</td><td>152.66</td><td>6.55</td><td>0.00</td></tr><tr><td>100,000 add & delete randomly</td><td>230.75</td><td>4.33</td><td>0.00</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>queue</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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>39.27</td><td>25.46</td><td>0.01</td></tr><tr><td>100,000 push & shift</td><td>4.53</td><td>220.81</td><td>4.84e-4</td></tr><tr><td>Native JS Array 100,000 push & shift</td><td>1948.05</td><td>0.51</td><td>0.02</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>deque</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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>23.22</td><td>43.06</td><td>0.00</td></tr><tr><td>1,000,000 push & pop</td><td>29.68</td><td>33.69</td><td>0.00</td></tr><tr><td>1,000,000 push & shift</td><td>29.33</td><td>34.09</td><td>0.00</td></tr><tr><td>100,000 push & shift</td><td>3.10</td><td>323.01</td><td>2.47e-4</td></tr><tr><td>Native JS Array 100,000 push & shift</td><td>1942.12</td><td>0.51</td><td>0.02</td></tr><tr><td>100,000 unshift & shift</td><td>2.77</td><td>360.50</td><td>2.43e-4</td></tr><tr><td>Native JS Array 100,000 unshift & shift</td><td>3835.21</td><td>0.26</td><td>0.03</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>hash-map</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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 set</td><td>112.38</td><td>8.90</td><td>0.02</td></tr><tr><td>Native JS Map 1,000,000 set</td><td>199.97</td><td>5.00</td><td>0.01</td></tr><tr><td>Native JS Set 1,000,000 add</td><td>163.34</td><td>6.12</td><td>0.01</td></tr><tr><td>1,000,000 set & get</td><td>109.86</td><td>9.10</td><td>0.02</td></tr><tr><td>Native JS Map 1,000,000 set & get</td><td>255.33</td><td>3.92</td><td>0.00</td></tr><tr><td>Native JS Set 1,000,000 add & has</td><td>163.91</td><td>6.10</td><td>0.00</td></tr><tr><td>1,000,000 ObjKey set & get</td><td>317.89</td><td>3.15</td><td>0.04</td></tr><tr><td>Native JS Map 1,000,000 ObjKey set & get</td><td>282.99</td><td>3.53</td><td>0.03</td></tr><tr><td>Native JS Set 1,000,000 ObjKey add & has</td><td>253.93</td><td>3.94</td><td>0.03</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>trie</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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>43.71</td><td>22.88</td><td>7.33e-4</td></tr><tr><td>100,000 getWords</td><td>83.63</td><td>11.96</td><td>0.00</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>avl-tree</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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</td><td>271.93</td><td>3.68</td><td>0.01</td></tr><tr><td>100,000 add randomly</td><td>318.27</td><td>3.14</td><td>0.00</td></tr><tr><td>100,000 get</td><td>128.85</td><td>7.76</td><td>0.00</td></tr><tr><td>100,000 iterator</td><td>29.09</td><td>34.38</td><td>0.00</td></tr><tr><td>100,000 add & delete orderly</td><td>435.48</td><td>2.30</td><td>7.44e-4</td></tr><tr><td>100,000 add & delete randomly</td><td>578.70</td><td>1.73</td><td>0.00</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>binary-tree-overall</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><tr><th>test name</th><th>time taken (ms)</th><th>executions per sec</th><th>sample deviation</th></tr><tr><td>10,000 RBTree add randomly</td><td>6.69</td><td>149.54</td><td>1.06e-4</td></tr><tr><td>10,000 RBTree get randomly</td><td>9.19</td><td>108.82</td><td>1.43e-4</td></tr><tr><td>10,000 RBTree add & delete randomly</td><td>18.54</td><td>53.94</td><td>1.73e-4</td></tr><tr><td>10,000 AVLTree add randomly</td><td>23.70</td><td>42.20</td><td>1.88e-4</td></tr><tr><td>10,000 AVLTree get randomly</td><td>9.89</td><td>101.11</td><td>0.00</td></tr><tr><td>10,000 AVLTree add & delete randomly</td><td>44.44</td><td>22.50</td><td>4.30e-4</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>directed-graph</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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>9766.65</td><td>9.83e-7</td></tr><tr><td>1,000 addEdge</td><td>6.15</td><td>162.57</td><td>7.99e-4</td></tr><tr><td>1,000 getVertex</td><td>0.05</td><td>2.18e+4</td><td>4.52e-7</td></tr><tr><td>1,000 getEdge</td><td>22.70</td><td>44.06</td><td>0.00</td></tr><tr><td>tarjan</td><td>203.00</td><td>4.93</td><td>0.01</td></tr><tr><td>topologicalSort</td><td>176.40</td><td>5.67</td><td>0.00</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>doubly-linked-list</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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>222.02</td><td>4.50</td><td>0.07</td></tr><tr><td>1,000,000 unshift</td><td>220.41</td><td>4.54</td><td>0.05</td></tr><tr><td>1,000,000 unshift & shift</td><td>185.31</td><td>5.40</td><td>0.01</td></tr><tr><td>1,000,000 addBefore</td><td>317.20</td><td>3.15</td><td>0.07</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>singly-linked-list</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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 & shift</td><td>204.82</td><td>4.88</td><td>0.09</td></tr><tr><td>10,000 push & pop</td><td>221.88</td><td>4.51</td><td>0.03</td></tr><tr><td>10,000 addBefore</td><td>247.28</td><td>4.04</td><td>0.01</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>priority-queue</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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</td><td>26.97</td><td>37.08</td><td>7.97e-4</td></tr><tr><td>100,000 add & poll</td><td>74.55</td><td>13.41</td><td>5.19e-4</td></tr></table></div>
|
|
</div><div class="json-to-html-collapse clearfix 0">
|
|
<div class='collapsible level0' ><span class='json-to-html-label'>stack</span></div>
|
|
<div class="content"><table style="display: table; width:100%; table-layout: fixed;"><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>35.54</td><td>28.14</td><td>0.00</td></tr><tr><td>1,000,000 push & pop</td><td>44.89</td><td>22.27</td><td>0.01</td></tr></table></div>
|
|
</div>
|
|
|
|
[//]: # (No deletion!!! End of Replace Section)
|
|
|
|
## The corresponding relationships between data structures in different language standard libraries.
|
|
|
|
<table style="display: table; width:100%; table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th>Data Structure Typed</th>
|
|
<th>C++ STL</th>
|
|
<th>java.util</th>
|
|
<th>Python collections</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Heap<E></td>
|
|
<td>-</td>
|
|
<td>-</td>
|
|
<td>heapq</td>
|
|
</tr>
|
|
<tr>
|
|
<td>PriorityQueue<E></td>
|
|
<td>priority_queue<T></td>
|
|
<td>PriorityQueue<E></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Deque<E></td>
|
|
<td>deque<T></td>
|
|
<td>ArrayDeque<E></td>
|
|
<td>deque</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Queue<E></td>
|
|
<td>queue<T></td>
|
|
<td>Queue<E></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>DoublyLinkedList<E></td>
|
|
<td>list<T></td>
|
|
<td>LinkedList<E></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>SinglyLinkedList<E></td>
|
|
<td>-</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>RedBlackTree<E></td>
|
|
<td>set<T></td>
|
|
<td>TreeSet<E></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>RedBlackTree<K, V></td>
|
|
<td>map<K, V></td>
|
|
<td>TreeMap<K, V></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TreeMultiMap<K, V></td>
|
|
<td>multimap<K, V></td>
|
|
<td>-</td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>TreeMultiMap<E></td>
|
|
<td>multiset<T></td>
|
|
<td>-</td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Trie</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>PriorityQueue<E></td>
|
|
<td>priority_queue<T></td>
|
|
<td>PriorityQueue<E></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Array<E></td>
|
|
<td>vector<T></td>
|
|
<td>ArrayList<E></td>
|
|
<td>list</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Stack<E></td>
|
|
<td>stack<T></td>
|
|
<td>Stack<E></td>
|
|
<td>-</td>
|
|
</tr>
|
|
<tr>
|
|
<td>HashMap<E></td>
|
|
<td>unordered_set<T></td>
|
|
<td>HashSet<E></td>
|
|
<td>set</td>
|
|
</tr>
|
|
<tr>
|
|
<td>-</td>
|
|
<td>unordered_multiset</td>
|
|
<td>-</td>
|
|
<td>Counter</td>
|
|
</tr>
|
|
<tr>
|
|
<td>LinkedHashMap<K, V></td>
|
|
<td>-</td>
|
|
<td>LinkedHashMap<K, V></td>
|
|
<td>OrderedDict</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>
|
|
</tbody>
|
|
</table>
|
|
|
|
## Built-in classic algorithms
|
|
|
|
<table style="display: table; width:100%; table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th>Algorithm</th>
|
|
<th>Function Description</th>
|
|
<th>Iteration Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Binary Tree DFS</td>
|
|
<td>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.
|
|
</td>
|
|
<td>Recursion + Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Binary Tree BFS</td>
|
|
<td>Traverse a binary tree in a breadth-first manner, starting from the root node, visiting nodes level by level
|
|
from left to right.
|
|
</td>
|
|
<td>Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph DFS</td>
|
|
<td>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.
|
|
</td>
|
|
<td>Recursion + Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Binary Tree Morris</td>
|
|
<td>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.
|
|
</td>
|
|
<td>Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph BFS</td>
|
|
<td>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.
|
|
</td>
|
|
<td>Recursion + Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph Tarjan's Algorithm</td>
|
|
<td>Find strongly connected components in a graph, typically implemented using depth-first search.</td>
|
|
<td>Recursion</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph Bellman-Ford Algorithm</td>
|
|
<td>Finding the shortest paths from a single source, can handle negative weight edges</td>
|
|
<td>Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph Dijkstra's Algorithm</td>
|
|
<td>Finding the shortest paths from a single source, cannot handle negative weight edges</td>
|
|
<td>Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph Floyd-Warshall Algorithm</td>
|
|
<td>Finding the shortest paths between all pairs of nodes</td>
|
|
<td>Iteration</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph getCycles</td>
|
|
<td>Find all cycles in a graph or detect the presence of cycles.</td>
|
|
<td>Recursion</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph getCutVertices</td>
|
|
<td>Find cut vertices in a graph, which are nodes that, when removed, increase the number of connected components in
|
|
the graph.
|
|
</td>
|
|
<td>Recursion</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph getSCCs</td>
|
|
<td>Find strongly connected components in a graph, which are subgraphs where any two nodes can reach each other.
|
|
</td>
|
|
<td>Recursion</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph getBridges</td>
|
|
<td>Find bridges in a graph, which are edges that, when removed, increase the number of connected components in the
|
|
graph.
|
|
</td>
|
|
<td>Recursion</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Graph topologicalSort</td>
|
|
<td>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.
|
|
</td>
|
|
<td>Recursion</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
## 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.
|
|
|
|
|
|
<table style="display: table; width:100%; table-layout: fixed;">
|
|
<tr>
|
|
<th>Principle</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>Practicality</td>
|
|
<td>Follows ES6 and ESNext standards, offering unified and considerate optional parameters, and simplifies method names.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Extensibility</td>
|
|
<td>Adheres to OOP (Object-Oriented Programming) principles, allowing inheritance for all data structures.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Modularization</td>
|
|
<td>Includes data structure modularization and independent NPM packages.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Efficiency</td>
|
|
<td>All methods provide time and space complexity, comparable to native JS performance.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Maintainability</td>
|
|
<td>Follows open-source community development standards, complete documentation, continuous integration, and adheres to TDD (Test-Driven Development) patterns.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Testability</td>
|
|
<td>Automated and customized unit testing, performance testing, and integration testing.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Portability</td>
|
|
<td>Plans for porting to Java, Python, and C++, currently achieved to 80%.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Reusability</td>
|
|
<td>Fully decoupled, minimized side effects, and adheres to OOP.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Security</td>
|
|
<td>Carefully designed security for member variables and methods. Read-write separation. Data structure software does not need to consider other security aspects.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Scalability</td>
|
|
<td>Data structure software does not involve load issues.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## 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
|
|
|
|
```html
|
|
|
|
<script src='https://cdn.jsdelivr.net/npm/data-structure-typed/dist/umd/data-structure-typed.js'></script>
|
|
```
|
|
|
|
#### production
|
|
|
|
```html
|
|
|
|
<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.
|
|
|
|
```js
|
|
const { Heap } = dataStructureTyped;
|
|
const {
|
|
BinaryTree, Graph, Queue, Stack, PriorityQueue, BST, Trie, DoublyLinkedList,
|
|
AVLTree, MinHeap, SinglyLinkedList, DirectedGraph, TreeMultiMap,
|
|
DirectedVertex, AVLTreeNode
|
|
} = dataStructureTyped;
|
|
``` |