graph-typed

Version:

Graph data structure.

data-structure-typed-docs.vercel.app

zrwusa/data-structure-typed

114 lines • 81.5 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>graph-typed</title><meta name="description" content="Documentation for graph-typed"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base="."> <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <div class="field"> <div id="tsd-toolbar-links"></div></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">graph-typed</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header> <div class="container container-main"> <div class="col-content"> <div class="tsd-page-title"> <h2>graph-typed</h2></div> <div class="tsd-panel tsd-typography"><a id="md:what" class="tsd-anchor"></a><h1><a href="#md:what">What</a></h1><a id="md:brief" class="tsd-anchor"></a><h2><a href="#md:brief">Brief</a></h2>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 <a href="https://www.npmjs.com/package/data-structure-typed">data-structure-typed</a> package <a id="md:how" class="tsd-anchor"></a><h1><a href="#md:how">How</a></h1><a id="md:install" class="tsd-anchor"></a><h2><a href="#md:install">install</a></h2><a id="md:npm" class="tsd-anchor"></a><h3><a href="#md:npm">npm</a></h3><pre><code class="language-bash">npm i graph-typed --save </code><button>Copy</button></pre> <a id="md:yarn" class="tsd-anchor"></a><h3><a href="#md:yarn">yarn</a></h3><pre><code class="language-bash">yarn add graph-typed </code><button>Copy</button></pre> <a id="md:methods" class="tsd-anchor"></a><h3><a href="#md:methods">methods</a></h3>Directed Graph <img src="https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/methods-8bit/directed-graph.png?raw=true" alt="directed-graph"> Undirected Graph <img src="https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/methods-8bit/undirected-graph.png?raw=true" alt="undirected-graph"> <a id="md:snippet" class="tsd-anchor"></a><h3><a href="#md:snippet">snippet</a></h3><a id="md:ts" class="tsd-anchor"></a><h4><a href="#md:ts">TS</a></h4><a id="md:directedgraph" class="tsd-anchor"></a><h5><a href="#md:directedgraph">DirectedGraph</a></h5><pre><code class="language-typescript">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']) </code><button>Copy</button></pre> <a id="md:mapgraph" class="tsd-anchor"></a><h5><a href="#md:mapgraph">MapGraph</a></h5><pre><code class="language-typescript">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); </code><button>Copy</button></pre> <a id="md:js" class="tsd-anchor"></a><h4><a href="#md:js">JS</a></h4><a id="md:directedgraph-1" class="tsd-anchor"></a><h5><a href="#md:directedgraph-1">DirectedGraph</a></h5><pre><code class="language-typescript">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']) </code><button>Copy</button></pre> <a id="md:mapgraph-1" class="tsd-anchor"></a><h5><a href="#md:mapgraph-1">MapGraph</a></h5><pre><code class="language-javascript">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); </code><button>Copy</button></pre> <a id="md:api-docs-amp-examples" class="tsd-anchor"></a><h2><a href="#md:api-docs-amp-examples">API docs & Examples</a></h2><a href="https://data-structure-typed-docs.vercel.app">API Docs</a> <a href="https://data-structure-typed-examples.vercel.app">Live Examples</a> <a href="https://github.com/zrwusa/data-structure-typed-examples" target="_blank">Examples Repository</a> <a id="md:data-structures" class="tsd-anchor"></a><h2><a href="#md:data-structures">Data Structures</a></h2><table> <thead> <tr> <th>Data Structure</th> <th>Unit Test</th> <th>Performance Test</th> <th>API Documentation</th> <th>Implemented</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">Binary Tree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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">BST</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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">AVLTree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Tree Multiset</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/TreeMultiset.html">TreeMultiset</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></td> </tr> <tr> <td>Segment Tree</td> <td></td> <td></td> <td><a href="https://data-structure-typed-docs.vercel.app/classes/SegmentTree.html">SegmentTree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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">BinaryIndexedTree</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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">AbstractGraph</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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">DirectedGraph</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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">UndirectedGraph</a></td> <td><img src="https://raw.githubusercontent.com/zrwusa/assets/master/images/data-structure-typed/assets/tick.svg" alt=""></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