# aureooms-js-graph-spec

> Graph specification code bricks for JavaScript

Latest version **5.0.2** (published 2015-08-17) · AGPL-3.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install aureooms-js-graph-spec
pnpm add aureooms-js-graph-spec
yarn add aureooms-js-graph-spec
bun add aureooms-js-graph-spec
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 5.0.2 |
| Published | 2015-08-17 |
| First published | 2015-07-18 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | aureooms |
| Maintainers | aureooms |
| Keywords | bricks, directed, ender, graph, javascript, js, spec, specification, undirected |

## Links

- npm: https://www.npmjs.com/package/aureooms-js-graph-spec
- Repository: https://github.com/aureooms/js-graph-spec
- Homepage: http://aureooms.github.io/js-graph-spec/
- Issues: https://github.com/aureooms/js-graph-spec/issues
- npm.io page: https://npm.io/package/aureooms-js-graph-spec

## Dependencies (4)

- [aureooms-js-type](https://npm.io/package/aureooms-js-type.md) ^1.0.4
- [aureooms-js-itertools](https://npm.io/package/aureooms-js-itertools.md) ^1.2.0
- [aureooms-js-cardinality](https://npm.io/package/aureooms-js-cardinality.md) ^1.1.0
- [aureooms-js-collections](https://npm.io/package/aureooms-js-collections.md) ^1.0.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 5.0.2 (latest) — 2015-08-17
- 5.0.1 — 2015-08-13
- 5.0.0 — 2015-08-13
- 4.0.0 — 2015-08-13
- 3.0.0 — 2015-08-13
- 2.0.1 — 2015-08-11
- 2.0.0 — 2015-08-11
- 1.0.3 — 2015-08-10
- 1.0.2 — 2015-08-10
- 1.0.1 — 2015-08-04
- 1.0.0 — 2015-07-18
- 0.0.1 — 2015-07-18

## README

[js-graph-spec](http://aureooms.github.io/js-graph-spec)
==

Graph specification code bricks for JavaScript. Parent is
[js-gn](https://github.com/aureooms/js-gn).

```js
graphspec.Graph( "My graph implementation" , MyGraphConstructor ) ;
```

[![NPM license](http://img.shields.io/npm/l/aureooms-js-graph-spec.svg?style=flat)](https://raw.githubusercontent.com/aureooms/js-graph-spec/master/LICENSE)
[![NPM version](http://img.shields.io/npm/v/aureooms-js-graph-spec.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-graph-spec)
[![Bower version](http://img.shields.io/bower/v/aureooms-js-graph-spec.svg?style=flat)](http://bower.io/search/?q=aureooms-js-graph-spec)
[![Build Status](http://img.shields.io/travis/aureooms/js-graph-spec.svg?style=flat)](https://travis-ci.org/aureooms/js-graph-spec)
[![Coverage Status](http://img.shields.io/coveralls/aureooms/js-graph-spec.svg?style=flat)](https://coveralls.io/r/aureooms/js-graph-spec)
[![Dependencies Status](http://img.shields.io/david/aureooms/js-graph-spec.svg?style=flat)](https://david-dm.org/aureooms/js-graph-spec#info=dependencies)
[![devDependencies Status](http://img.shields.io/david/dev/aureooms/js-graph-spec.svg?style=flat)](https://david-dm.org/aureooms/js-graph-spec#info=devDependencies)
[![Code Climate](http://img.shields.io/codeclimate/github/aureooms/js-graph-spec.svg?style=flat)](https://codeclimate.com/github/aureooms/js-graph-spec)
[![NPM downloads per month](http://img.shields.io/npm/dm/aureooms-js-graph-spec.svg?style=flat)](https://www.npmjs.org/package/aureooms-js-graph-spec)
[![GitHub issues](http://img.shields.io/github/issues/aureooms/js-graph-spec.svg?style=flat)](https://github.com/aureooms/js-graph-spec/issues)
[![Inline docs](http://inch-ci.org/github/aureooms/js-graph-spec.svg?branch=master&style=shields)](http://inch-ci.org/github/aureooms/js-graph-spec)

Can be managed through [jspm](https://github.com/jspm/jspm-cli),
[duo](https://github.com/duojs/duo),
[component](https://github.com/componentjs/component),
[bower](https://github.com/bower/bower),
[ender](https://github.com/ender-js/Ender),
[jam](https://github.com/caolan/jam),
[spm](https://github.com/spmjs/spm),
and [npm](https://github.com/npm/npm).

## Install

### jspm
```terminal
jspm install github:aureooms/js-graph-spec
# or
jspm install npm:aureooms-js-graph-spec
```
### duo
No install step needed for duo!

### component
```terminal
component install aureooms/js-graph-spec
```

### bower
```terminal
bower install aureooms-js-graph-spec
```

### ender
```terminal
ender add aureooms-js-graph-spec
```

### jam
```terminal
jam install aureooms-js-graph-spec
```

### spm
```terminal
spm install aureooms-js-graph-spec --save
```

### npm
```terminal
npm install aureooms-js-graph-spec --save
```

## Require
### jspm
```js
let graphspec = require( "github:aureooms/js-graph-spec" ) ;
// or
import graphspec from 'aureooms-js-graph-spec' ;
```
### duo
```js
let graphspec = require( "aureooms/js-graph-spec" ) ;
```

### component, ender, spm, npm
```js
let graphspec = require( "aureooms-js-graph-spec" ) ;
```

### bower
The script tag exposes the global variable `graphspec`.
```html
<script src="bower_components/aureooms-js-graph-spec/js/dist/graph-spec.min.js"></script>
```
Alternatively, you can use any tool mentioned [here](http://bower.io/docs/tools/).

### jam
```js
require( [ "aureooms-js-graph-spec" ] , function ( graphspec ) { ... } ) ;
```

## Signatures

### Graphs, DiGraphs, MultiGraphs, and MultiDiGraphs

#### `Graph`, `DiGraph`, `MultiGraph`, or `MultiDiGraph`

Create a new graph.

```js
let G = new Graph( ) ;
// ...
let G = new DiGraph( ) ;
// ...
let G = new MultiGraph( ) ;
// ...
let G = new MultiDiGraph( ) ;
// ...
```

#### `vadd`

Add a vertex to graph `G`.

```js
let u = G.vadd( ) ;
```

#### `vdel`

Delete vertex `u` from graph `G`.

```js
G.vdel( u ) ;
```

#### `eadd`

Add edge `(u,v)` to graph `G`.

```js
let e = G.eadd( u , v ) ;
```

#### `edel`

Delete edge `e` from graph `G`.

```js
G.edel( e ) ;
```

#### `vitr`

Get an iterator over vertex references in graph `G`.

```js
for ( let u of G.vitr( ) ) ... ;
```

#### `eitr`

Get an iterator over edge references in graph `G`.

```js
for ( let e of g.eitr( ) ) ... ;
```

#### `iitr`

Get an iterator over edge references of edges incident to `u` in graph `G`.

```js
for ( let e of G.iitr( u ) ) ... ;
```


#### `nitr`

Get an iterator over vertex references of neighbors of `u` in graph `G`.

```js
for ( let v of G.nitr( u ) ) ... ;
```

#### `vertices`

Get an iterator over vertices in graph `G`.

```js
for ( let u of G.vertices( ) ) ... ;
```

#### `edges`

Get an iterator over edges in graph `G`.

```js
for ( let [ u , v , e ] of G.edges( ) ) ... ;
```

#### `incident`

Get an iterator over edges incident to `w` in graph `G`.

```js
for ( let [ u , v , e ] of G.incident( w ) ) ... ;
```

#### `endpoints`

Get endpoints `u` and `v` of an edge reference `e` in graph `G`.

```js
let [ u , v ] = G.endpoints( e ) ;
```

### DiGraphs and MultiDiGraphs

These methods must also be implemented (with the same invariants)
in Graphs and MultiGraphs for convenience.

#### `initr`

Get an iterator over edge references of ingoing edges of `u` in graph `G`.

```js
for ( let e of G.initr( u ) ) ... ;
```

#### `outitr`

Get an iterator over edge references of outgoing edges of `u` in graph `G`.

```js
for ( let e of G.outitr( u ) ) ... ;
```

#### `dpitr`

Get an iterator over direct predecessors of `u` in graph `G`.

```js
for ( let v of G.dpitr( u ) ) ... ;
```

#### `dsitr`

Get an iterator over direct successors of `u` in graph `G`.

```js
for ( let v of G.dsitr( u ) ) ... ;
```

#### `ingoing`

Get an iterator over ingoing edges of `w` in graph `G`.
The invariant `v === w` must hold.

```js
for ( let [ u , v , e ] of G.ingoing( w ) ) ... ;
```

#### `outgoing`

Get an iterator over outgoing edges of `w` in graph `G`.
The invariant `u === w` must hold.

```js
for ( let [ u , v , e ] of G.outgoing( w ) ) ... ;
```

#### `reverse`

Reverse the directions of edges in  `G`.

```js
G.reverse( ) ;
```

---
_Source: https://npm.io/package/aureooms-js-graph-spec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._