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

nearest-neighbors

v4.0.8

Published

Find nearest neighbors & classify entities based on their neighbors

Downloads

15

Readme

nearest-neighbors

flipactual Travis Codecov Node NPM

Find nearest neighbors & classify entities based on their neighbors

NearestNeighbors

Kind: global class

new NearestNeighbors()

constructor Initializes a machine for finding nearest neighbors.

nearestNeighbors.getNearestNeighbors(node, desiredNeighbors) ⇒ Array

Find the specified number of nearest neighbors for the provided node.

Kind: instance method of NearestNeighbors
Returns: Array - The nearest neighbors.

| Param | Type | Description | | --- | --- | --- | | node | Object | The node to find neighbors for. | | desiredNeighbors | Number | The number of neighbors to find. |

nearestNeighbors.setDistancesFromNeighbors(node) ⇒ undefined

Assigns a distance from supplied node to each neighbor.

Kind: instance method of NearestNeighbors

| Param | Type | Description | | --- | --- | --- | | node | Object | The node to find neighbors for. |

nearestNeighbors.getDistancesFromNeighbor(node, neighbor) ⇒ Array

Find the range adjusted distances from supplied node to a neighbor for each feature.

Kind: instance method of NearestNeighbors
Returns: Array - The distances from this node to the neighbor in each dimension.

| Param | Type | Description | | --- | --- | --- | | node | Object | The node to determine distances from. | | neighbor | Node | The neighbor to determine distances from. |

nearestNeighbors.classify(node, desiredNeighbors, key) ⇒ String

Classify an entity based on its neighbors.

Kind: instance method of NearestNeighbors
Returns: String - The infered classification.

| Param | Type | Description | | --- | --- | --- | | node | Object | The node to find neighbors for and classify. | | desiredNeighbors | Number | The number of neighbors to find. | | key | String | The key to infer a value for. |

Scripts

test – run the tests

npm run test

coverage – generate test coverage

npm run coverage

view-coverage – view test coverage

npm run view-coverage

lint – lint the codebase

npm run lint

write-readme – generate the README

npm run write-readme

License

MIT @ Flip