# node-rank-fns

> A native node addon with implementations of ranking functions.

Latest version **1.0.2** (published 2021-06-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-rank-fns
pnpm add node-rank-fns
yarn add node-rank-fns
bun add node-rank-fns
```

## 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 | 1.0.2 |
| Published | 2021-06-13 |
| First published | 2021-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 37.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | Dimitar Andreev |
| Maintainers | d_andreev |

## Links

- npm: https://www.npmjs.com/package/node-rank-fns
- Repository: https://github.com/D-Andreev/node-rank-fns
- Homepage: https://github.com/D-Andreev/node-rank-fns#readme
- Issues: https://github.com/D-Andreev/node-rank-fns/issues
- npm.io page: https://npm.io/package/node-rank-fns

## Dependencies (3)

- [bindings](https://npm.io/package/bindings.md) ^1.5.0
- [node-addon-api](https://npm.io/package/node-addon-api.md) ^1.1.0
- [prebuild-install](https://npm.io/package/prebuild-install.md) ^6.1.2

## Recent versions

- 1.0.2 (latest) — 2021-06-13
- 1.0.1 — 2021-06-06
- 1.0.0 — 2021-06-06

## README

# node-rank-fns
<i>A native node addon with implementations of ranking functions.</i>

 * **[Install](#Install)**
 * **[TF-IDF](#TF-IDF)**
 * **[BM25](#BM25)**
 * **[Benchmarks](#Benchmarks)**
 * **[Changelog](#Changelog)**
 * **[Contributing](#Contributing)**
 * **[License](#License)**

<a name="Install"></a>
## Install 
- `npm i node-rank-fns`

## Examples 

<a name="TF-IDF"></a>
#### 1. TF-IDF ([Wiki](https://en.wikipedia.org/wiki/Tf%E2%80%93idf#Example_of_tf%E2%80%93idf))
Input files:
[documents.txt](https://github.com/D-Andreev/node-rank-fns/blob/master/test/documents.txt)
[terms.txt](https://github.com/D-Andreev/node-rank-fns/blob/master/test/terms.txt)
```js
    const NodeRankFns = require('node-rank-fns');
    const assert = require('assert');
    const rankFns = new NodeRankFns();

    rankFns.tfIdf('./documents.txt', './terms.txt', (err, res) => {
        assert.deepEqual(res, [0, 0.12901285528456335]);
    });
```
Run example [here](https://github.com/D-Andreev/node-rank-fns/blob/master/test/index.js)

<a name="BM25"></a>
#### 2. BM25 ([Wiki](https://en.wikipedia.org/wiki/Okapi_BM25))
Input files:
[documents.txt](https://github.com/D-Andreev/node-rank-fns/blob/master/test/documents.txt)
[terms.txt](https://github.com/D-Andreev/node-rank-fns/blob/master/test/terms.txt)
```js
    const NodeRankFns = require('node-rank-fns');
    const assert = require('assert');
    const rankFns = new NodeRankFns();

    rankFns.bm25('./documents.txt', './terms.txt', (err, res) => {
        assert.deepEqual(res, [0, 0.07811157572119272]);
    });

    // Pass paramers k and b for BM25
    // k is used in BM25 to control the contribution of term frequency. (Term saturation) (Default: `1`)
    // As k increases the impact of a higher TF to the score would be lower.
    // b is used in BM25 to control the contribution of document length. (Must be between `0` and `1`). (Default: `1`)
    // as b increases towards `1` the impact of document length is increased. `0` means that document length is not taken into account.
    const rankFns = new NodeRankFns({k: 2, b: 0.5});
    rankFns.bm25('./documents.txt', './terms.txt', (err, res) => {
        assert.deepEqual(res, [0, 0.04487832504164857]);
    });
```
Run example [here](https://github.com/D-Andreev/node-rank-fns/blob/master/test/index.js)

<a name="Benchmarks"></a>
## Benchmarks
`npm run benchmarks`

| Implementation   | Execution time   |
| ---------------- | ---------------- |
| vanillaJS*1000   | 5.063s           |
| nativeAddon*1000 | <b>767.641ms</b> |
| vanillaJS*1000   | 5.069s           |
| nativeAddon*1000 | <b>738.792ms</b> |

<a name="Contributing"></a>
### Contributing
Pull requests are welcome.

<a name="TODO"></a>
### TODO
- Make functions with promises instead of callbacks. 

<a name="Changelog"></a>
### Changelog
For complete changelog [click here](https://github.com/D-Andreev/node-rank-fns/blob/master/CHANGELOG.md).

<a name="License"></a>
### License
MIT License

Copyright (c) 2021 Dimitar Andreev

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.

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