JSPM

graph-typed

1.50.9
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 740
  • Score
    100M100P100Q90221F
  • License MIT

Graph. Javascript & Typescript Data Structure.

Package Exports

  • graph-typed
  • graph-typed/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (graph-typed) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

What

Brief

This is a standalone Graph data structure from the data-structure-typed collection. If you wish to access more data structures or advanced features, you can transition to directly installing the complete data-structure-typed package

How

install

npm

npm i graph-typed --save

yarn

yarn add graph-typed

methods

Directed Graph directed-graph Undirected Graph undirected-graph

snippet

TS

DirectedGraph
import {DirectedGraph, DirectedVertex, DirectedEdge} from 'data-structure-typed';
// /* or if you prefer */ import {DirectedGraph, DirectedVertex, DirectedEdge} from 'graph-typed';

const graph = new DirectedGraph();
const vertexA = new DirectedVertex('A');
const vertexB = new DirectedVertex('B');
const vertexC = new DirectedVertex('C');
const edgeAB = new DirectedEdge('A', 'B');
const edgeBC = new DirectedEdge('B', 'C');

graph.addVertex(vertexA);
graph.addVertex(vertexB);
graph.addVertex(vertexC);
graph.addEdge(edgeAB);
graph.addEdge(edgeBC);

const topologicalOrder = graph.topologicalSort();
if (topologicalOrder) expect(topologicalOrder).toEqual(['A', 'B', 'C'])
MapGraph
import {MapGraph, MapVertex} from 'data-structure-typed';
// /* or if you prefer */ import {MapGraph, MapVertex} from 'graph-typed';

const mapGraph = new MapGraph([5.500338, 100.173665]);

mapGraph.addVertex(new MapVertex('Surin', 5.466724, 100.274805));
mapGraph.addVertex(new MapVertex('Batu Feringgi Beach', 5.475141, 100.276670));
mapGraph.addVertex(new MapVertex('Lotus', 5.459044, 100.308767));
mapGraph.addVertex(new MapVertex('The Breeza', 5.454197, 100.307859));
mapGraph.addVertex(new MapVertex('Hard Rock Hotel', 5.467850, 100.241876));
mapGraph.addVertex(new MapVertex('Mira', 5.456749, 100.286650));
mapGraph.addVertex(new MapVertex('Penang Bible Church', 5.428683, 100.314825));
mapGraph.addVertex(new MapVertex('Queensbay', 5.332760, 100.306651));
mapGraph.addVertex(new MapVertex('Saanen Goat Farm', 5.405738, 100.207699));
mapGraph.addVertex(new MapVertex('Trinity Auto', 5.401126, 100.303739));
mapGraph.addVertex(new MapVertex('Penang Airport', 5.293185, 100.265772));
mapGraph.addEdge('Surin', 'Lotus', 4.7);
mapGraph.addEdge('Lotus', 'The Breeza', 1);
mapGraph.addEdge('Batu Feringgi Beach', 'Hard Rock Hotel', 5.2);
mapGraph.addEdge('Surin', 'Mira', 2.8);
mapGraph.addEdge('Mira', 'Penang Bible Church', 7.0);
mapGraph.addEdge('Lotus', 'Penang Bible Church', 5.7);
mapGraph.addEdge('Penang Bible Church', 'Queensbay', 13.9);
mapGraph.addEdge('Hard Rock Hotel', 'Saanen Goat Farm', 18.5);
mapGraph.addEdge('The Breeza', 'Trinity Auto', 9.1);
mapGraph.addEdge('Trinity Auto', 'Saanen Goat Farm', 26.3);
mapGraph.addEdge('The Breeza', 'Penang Airport', 24.8);
mapGraph.addEdge('Penang Airport', 'Saanen Goat Farm', 21.2);
const expected1 = ['Surin', 'Lotus', 'The Breeza', 'Trinity Auto', 'Saanen Goat Farm'];

const minPathBetween = mapGraph.getMinPathBetween('Surin', 'Saanen Goat Farm');
expect(minPathBetween?.map(v => v.id)).toEqual(expected1);
const surinToSaanenGoatFarmDij = mapGraph.dijkstra('Surin', 'Saanen Goat Farm', true, true);
expect(surinToSaanenGoatFarmDij?.minPath.map(v => v.id)).toEqual(expected1);
expect(surinToSaanenGoatFarmDij?.minDist).toBe(41.1);
mapGraph.addEdge('Surin', 'Batu Feringgi Beach', 1.5);
const expected2 = ['Surin', 'Batu Feringgi Beach', 'Hard Rock Hotel', 'Saanen Goat Farm'];
const minPathBetweenViaBFB = mapGraph.getMinPathBetween('Surin', 'Saanen Goat Farm', true);
expect(minPathBetweenViaBFB?.map(v => v.id)).toEqual(expected2);
const surinToSaanenGoatFarmViaDij = mapGraph.dijkstra('Surin', 'Saanen Goat Farm', true, true);
expect(surinToSaanenGoatFarmViaDij?.minPath.map(v => v.id)).toEqual(expected2);
expect(surinToSaanenGoatFarmViaDij?.minDist).toBe(25.2);

JS

DirectedGraph
const {DirectedGraph, DirectedVertex, DirectedEdge} = require('data-structure-typed');
// /* or if you prefer */ const {DirectedGraph, DirectedVertex, DirectedEdge} = require('graph-typed');

const graph = new DirectedGraph();
const vertexA = new DirectedVertex('A');
const vertexB = new DirectedVertex('B');
const vertexC = new DirectedVertex('C');
const edgeAB = new DirectedEdge('A', 'B');
const edgeBC = new DirectedEdge('B', 'C');

graph.addVertex(vertexA);
graph.addVertex(vertexB);
graph.addVertex(vertexC);
graph.addEdge(edgeAB);
graph.addEdge(edgeBC);

const topologicalOrder = graph.topologicalSort();
if (topologicalOrder) expect(topologicalOrder).toEqual(['A', 'B', 'C'])
MapGraph
const {MapGraph, MapVertex} =  require('data-structure-typed');
// /* or if you prefer */ const {MapGraph, MapVertex} = require('graph-typed');

const mapGraph = new MapGraph([5.500338, 100.173665]);

mapGraph.addVertex(new MapVertex('Surin', 5.466724, 100.274805));
mapGraph.addVertex(new MapVertex('Batu Feringgi Beach', 5.475141, 100.276670));
mapGraph.addVertex(new MapVertex('Lotus', 5.459044, 100.308767));
mapGraph.addVertex(new MapVertex('The Breeza', 5.454197, 100.307859));
mapGraph.addVertex(new MapVertex('Hard Rock Hotel', 5.467850, 100.241876));
mapGraph.addVertex(new MapVertex('Mira', 5.456749, 100.286650));
mapGraph.addVertex(new MapVertex('Penang Bible Church', 5.428683, 100.314825));
mapGraph.addVertex(new MapVertex('Queensbay', 5.332760, 100.306651));
mapGraph.addVertex(new MapVertex('Saanen Goat Farm', 5.405738, 100.207699));
mapGraph.addVertex(new MapVertex('Trinity Auto', 5.401126, 100.303739));
mapGraph.addVertex(new MapVertex('Penang Airport', 5.293185, 100.265772));
mapGraph.addEdge('Surin', 'Lotus', 4.7);
mapGraph.addEdge('Lotus', 'The Breeza', 1);
mapGraph.addEdge('Batu Feringgi Beach', 'Hard Rock Hotel', 5.2);
mapGraph.addEdge('Surin', 'Mira', 2.8);
mapGraph.addEdge('Mira', 'Penang Bible Church', 7.0);
mapGraph.addEdge('Lotus', 'Penang Bible Church', 5.7);
mapGraph.addEdge('Penang Bible Church', 'Queensbay', 13.9);
mapGraph.addEdge('Hard Rock Hotel', 'Saanen Goat Farm', 18.5);
mapGraph.addEdge('The Breeza', 'Trinity Auto', 9.1);
mapGraph.addEdge('Trinity Auto', 'Saanen Goat Farm', 26.3);
mapGraph.addEdge('The Breeza', 'Penang Airport', 24.8);
mapGraph.addEdge('Penang Airport', 'Saanen Goat Farm', 21.2);
const expected1 = ['Surin', 'Lotus', 'The Breeza', 'Trinity Auto', 'Saanen Goat Farm'];

const minPathBetween = mapGraph.getMinPathBetween('Surin', 'Saanen Goat Farm');
expect(minPathBetween?.map(v => v.id)).toEqual(expected1);
const surinToSaanenGoatFarmDij = mapGraph.dijkstra('Surin', 'Saanen Goat Farm', true, true);
expect(surinToSaanenGoatFarmDij?.minPath.map(v => v.id)).toEqual(expected1);
expect(surinToSaanenGoatFarmDij?.minDist).toBe(41.1);
mapGraph.addEdge('Surin', 'Batu Feringgi Beach', 1.5);
const expected2 = ['Surin', 'Batu Feringgi Beach', 'Hard Rock Hotel', 'Saanen Goat Farm'];
const minPathBetweenViaBFB = mapGraph.getMinPathBetween('Surin', 'Saanen Goat Farm', true);
expect(minPathBetweenViaBFB?.map(v => v.id)).toEqual(expected2);
const surinToSaanenGoatFarmViaDij = mapGraph.dijkstra('Surin', 'Saanen Goat Farm', true, true);
expect(surinToSaanenGoatFarmViaDij?.minPath.map(v => v.id)).toEqual(expected2);
expect(surinToSaanenGoatFarmViaDij?.minDist).toBe(25.2);

API docs & Examples

API Docs

Live Examples

Examples Repository

Data Structures

Data Structure Unit Test Performance Test API Docs
Binary Tree Binary Tree
Binary Search Tree (BST) BST
AVL Tree AVLTree
Red Black Tree RedBlackTree
Tree Multiset TreeMultimap
Segment Tree SegmentTree
Binary Indexed Tree BinaryIndexedTree
Heap Heap
Priority Queue PriorityQueue
Max Priority Queue MaxPriorityQueue
Min Priority Queue MinPriorityQueue
Trie Trie
Graph AbstractGraph
Directed Graph DirectedGraph
Undirected Graph UndirectedGraph
Queue Queue
Deque Deque
Linked List SinglyLinkedList
Singly Linked List SinglyLinkedList
Doubly Linked List DoublyLinkedList
Stack Stack

Standard library data structure comparison

Data Structure Typed C++ STL java.util Python collections
Heap<E> priority_queue<T> PriorityQueue<E> heapq
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> - -
- 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> -
Set<E> - HashSet<E> set
Map<K, V> - HashMap<K, V> dict
- unordered_set<T> HashSet<E> -
Map<K, V> - - OrderedDict
- unordered_multiset - Counter
- - LinkedHashSet<E> -
HashMap<K, V> - LinkedHashMap<K, V> -
- unordered_multimap<K, V> - -
- bitset<N> - -

Benchmark

avl-tree
test nametime taken (ms)executions per secsample deviation
10,000 add randomly31.3231.933.67e-4
10,000 add & delete randomly70.9014.100.00
10,000 addMany40.5824.644.87e-4
10,000 get27.3136.622.00e-4
binary-tree
test nametime taken (ms)executions per secsample deviation
1,000 add randomly12.3580.997.17e-5
1,000 add & delete randomly15.9862.587.98e-4
1,000 addMany10.9691.270.00
1,000 get18.6153.730.00
1,000 dfs164.206.090.04
1,000 bfs58.8417.000.01
1,000 morris256.663.907.70e-4
bst
test nametime taken (ms)executions per secsample deviation
10,000 add randomly31.5931.662.74e-4
10,000 add & delete randomly74.5613.418.32e-4
10,000 addMany29.1634.300.00
10,000 get29.2434.210.00
rb-tree
test nametime taken (ms)executions per secsample deviation
100,000 add85.8511.650.00
100,000 add & delete randomly211.544.730.00
100,000 getNode37.9226.371.65e-4
comparison
test nametime taken (ms)executions per secsample deviation
SRC PQ 10,000 add0.571748.734.96e-6
CJS PQ 10,000 add0.571746.694.91e-6
MJS PQ 10,000 add0.571749.684.43e-6
SRC PQ 10,000 add & pop3.47288.146.38e-4
CJS PQ 10,000 add & pop3.39295.363.90e-5
MJS PQ 10,000 add & pop3.37297.173.03e-5
directed-graph
test nametime taken (ms)executions per secsample deviation
1,000 addVertex0.109534.938.72e-7
1,000 addEdge6.30158.670.00
1,000 getVertex0.052.16e+43.03e-7
1,000 getEdge22.3144.820.00
tarjan210.904.740.01
tarjan all214.724.660.01
topologicalSort172.525.800.00
hash-map
test nametime taken (ms)executions per secsample deviation
1,000,000 set275.883.620.12
1,000,000 Map set211.664.720.01
1,000,000 Set add177.725.630.02
1,000,000 set & get317.603.150.02
1,000,000 Map set & get274.993.640.03
1,000,000 Set add & has172.235.810.02
1,000,000 ObjKey set & get929.401.080.07
1,000,000 Map ObjKey set & get310.023.230.05
1,000,000 Set ObjKey add & has283.283.530.04
heap
test nametime taken (ms)executions per secsample deviation
10,000 add & pop5.80172.358.78e-5
10,000 fib add & pop357.922.790.00
doubly-linked-list
test nametime taken (ms)executions per secsample deviation
1,000,000 push221.574.510.03
1,000,000 unshift229.024.370.07
1,000,000 unshift & shift169.215.910.02
1,000,000 insertBefore314.483.180.07
singly-linked-list
test nametime taken (ms)executions per secsample deviation
10,000 push & pop212.984.700.01
10,000 insertBefore250.683.990.01
max-priority-queue
test nametime taken (ms)executions per secsample deviation
10,000 refill & poll8.91112.292.26e-4
priority-queue
test nametime taken (ms)executions per secsample deviation
100,000 add & pop103.599.650.00
deque
test nametime taken (ms)executions per secsample deviation
1,000,000 push14.5568.726.91e-4
1,000,000 push & pop23.4042.735.94e-4
1,000,000 push & shift24.4140.971.45e-4
1,000,000 unshift & shift22.5644.321.30e-4
queue
test nametime taken (ms)executions per secsample deviation
1,000,000 push39.9025.070.01
1,000,000 push & shift81.7912.230.00
stack
test nametime taken (ms)executions per secsample deviation
1,000,000 push37.6026.600.00
1,000,000 push & pop47.0121.270.00
trie
test nametime taken (ms)executions per secsample deviation
100,000 push45.9721.760.00
100,000 getWords66.2015.110.00

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

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.