redblack2

redblack.js
===========

redblack.js is a red-black tree implementation for Node.js and the browser.

Usage
-----

var tree = redblack.tree();

tree.insert('foo', 'bar');
tree.get('foo'); // -> 'bar'

tree.delete('foo');
tree.get('foo'); // -> null

tree.forEach(function(value, key) {
console.log(key + '=' + value);
});

Download
--------

Releases are available on GitHub
or via NPM.

npm install redblack

Development: redblack.js

Production: redblack.min.js

Tree API
--------

$3

Insert the given key/value pair into the tree.

Arguments:

* key
* value

$3

Get the value mapped to the given key or null if no such value exists.

Arguments:

* key

$3

Remove the given key from the tree

Arguments:

* key

$3

Returns a Cursor (see below) for traversing the tree in the given range (inclusive).

Arguments:

* start - the lower bound of the range, if undefined then assumed to be the minimum value in the tree
* end - the upper bound of the range, if undefined the assumed to be the maximum value in the tree

$3

Cursor shortcut for iterating over the entire tree (see forEach below).

$3

Cursor shortcut for mapping over the entire tree (see map below).

Cursor API
----------

$3

Iterate over a set of nodes in order.

Arguments:

* iterator(value, key, tree)

$3

Map over a set of nodes in order.

Arguments:

* iterator(value, key, tree) - should return a result