chenglou / data-structures

Fast, light and hassle-free JavaScript data structures, written in CoffeeScript.

Data Structures

Fast, light and hassle-free JavaScript data structures, written in CoffeeScript.

• (Hash) Map
• Heap
• Graph
• (Doubly) Linked List
• Queue
• Self-Balancing Binary Search Tree (Red-Black Tree)
• Trie

Installation and Usage

Server-side:

Using npm:

npm install data-structures

Then where needed:

var Heap = require('data-structures').Heap;
var heap = new Heap();
heap.add(3);
heap.removeMin();

Alternatively, you can directly use the compiled JavaScript version in the "distribution" folder. It's always in sync with the CoffeeScript one.

Client-side:

Using Bower:

bower install data-structures

Or if you prefer a more traditional approach, Get the whole file here. Either use the development version or the minified production version.

Then put the file in your HTML page,

<script src="path/to/dataStructure/file"></script>
<script>
    var Heap = require("data-structures").Heap;
    var heap = new Heap();
    heap.add(3);
    heap.removeMin();
</script>

(Magical client-side require()) courtesy of Browserify.

Documentation

Wiki page

The wiki page is a formatted version of the documentation in the code.

Roadmap

For Contributors

Install the npm development dependencies:

npm install

Then, with Grunt:

grunt test

Build JavaScript for server-side and browser

Note that if it's a pull request you'd like to submit, ignore this section. The code will be rebuilt after the pull anyways.

Feel free to modify the source code and rebuild it for your own needs:

grunt

This will take care of compiling CoffeeScript into JavaScript and, if needed, bundle them for the browser.

License

MIT.

data-structures's Issues

Question: How to translate "require" statement into "import" statement

Hi, I am trying to use the Map class in an ES6 project and I am running into some problem with importing the Map class.

ES5
In the ES5 version of my code I was able to require the class by calling the following:
var Map = require('data-structures').Map; //data-structures was installed by npm

then I was able to initiate and then use the class by calling new Map();

ES6
Now when I try to convert the code above to an import statement, I tried the following:

1

import Map from 'data-structures';
then through the same new Map(); call,
then I would get a _dataStructures2.default is not a constructor error

2

import { Map } from 'data-structures';
then through same new Map(); call,
then I would get a _dataStructures.Map is not a constructor error

3

import * as dataStructures from 'data-structures';
then I call this.myMap = dataStructures.Map;
but this.myMap will be undefined and my dataStructures looks like this:

I can't figure out a way to translate the require().Map statement into an import statement. Someone has run into a similar problem, but since the export statement of the Map class is different from what is described in the solution, I was not able to use it in my code.

Any help/advice on how I can translate the require into import will be appreciated!

jshint

Breaking this library into subcomponents or not?

Will leave this issue open for library users.

Full rewrite in JS or not?

Kind of a sensational title, since it'd mostly just be taking the compiled js and format it a bit. But this might help adoption.

Graph edgeSize is not always correct

I think there is a Bug by decreasing edgeSize after removing multiple nodes at the same time. edgeCount of nodes has incorrect value after deleting a neighbor node.

The following test fails:

describe "Another tricky test -- ",->
  it "edgeSize after adding and removing nodes",->
    graph = new Graph();
    expect(graph.addNode "1").toBeDefined()
    expect(graph.addNode "2").toBeDefined()
    expect(graph.addNode "3").toBeDefined()
    expect(graph.addNode "4").toBeDefined()
    expect(graph.addNode "5").toBeDefined()
    expect(graph.addEdge "1", "2").toBeDefined()
    expect(graph.addEdge "2", "4").toBeDefined()
    expect(graph.addEdge "2", "3").toBeDefined()
    expect(graph.addEdge "2", "5").toBeDefined()
    expect(graph.addEdge "5", "4").toBeDefined()
    expect(graph.addEdge "1", "3").toBeDefined()
    ###
    1 -> 2 ->  4
     \   | \   ^
      \  |  \  |
       ˅ ˅   ˅ |
         3     5
    ###

    expect(graph.removeNode "2").toBeDefined()
    expect(graph.removeNode "1").toBeDefined()
    ###
          4
          ^
          |
          |
    3     5
    ###
    expect(graph.edgeSize).toBe 1 ## Bug edgeSize = 0
    expect(graph.nodeSize).toBe 3

Request: Priority Queue

As the title says.
I would love to see a Priority Queue too! :)
See http://rosettacode.org/wiki/Priority_queue#CoffeeScript

precompile to javascript and remove coffee-script dependency

Including coffee-script as dependency adds serious bulk when using some package managers.
You should compile before publishing. Example:
https://github.com/aldonline/notifying.js

Doubly linked lists?

Request: Interval tree

Hey there,

I'd love to see an easy to use interval tree for javascript as there don't seem to be any out there currently that are working/supported.

Perhaps https://github.com/shinout/interval-tree2 could be used as a starting point, seeing how it's written in coffeescript.

Thanks so much!
Thomas