Giter VIP home page Giter VIP logo

binary-heap's Introduction

A coffeescript implementation of a binary heap for node.js.

var {BinaryHeap} = require('binary-heap')
var heap = new BinaryHeap
heap.push(5, 4, 1, 3, 2)

heap.pop() // 1
heap.pop() // 2
heap.pop() // 3
heap.pop() // 4
heap.pop() // 5

new BinaryHeap()

Allocates a new binary heap with the default comparison function. Items added to the heap will be sorted from min-to-max.

var heap = new BinaryHeap
heap.push(3, 2, 1)
heap.pop() // 1
heap.pop() // 2
heap.pop() // 3

new BinaryHeap(compareFn)

Allocates a new binary heap with the provided custom comparison function. The comparison function should accept two arguments, and return true or false.

var heap = new BinaryHeap(function(x, y) { return x > y })
heap.push(1, 2, 3)
heap.pop() // 3
heap.pop() // 2
heap.pop() // 1

heap.push(item, [...])

Inserts an item into its proper position on the heap. Also accepts multiple arguments like Array.push().

var heap = new BinaryHeap
heap.push(2)
heap.push(1, 3, 4)
heap.pop() // 1
heap.pop() // 2
heap.pop() // 3
heap.pop() // 4

heap.pop()

Removes the next item from the heap and returns it.

var heap = new BinaryHeap
heap.push(1, 2)
heap.pop() // 1
heap.pop() // 2
heap.pop() // null

heap.peek()

Returns the next item from the heap, but doesn't remove it.

var heap = new BinaryHeap
heap.push(1, 2)
heap.peek() // 1
heap.peek() // 1

heap.remove(item)

Removes the given item from the heap.

var heap = new BinaryHeap
heap.push(1, 2, 3)
heap.remove(2)
heap.pop() // 1
heap.pop() // 3

binary-heap's People

Contributors

bernerdschaefer avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  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.