# wink-distance

> Distance/Similarity functions for Bag of Words, Strings, Numbers, Dates and Vectors.

Latest version **2.0.2** (published 2023-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install wink-distance
pnpm add wink-distance
yarn add wink-distance
bun add wink-distance
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2023-01-14 |
| First published | 2017-09-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 91 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Sanjaya Kumar Saxena |
| Maintainers | sanjaya, r4chn4, prtksxna |
| Keywords | Distance, Similarity, NLP, Bag of Words, Strings, Vectors, Chebyshev, Cosine, Hamming, Jaccard, Jaro, Manhattan, Soundex, Tversky, Taxicab, wink, winkJS |

## Links

- npm: https://www.npmjs.com/package/wink-distance
- Repository: https://github.com/winkjs/wink-distance
- Homepage: http://winkjs.org/
- Issues: https://github.com/winkjs/wink-distance/issues
- npm.io page: https://npm.io/package/wink-distance

## Dependencies (2)

- [wink-helpers](https://npm.io/package/wink-helpers.md) ^2.0.0
- [wink-jaro-distance](https://npm.io/package/wink-jaro-distance.md) ^2.0.0

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 2.0.2 (latest) — 2023-01-14
- 2.0.1 — 2021-01-25
- 2.0.0 — 2018-11-03
- 1.4.0 — 2018-04-03
- 1.3.1 — 2017-12-19
- 1.3.0 — 2017-10-17
- 1.2.1 — 2017-10-11
- 1.2.0 — 2017-10-07
- 1.1.0 — 2017-10-01
- 1.0.0 — 2017-09-28
- 0.1.0 — 2017-09-27
- 0.0.0 — 2017-09-26

## README

# wink-distance

Distance/Similarity functions for Bag of Words, Strings, Vectors and more.

### [![Build Status](https://api.travis-ci.com/winkjs/wink-distance.svg?branch=master)](https://app.travis-ci.com/github/winkjs/wink-distance) [![Coverage Status](https://coveralls.io/repos/github/winkjs/wink-distance/badge.svg?branch=master)](https://coveralls.io/github/winkjs/wink-distance?branch=master) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/winkjs/Lobby)

[<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://wink.org.in/)

Compute distances or similarities needed for NLP, de-duplication and clustering using **`wink-distance`**. Some of the methods are listed below:

1. Cosine similarity for Bag of Words,
1. Jaccard & Tversky for Sets,
1. Jaro, Jaro-Winkler, and Levenshtien for string,
1. Chebyshev and Taxicab for vectors.

> Combine `wink-distance` with [WinkNLP](https://github.com/winkjs/wink-nlp) to build awesome NLP apps.

### Installation

Use [npm](https://www.npmjs.com/package/wink-distance) to install:

    npm install wink-distance --save


### Documentation
Check out the [distance/similarity API documentation](https://winkjs.org/wink-distance) to learn more.

### Need Help?

If you spot a bug and the same has not yet been reported, raise a new [issue](https://github.com/winkjs/wink-distance/issues) or consider fixing it and sending a pull request.

### About wink
[Wink](http://winkjs.org/) is a family of open source packages for **Statistical Analysis**, **Natural Language Processing** and **Machine Learning** in NodeJS. The code is **thoroughly documented** for easy human comprehension and has a **test coverage of ~100%** for reliability to build production grade solutions.

### Copyright & License

**wink-distance** is copyright 2017-23 [GRAYPE Systems Private Limited](http://graype.in/).

It is licensed under the terms of the MIT License.

---
_Source: https://npm.io/package/wink-distance · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._