# PDSA: A Rust library for Probabilistic Data Structures

PDSA is a collection of probabilistic data structures implemented in Rust. These data structures are useful for various applications where approximate answers or approximations to subsets are sufficient.

Currently, PDSA includes an implementation of Bloom filter, with other data structures to be added in the future releases.

[![Crates.io](https://img.shields.io/crates/v/pdsa.svg)](https://crates.io/crates/pdsa)
[![Docs.rs](https://docs.rs/pdsa/badge.svg)](https://docs.rs/pdsa)
[![CI](https://github.com/arunma/pdsa/workflows/CI/badge.svg)](https://github.com/arunma/pdsa/actions)
[![License:MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Coverage Status](https://coveralls.io/repos/github/arunma/pdsa/badge.svg?branch=main)](https://coveralls.io/github/arunma/pdsa?branch=main)

## Installation

Add the following line to your Cargo.toml file:

```toml
[dependencies]
pdsa = "0.1.0"
```
## Usage 

### BloomFilter

```rust

use pdsa::BloomFilter;

fn main() {
    // Create a Bloom filter with 1000 items and a false positive rate of 1%
    let mut bloom_filter = BloomFilter::new(1000, 0.01).unwrap();

    // Insert some items into the Bloom filter
    bloom_filter.insert(&"foo");
    bloom_filter.insert(&"bar");

    // Check if an item is in the Bloom filter
    assert!(bloom_filter.contains(&"foo"));
    assert!(!bloom_filter.contains(&"baz"));
}
```

## Contribution
Contributions are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you would like to contribute code, please fork the repository and submit a pull request.

See [CONTRIBUTING.md](CONTRIBUTING.md).


## License

PDSA is licensed under the MIT license. See the LICENSE file for details.