PyBloom

Welcome to the Bloom Filter Library in Python! This library provides a robust and efficient implementation of a Bloom Filter, a probabilistic data structure widely used for membership testing within a set.

What is a Bloom Filter?

A Bloom Filter is a space-efficient and fast data structure used to determine if an element belongs to a set or not. It's particularly valuable when you need to quickly check membership without the need for expensive data retrieval operations. A Bloom Filter is designed to deliver high performance while maintaining low memory consumption.

Key Features:

Memory Efficiency: Bloom Filters use minimal memory, making them ideal for applications with large datasets.
Fast Membership Queries: They allow for blazing-fast membership queries, enabling quick checks of set membership.
False Positives: While efficient, it's important to note that Bloom Filters may produce false positives, meaning they might mistakenly report that an element is in the set when it's not. However, they never produce false negatives, which makes them useful for various use cases where occasional false positives can be tolerated.

Use Cases:

Bloom Filters find applications in various domains, including:

Database Systems: They are used to reduce disk I/O operations by determining whether a requested item is likely to be in a cache.
Network Protocols: Bloom Filters are employed for efficient routing table lookups and reducing the load on routers.
Spelling Correction: They help quickly identify whether a word exists in a dictionary, improving spelling correction algorithms.
Duplicate Elimination: In data deduplication and duplicate detection tasks, they help eliminate duplicates efficiently.

Features

Create and initialize a Bloom Filter with a specified size and number of hash functions.
Insert items of type string or int into the filter.
Check if an item might be in the filter with the Contains method.
Estimate the false positive rate with the FalsePositiveRate method.
Perform union and intersection operations on Bloom Filters.
Estimate the number of items present inside the Bloom Filter with the NumberOfItems method.

Installation

To use this Bloom Filter library in your Golang project, follow these steps:

Make sure you have Python installed on your system. If not, you can download it from the official Python website.
Make sure to install the PyBloom library if you haven't already using git clone:
```
git clone https://github.com/Diegomangasco/PyBloom.git
```

Usage

Here's a basic example of how to use the Bloom Filter library in your Python code:

  from PyBloom import BloomFilter

  def main():
      # Create a new Bloom Filter with a specific capacity and number of hash functions
      filter = BloomFilter(capacity=10000, hash_functions=7)
  
      # Add items to the filter
      filter.add(b'item1')
      filter.add(b'item2')
  
      # Check if an item may be in the filter (may produce false positives)
      is_in_filter = b'item1' in filter
      print(f"Is 'item1' in the filter? {is_in_filter}")
  
      is_in_filter = b'item3' in filter
      print(f"Is 'item3' in the filter? {is_in_filter}")
  
  if __name__ == "__main__":
      main()

API Reference

For detailed information on how to use the package, please refer to the API Reference.

Contributing

Contributions are welcome! If you find a bug or want to add a new feature, please open an issue or create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Diegomangasco / PyBloom