Giter VIP home page Giter VIP logo

fingertree.js's Introduction

FingerTree.js

Build Status

Implementation of Finger Tree, an immutable general-purpose data structure which can further be used to implement random-access sequences, priority-queues, ordered sequences, interval trees, etc.

Based on: Ralf Hinze and Ross Paterson, "Finger trees: a simple general-purpose data structure".

Note that Finger Tree is not meant to be used on its own. Instead, it should serve as an infrastructure for building other data structures. As an example, immutable-sequence.js is an immutable random-access sequence implementation built on top of this library.

Installation (Browser)

Download the js file and include it in your web page.

<script type="text/javascript" src="./fingertree.js"></script>

Installation (Node.js)

If you want to use it in Node.js, you may install it via npm.

npm install fingertree

Then, in your program:

var FingerTree = require('fingertree');

Quick Examples

// Create a finger-tree from an array
// By default, the tree is annotated with a size measurer.
var tree = FingerTree.fromArray([1, 2, 3, 4]);
tree.measure(); // 4

tree.peekFirst(); // 1
tree.peekLast();  // 4

// Create a new tree with an element added to the front
var tree2 = tree.addFirst(0);
tree2.peekFirst(); // 0

// Create a new tree with an element added to the end
var tree3 = tree.addLast(5);
tree3.peekLast(); // 5

// Create a new tree with the first element removed
var tree4 = tree.removeFirst();
tree4.peekFirst(); // 2

// Create a new tree with the last element removed
var tree5 = tree.removeLast();
tree5.peekLast(); // 3

// Split into two trees with a predicate on measure.
var split = tree.split(function (measure) {
  return measure > 3;
});
split[0].measure(); // 3
split[1].measure(); // 1


// Create a finger-tree with a custom measurer.
var measurer = {
  identity: function () {
    return -Infinity;
  },
  measure: function (x) {
    return x;
  },
  sum: function (a, b) {
    return Math.max(a, b);
  }
};
var maxTree = FingerTree.fromArray([1, 3, 2, 9, 7], measurer);
maxTree.measure(); // 9

License

MIT License

© 2014 Xueqiao Xu <[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.

fingertree.js's People

Contributors

qiao avatar zot avatar

Watchers

dieface avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.