Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Simple directed and undirected graph library in Javascript.

tag: v0.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

GraphJS

GraphJS is a simple Javascript library for manipulating directed and undirected graphs.

Your graphs may have self edges, weighted edges, and directed edges, but not multiedges.

Usage

Creating, reading, updating, and deleting edges (CRUD)

var g = new Graph();

g.set('a', 'b', 3); # creates edge (a, b) with weight 3
g.get('a', 'b'); # returns 3

g.set('a', 'b', 4); # changes (a, b) weight to 4
g.get('a', 'b'); # returns 4

g.del('a', 'b'); # removes edge (a, b)
g.get('a', 'b'); # returns undefined

Constructing graphs from data

new Graph({
  a: ['b', 'c'],
  c: ['d'],
}); # triangle with vertices a, b, and c

new Graph({
  a: {b: 2},
  b: {c: 3},
}); # path with vertices a, b, c and weights (a, b) = 2, (b, c) = 3

Degree, size, order, and adjacency

var g = new Graph({
  a: ['b'],
  b: ['c'],
}); # path with vertices a, b, c

g.degree('a'); # returns 1
g.degree('b'); # returns 2
g.degree('c'); # returns 1

g.size(); # returns 2, the number of edges

g.order(); # returns 3, the number of vertices

for (v in g.adj('b')) {
  # v = a, c (in no particular order)
}

Creating directed edges

var g = new Graph();
g.dir('a', 'b'); # a ~ b, but b !~ a
g.has('a', 'b'); # true
g.has('b', 'a'); # false

Deleting directed edges

var g = new Graph();
g.set('a', 'b'); # a ~ b, and b ~ a
g.deldir('b', 'a'); # remove b ~ a
g.has('a', 'b'); # true
g.has('b', 'a'); # false

Copying

var g = new Graph({
  a: ['b', 'c'],
  c: ['d'],
});

var h = g.copy(); # an independent copy of g

Directed edges and graph size

You may mix directed and undirected edges in the same graph.

A pair of directed edges (a, b) and (b, a) is always collapsed into an undirected edge. An undirected edge (a, b) may be expanded into a directed edge (a, b) by deleting the directed edge (b, a) with deldir(b, a).

For consistency, the size of a graph is defined to be the number of undirected edges plus the number of directed edges. In other words, two distinct directed edges between two distinct vertices do not count twice for the size.

A directed self edge is indistinguishable from an undirected self edge.

Tests

GraphJS is packaged with QUnit tests. To run the tests, load the graphjs/test/all.html page in your favorite browser.

Tests completed in 88 milliseconds.
0 tests of 160 failed.

Narwhal

You can run the individual tests with narwhal.

$ narwhal -m test test/core.js
+ Running test/core.js
Passes: 24, Fails: 0, Errors: 0

Or all tests.

$ narwhal test/all.js
+ Running
Passes: 24, Fails: 0, Errors: 0
+ Running
Passes: 14, Fails: 0, Errors: 0

Node

You can run the individual tests with node.

$ node test/core.js

Or all tests.

$ node test/all.js
Something went wrong with that request. Please try again.