npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

binaryheapx

v0.1.1

Published

JavaScript Implementation of the Binary Heap.

Downloads

9

Readme

Class BinaryHeap

NPM version build status Test coverage node version npm download

JavaScript Implementation of the Binary Heap.

Constructor Detail

BinaryHeap()

Constructs a new minimum binary heap, Minimum heap is default;

BinaryHeap(Boolean isMinHeap)

Constructs a new minimum binary heap.

Parameters:

  • isMinHeap - true to use the order imposed by the given comparator; false to reverse that order

BinaryHeap(Function comparator)

Constructs a new BinaryHeap that will use the given comparator to order its elements.

Parameters:

  • capacity - the initial capacity for the heap

BinaryHeap(Number capacity)

Constructs a new minimum binary heap with the specified initial capacity.

Parameters:

  • capacity - The initial capacity for the heap. This value must be greater than zero.

Throws:

  • IllegalArgumentException - if capacity is <= 0

BinaryHeap(Number capacity, Boolean isMinHeap, Function comparator)

Constructs a new BinaryHeap.

Parameters:

  • capacity - the initial capacity for the heap
  • isMinHeap - true to use the order imposed by the given comparator; false to reverse that order
  • comparator - the comparator used to order the elements, null means use natural order

Throws:

  • IllegalArgumentException - if capacity is <= 0

Method Detail

void clear()

Clears all elements from queue.

boolean isEmpty()

Tests if queue is empty.

Returns:

  • true if queue is empty; false otherwise.

boolean isFull()

Tests if queue is full.

Returns:

  • true if queue is full; false otherwise.

void insert(Object element)

Inserts an element into queue.

Parameters:

  • element - the element to be inserted

object peek()

Returns the element on top of heap but don't remove it.

Returns:

  • the element at top of heap

Throws:

  • NoSuchElementException - if isEmpty() == true

object pop()

Returns the element on top of heap and remove it.

Returns:

  • the element at top of heap

Throws:

  • NoSuchElementException - if isEmpty() == true

string toString()

Returns a string representation of this heap.

Returns:

  • a string representation of this heap

object iterator()

Returns an iterator over this heap's elements.

Returns:

  • an iterator over this heap's elements

boolean add(Object object)

Adds an object to this heap. Same as insert(Object).

Parameters:

  • object - the object to add

Returns:

  • true, always

object get()

Returns the priority element. Same as peek().

Returns:

  • the priority element

Throws:

  • BufferUnderflowException - if this heap is empty

object remove()

Removes the priority element. Same as pop().

Returns:

  • the removed priority element

Throws:

  • BufferUnderflowException - if this heap is empty

number size()

Returns the number of elements in this heap.

Returns:

  • the number of elements in this heap

License

The MIT License (MIT)

Copyright (c) 2013 xdf

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.