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

cuckoofilter-native

v0.1.1

Published

A native implementation of a cuckoofilter

Downloads

3

Readme

Cuckoo Filter

Cuckoo filter is a Bloom filter replacement for approximated set-membership queries. While Bloom filters are well-known space-efficient data structures to serve queries like "if item x is in a set?", they do not support deletion. Their variances to enable deletion (like counting Bloom filters) usually require much more space.

Cuckoo filters provide the flexibility to add and remove items dynamically. A cuckoo filter is based on cuckoo hashing (and therefore named as cuckoo filter). It is essentially a cuckoo hash table storing each key's fingerprint. Cuckoo hash tables can be highly compact, thus a cuckoo filter could use less space than conventional Bloom filters, for applications that require low false positive rates (< 3%). For details about the algorithm and citations please use:

"Cuckoo Filter: Practically Better Than Bloom" in proceedings of ACM CoNEXT 2014 by Bin Fan, Dave Andersen and Michael Kaminsky

This is Node.js binding for the amazing cuckoofilter C++ library.

Install

$ npm install cuckoofilter-native

Usage

Here is a simple example for the basic usage of cuckoo filter.

const CuckooFilter = require('cuckoofilter-native')

const filter = new CuckooFilter(1024)

filter.add('hello world') // returns the filter
filter.contain('hello world') // returns true
filter.size // returns 1
filter.delete('hello world') // returns the filter
filter.size // now returns 0, as we have deleted

API

A cuckoo filter supports following operations:

  • add(item): insert an item to the filter
  • contain(item): return if item is already in the filter. Note that this method may return false positive results like Bloom filters
  • delete(item): delete the given item from the filter. Note that to use this method, it must be ensured that this item is in the filter (e.g., based on records on external storage); otherwise, a false item may be deleted.
  • size: return the total number of items currently in the filter
  • bytes: return the filter size in bytes

item must be a string, but Buffer could be supported in the future. Feel free to send a PR.

Benchmarks

This library is fast:

cuckoofilter-native add x 1,097,031 ops/sec ±2.12% (82 runs sampled)
cuckoofilter-native contain x 3,286,894 ops/sec ±2.08% (84 runs sampled)
cuckoo-filter add x 2,267 ops/sec ±13.26% (16 runs sampled)
cuckoo-filter contains x 31,680 ops/sec ±4.85% (70 runs sampled)
bloomfilter add x 773,499 ops/sec ±2.38% (86 runs sampled)
bloomfilter contains x 1,866,273 ops/sec ±2.20% (85 runs sampled)

License

Apache-2.0