Alice

Alice, a simple and performant data structure for bipartite graphs with integer values as vertices.

Install

$ npm install alice [-g]

require:

var Alice  = require( 'alice' );

Run Tests

to run all test files, install devDependecies:

 $ cd alice/
 # install or update devDependecies
 $ npm install 
 # run tests
 $ npm test

Constructor

Alice()
// or
new Alice()

Properties

/*
 * total edges
 */
Alice.edges : Number

/*
 * graph edges
 */
Alice.e : Number

/*
 * graph vertices
 */
Alice.v : Number

Methods

Arguments between [] are optional.

/*
 * Add an edge to the graph. 
 */
Alice#add : function ( Number x, Number y [, Boolean strict [, Object label ] ] ) : Number

/*
 * Cut an edge from the graph.
 */
Alice#cut : function ( Number x, Number y ) : Number

/*
 * Clear edges and vertices.
 */
Alice#fire : function () : Alice

/*
 * Prune edges to test graph acyclicity.
 * It optionally returns every edge as a single array [ x, y ]
 */
Alice#prune : function ( [ Boolean edge_as_array ] ) : Array

/*
 * Perform A Depth-First Search starting from the input vertex.
 * It returns a list of vertices
 */
Alice#depth : function ( Number x ) : Array

/*
 * Perform A Breadth-First Search starting from the input vertex.
 * It returns a list of vertices
 */
Alice#breadth : function ( Number x ) : Array

/*
 * It returns the list of edges
 */
Alice#elist() : function () : Array

MIT License

Copyright (c) 2015-present < Guglielmo Ferri : [email protected] >

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 OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.