Graph Class for JavaScript

Installation

Using npm:

$ npm install undirected-graph

You can download the last stable version from the releases page

Description

This project provides a Graph class that works for Node.js.

Creates an Graph data structure with basic functionality, add vertex/edge allowing nodes of any type.

Graph constructor

• require('undirected-graph') creates an empty graph

Graph methods

• addEdge(A, B) returns the value stored for that key.
• toString() returns the associations between nodes (connected neighbours).
• getVertices() returns the vertices in the graph

Examples

Assume this for all examples below

var graph = require('undirected-graph');

If you're using this within Node, you first need to import the class

var graph = require('undirected-graph');

Basic use case

var graph = require('undirected-graph');

Map size / number of elements

var graph = require('undirected-graph');
 
graph.addEdge(1, 3);  
graph.addEdge(1, 4);  
graph.addEdge(1, 5);  
graph.addEdge(2, 3);  
graph.toString();
 
 
//Graph associations (connected neighbours).
 
1: 3 4 5  
2: 3  
3: 1 2  
4: 1 
5: 1

LICENSE

The MIT License (MIT)

Copyright (c) 2019 Marty Jacobs

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF

To-Do

• Remove functionality for nodes