https://github.com/avoidwork/tiny-graph

Tiny graph data structure for Client or Server
https://github.com/avoidwork/tiny-graph

Last synced: about 2 months ago
JSON representation

Tiny graph data structure for Client or Server

• Host: GitHub
• URL: https://github.com/avoidwork/tiny-graph
• Owner: avoidwork
• License: bsd-3-clause
• Created: 2014-12-18T00:22:17.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-05-05T14:26:42.000Z (over 6 years ago)
• Last Synced: 2024-07-23T13:04:54.114Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://avoidwork.github.io/tiny-graph
• Size: 309 KB
• Stars: 74
• Watchers: 6
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tiny-graph

[![build status](https://secure.travis-ci.org/avoidwork/tiny-graph.svg)](http://travis-ci.org/avoidwork/tiny-graph)

Tiny graph data structure for Client or Server

## Example

```javascript

const graph = require('tiny-graph'),

    g = graph();

g.setNodeValue('f', 3);

g.setNodeValue('h', 21);

g.add('f', 'h');

g.setEdgeValue('f', 'h', 100);

console.log(g.adjacent('f', 'h')); // true

console.log(g.neighbors('f')); // ['h']

console.log(g.getEdgeValue('f', 'h')); // 100

```

## How can I use tiny-graph?

tiny-graph can be installed from npm & bower, and supports AMD loaders or script tags (`window.graph`).

## API

#### add(x, y)

Adds the edge from `x` to `y`, if it is not there

#### adjacent(x, y)

Tests whether there is an edge from node `x` to node `y`

#### del(x, y)

Removes the edge from `x` to `y`, if it is there

#### delNode(x)

Removes node `x` from the graph, if it is there

#### fromJSON(arg)

Deserializes arg as the graph

#### getEdgeValue(x, y)

Returns the value associated to the edge (`x`, `y`)

#### getNodeValue(x)

Returns the value associated with the node `x`

#### neighbors(x)

Lists all nodes `y` such that there is an edge from `x` to `y`

#### setEdgeValue(x, y, v)

Sets the value associated to the edge (`x`, `y`) to `v`

#### setNodeValue(x, v)

Sets the value associated with the node `x` to `v`

#### toJSON()

Serializes the graph as JSON

## License

Copyright (c) 2018 Jason Mulligan

Licensed under the BSD-3 license