Find a file
2023-11-04 15:47:24 +08:00
.github [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
scripts [benchmark] generated a performance testing report. 2023-11-02 09:24:06 +08:00
src [graph] use 'Set' in dfs instead of 'Map' 2023-11-04 15:47:24 +08:00
test [graph] use 'Set' in dfs instead of 'Map' 2023-11-04 15:47:24 +08: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 [test] test coverage enriched to 90.37% 2023-10-29 21:52:27 +08:00
.editorconfig [binary-tree] The binary tree's BFS and level-order traversal results should be the same. However, for convenience, we provide an additional method called listLevels to display traversal results in levels. 2023-10-27 22:30:52 +08:00
.eslintrc.js [heap] fibonacci heap implemented. [test] big O estimate. [project] no-unused-vars config to warn 2023-10-21 01:59:10 +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 [project] Ensure the type files in the "types" directory match those in the "src" directory. 2023-10-25 09:57:04 +08:00
.prettierrc.js [binary-tree] bug fix#27 2023-10-30 11:14:41 +08: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 [graph] use 'Set' in dfs instead of 'Map' 2023-11-04 15:47:24 +08:00
CODE_OF_CONDUCT.md [pkg] config files renamed. v1.33.0 2023-09-25 11:16:04 +08:00
COMMANDS.md 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
CONTRIBUTING.md [project] CONTRIBUTING.md enriched 2023-10-19 09:53:49 +08:00
jest.config.js [benchmark] generated a performance testing report. 2023-11-02 09:24:06 +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 [graph] use 'Set' in dfs instead of 'Map' 2023-11-04 15:47:24 +08:00
package.json [graph] use 'Set' in dfs instead of 'Map' 2023-11-04 15:47:24 +08:00
README.md [graph] use 'Set' in dfs instead of 'Map' 2023-11-04 15:47:24 +08:00
SECURITY.md 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
tsconfig-base.json [BST, AVL] The 'get' method follows the binary search of a BST for bug fixes during queries. [Project] The editor uses 'tsconfig.json' for code checking to be compatible with the 'test' directory, but compiles using their respective configuration files. 2023-11-04 10:00:51 +08:00
tsconfig-cjs.json [BST, AVL] The 'get' method follows the binary search of a BST for bug fixes during queries. [Project] The editor uses 'tsconfig.json' for code checking to be compatible with the 'test' directory, but compiles using their respective configuration files. 2023-11-04 10:00:51 +08:00
tsconfig-mjs.json [BST, AVL] The 'get' method follows the binary search of a BST for bug fixes during queries. [Project] The editor uses 'tsconfig.json' for code checking to be compatible with the 'test' directory, but compiles using their respective configuration files. 2023-11-04 10:00:51 +08:00
tsconfig.json [BST, AVL] The 'get' method follows the binary search of a BST for bug fixes during queries. [Project] The editor uses 'tsconfig.json' for code checking to be compatible with the 'test' directory, but compiles using their respective configuration files. 2023-11-04 10:00:51 +08:00
tsup.config.js [binary-tree] The binary tree's BFS and level-order traversal results should be the same. However, for convenience, we provide an additional method called listLevels to display traversal results in levels. 2023-10-27 22:30:52 +08:00

Data Structure Typed

NPM GitHub top language npm eslint npm package minimized gzipped size (select exports) npm bundle size npm

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

Data Structure Unit Test Performance Test API Documentation Implemented
Binary Tree Binary Tree
Binary Search Tree (BST) BST
AVL Tree AVLTree
Tree Multiset TreeMultiset
Segment Tree SegmentTree
Binary Indexed Tree BinaryIndexedTree
Graph AbstractGraph
Directed Graph DirectedGraph
Undirected Graph UndirectedGraph
Linked List SinglyLinkedList
Singly Linked List SinglyLinkedList
Doubly Linked List DoublyLinkedList
Queue Queue
Object Deque ObjectDeque
Array Deque ArrayDeque
Stack Stack
Coordinate Set CoordinateSet
Coordinate Map CoordinateMap
Heap Heap
Priority Queue PriorityQueue
Max Priority Queue MaxPriorityQueue
Min Priority Queue MinPriorityQueue
Trie Trie

Standard library data structure comparison

Data Structure Data Structure Typed C++ STL java.util Python collections
Dynamic Array Array<E> vector<T> ArrayList<E> list
Linked List DoublyLinkedList<E> list<T> LinkedList<E> deque
Singly Linked List SinglyLinkedList<E> - - -
Set Set<E> set<T> HashSet<E> set
Map Map<K, V> map<K, V> HashMap<K, V> dict
Ordered Dictionary Map<K, V> - - OrderedDict
Queue Queue<E> queue<T> Queue<E> -
Priority Queue PriorityQueue<E> priority_queue<T> PriorityQueue<E> -
Heap Heap<V> priority_queue<T> PriorityQueue<E> heapq
Stack Stack<E> stack<T> Stack<E> -
Deque Deque<E> deque<T> - -
Trie Trie - - -
Unordered Map HashMap<K, V> unordered_map<K, V> HashMap<K, V> defaultdict
Multiset - multiset<T> - -
Multimap - multimap<K, V> - -
Binary Tree BinaryTree<K, V> - - -
Binary Search Tree BST<K, V> - - -
Directed Graph DirectedGraph<V, E> - - -
Undirected Graph UndirectedGraph<V, E> - - -
Unordered Multiset - unordered_multiset - Counter
Linked Hash Set - - LinkedHashSet<E> -
Linked Hash Map - - LinkedHashMap<K, V> -
Sorted Set AVLTree<E> - TreeSet<E> -
Sorted Map AVLTree<K, V> - TreeMap<K, V> -
Tree Set AVLTree<E> set TreeSet<E> -
Unordered Multimap - unordered_multimap<K, V> - -
Bitset - bitset<N> - -
Unordered Set - 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 nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000 add randomly2.28438.38230.002.56e-5
1000 add & delete randomly5.16193.94110.017.96e-4
1000 addMany3.05328.30170.003.13e-4
1000 get2.08480.72250.009.01e-5
binary-tree
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000 add randomly12.8877.6550.011.17e-4
1000 add & delete randomly15.9562.7040.021.78e-4
1000 addMany10.6194.2550.011.16e-4
1000 get18.0255.5130.021.59e-4
1000 dfs69.9514.3010.076.49e-4
1000 bfs54.7818.2510.054.98e-4
1000 morris37.2626.8320.042.16e-4
bst
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000 add randomly2.02496.10250.001.56e-5
1000 add & delete randomly4.60217.31120.004.43e-4
1000 addMany2.23448.71240.002.96e-4
1000 get2.09479.52250.001.27e-5
directed-graph
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000 addVertex0.109871.965011.01e-47.32e-7
1000 addEdge6.48154.2990.010.00
1000 getVertex0.052.17e+411104.61e-53.80e-7
1000 getEdge24.6540.5730.020.01
tarjan208.004.8110.210.01
tarjan all212.974.7010.210.00
topologicalSort171.495.8310.170.01
heap
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000 add & pop0.342929.811493.41e-42.37e-6
1000 fib add & pop3.89257.31140.002.53e-5
doubly-linked-list
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000000 unshift212.404.7110.210.02
1000000 unshift & shift172.945.7810.170.03
1000 insertBefore0.033.70e+419032.71e-52.38e-6
singly-linked-list
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000 push & pop1.75571.73300.005.06e-5
1000 insertBefore2.30434.82220.005.10e-5
max-priority-queue
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
10000 refill & poll11.4187.6550.011.49e-4
deque
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000000 push212.514.7110.210.06
1000000 shift24.9840.0430.020.00
queue
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
1000000 push41.9723.8320.040.01
1000000 push & shift79.0812.6510.080.00
trie
test nametime taken (ms)executions per secexecuted timessample mean (secs)sample deviation
100000 push54.2418.4410.057.00e-4
100000 getWords96.1210.4010.100.00