https://github.com/derhuerst/hifo

Stores & sorts only the highest values.
https://github.com/derhuerst/hifo

highest lowest maximum minimum sort

Last synced: 5 days ago
JSON representation

Stores & sorts only the highest values.

• Host: GitHub
• URL: https://github.com/derhuerst/hifo
• Owner: derhuerst
• License: isc
• Created: 2015-09-03T18:40:14.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-05-03T15:56:28.000Z (over 4 years ago)
• Last Synced: 2024-11-03T00:13:38.191Z (10 days ago)
• Topics: highest, lowest, maximum, minimum, sort
• Language: JavaScript
• Homepage: https://github.com/derhuerst/hifo
• Size: 34.2 KB
• Stars: 9
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        
# *hifo* – highest in, first out ⚖

**Remembers the highest/lowest values in a data set of any size.** Useful if you have a large number of values, but are only interested in the `n` highest (or lowest) ones. If you looking for a stream version, check out [hifo-stream](https://github.com/brianshaler/hifo-stream#hifo-stream).

- *hifo* is **fast**. To find the highest `m` of `n` values, the [time complexity is `O(m * n)`](https://en.wikipedia.org/wiki/Time_complexity#Linear_time).

- It is **memory-efficient**. If you specifiy its size as `50`, it will only store 50 values in memory.

- *hifo* works with **numeric values** and **simple objects** out of the box, but you can pass your own [`sort` function](#todo).

[![build status](https://img.shields.io/travis/derhuerst/hifo.svg)](https://travis-ci.org/derhuerst/hifo)

[![npm version](https://img.shields.io/npm/v/hifo.svg)](https://www.npmjs.com/package/hifo)

[![dependency status](https://img.shields.io/david/derhuerst/hifo.svg)](https://david-dm.org/derhuerst/hifo)

[![dev dependency status](https://img.shields.io/david/dev/derhuerst/hifo.svg)](https://david-dm.org/derhuerst/hifo#info=devDependencies)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/hifo.svg)

[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)

[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)

## Example

Let's assume we have a huge **array of people**.

```javascript

var people = [

	{ name: 'Alice', age: 23 },

	{ name: 'Eve', age: 45 },

	{ name: 'Jane', age: 19 },

	{ name: 'Bob', age: 30 },

	{ name: 'John', age: 60 },

	// thousands of others

];

```

To **find the 3 oldest people**, we reate a new `Hifo` instance and pass the `'age'` as the filter key and `3` as the size.

```javascript

var hifo = require('hifo');

var oldest = hifo(hifo.highest('age'), 3);

for (var person in people) {

	oldest.add(person);

}

```

`oldest.data` will now look like this:

```javascript

[

	{ name: 'John', age: 60 },

	{ name: 'Eve', age: 45 },

	{ name: 'Bob', age: 30 }

]

```

Of course you can do this kind of filtering with `hifo.lowest` as well.

## Contributing

If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/hifo/issues).