Giter Site home page Giter Site logo

qbloom_filter's Introduction

BloomFilter

A Bloom filter is a space-efficient probabilistic data structure Wiki

Installation

Add this line to your application's Gemfile:

gem 'qbloom_filter'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install qbloom_filter

Usage

After installation the instance can be created. And two parameters can be used to describe the bloom filter:

  • first - number of items that are be inserted(default: 100)
  • second - False Positive probability(default: 0.01)
bloom_filter = BloomFilter::Filter.new(1000, 0.001)

Methods

add(value) - add item into filter

includes?(value) - check if filter includes the value

contains?(value) - alias of includes?(value)

count - returns number of inserted items

capacity - returns initial capacity

probability - returns initial probability

bit_size - returns number of bits in the bit array

get_bit(position) - returns value of a bit(true/false) in the bit array, rises an error if position is out of range of the bit array

set_bit(position) - set a bit to TRUE in the bit array, rises an error if position is out of range of the bit array

clear_bit(position) - set a bit to FALSE in the bit array, rises an error if position is out of range of the bit array

union_with(bloom_filter) - unions current bloom filter with another one, bloom filters should be the instances of this module and have the same initial params(capacity, probability)

intersect_with(bloom_filter) - intersects current bloom filter with another one, bloom filters should be the instances of this module and have the same initial params(capacity, probability)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/superedriver/qbloom_filter

qbloom_filter's People

Contributors

superedriver avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.