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

k-d-tree

v1.0.1

Published

JavaScript k-d Tree Implementation

Downloads

451

Readme

NPM

A basic but super fast JavaScript implementation of the k-dimensional tree data structure.

In computer science, a k-d tree (short for k-dimensional tree) is a space-partitioning data structure for organizing points in a k-dimensional space. k-d trees are a useful data structure for several applications, such as searches involving a multidimensional search key (e.g. range searches and nearest neighbor searches). k-d trees are a special case of binary space partitioning trees.

Installation

$ npm install k-d-tree

Methods

constructor(points, metric)

Create a new tree

Parameters

points: Array, GeoJSON points

metric: function, a distance function

nearest(point, maxNodes, maxDistance)

Query the nearest maxNodes neighbors to a point

Parameters

point: object, GeoJSON point

maxNodes: number, maximum amount of elements to return

maxDistance: number, optional maximal search distance

Returns

Array, Elements with two components: the searched point and the distance to it

insert(point)

Insert a new point into the tree

Parameters

point: object, GeoJSON point

Returns

Node, reference to inserted Node instance

remove(point)

Remove a point from the tree by reference

Parameters

point: object, GeoJSON point

Returns

Node, reference to removed Node instance

balanceFactor()

Get an approximation of how unbalanced the tree is

Returns

number, The higher this number, the worse query performance will be. It indicates how many times worse it is than the optimal tree. Minimum is 1. Unreliable for small trees.

toJSON()

Convert tree to a JSON serializable structure

Returns

object, JSON representation of the k-d tree

Running Tests

Install the development dependencies:

$ npm install

Then run the tests:

$ npm test

Code Coverage

Install the development dependencies:

$ npm install

Then run coverage

$ npm run coverage

View coverage reports

$ firefox coverage/lcov-report/index.html

Browser Bundle

$ npm run build