| Name | fastbloom-rs JSON |
| Version |
0.5.7
JSON |
| download |
| home_page | https://github.com/yankun1992/fastbloom |
| Summary | Some fast bloom filter implemented by Rust for Python and Rust! 10x faster than pybloom! |
| upload_time | 2023-10-07 14:45:25 |
| maintainer | None |
| docs_url | None |
| author | Yan Kun |
| requires_python | >=3.7 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2022 Yan Kun <1939810907@qq.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
|
| keywords |
bloom-filter
bloom
filter
bloomfilter
probabilistic data structure
counting-bloom-filter
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1>fastbloom</h1>
[](https://www.oscs1024.com/project/yankun1992/fastbloom?ref=badge_small)
[](https://docs.rs/fastbloom-rs)
[](https://github.com/yankun1992/fastbloom/actions/workflows/test_rust.yml)
[](https://github.com/yankun1992/fastbloom/actions/workflows/test_python.yml)
[](https://github.com/yankun1992/fastbloom/actions/workflows/benchmark.yml)
[](https://crates.io/crates/fastbloom-rs)
[](https://pypi.org/project/fastbloom-rs/)
A fast [bloom filter](#BloomFilter) | [counting bloom filter](#countingbloomfilter) implemented by Rust for Rust and
Python!
Language: [简体中文](./docs/README.zh_cn.md)
- [setup](#setup)
- [Python](#python)
- [requirements](#requirements)
- [install](#install)
- [Rust](#rust)
- [Java](#java)
- [Examples](#examples)
- [BloomFilter](#bloomfilter)
- [Python](#python-1)
- [Rust](#rust-1)
- [CountingBloomFilter](#countingbloomfilter)
- [Python](#python-2)
- [Rust](#rust-2)
- [benchmark](#benchmark)
- [computer info](#computer-info)
- [add one str to bloom filter](#add-one-str-to-bloom-filter)
- [add one million to bloom filter](#add-one-million-to-bloom-filter)
- [check one contains in bloom filter](#check-one-contains-in-bloom-filter)
- [check one not contains in bloom filter](#check-one-not-contains-in-bloom-filter)
- [add one str to counting bloom filter](#add-one-str-to-counting-bloom-filter)
- [add one million to counting bloom filter](#add-one-million-to-counting-bloom-filter)
# setup
## Python
### requirements
```
Python >= 3.7
```
### install
Install the latest fastbloom version with:
```bash
pip install fastbloom-rs
```
## Rust
```toml
fastbloom-rs = "{latest}"
```
## Java
maven
```xml
<dependency>
<groupId>io.github.yankun1992</groupId>
<artifactId>fastbloom</artifactId>
<version>{latest-version}</version>
</dependency>
```
# Examples
## BloomFilter
A Bloom filter is a space-efficient probabilistic data structure, conceived by Burton Howard
Bloom in 1970, that is used to test whether an element is a member of a set. False positive
matches are possible, but false negatives are not.
**Reference**: Bloom, B. H. (1970). Space/time trade-offs in hash coding with allowable errors.
Communications of the ACM, 13(7), 422-426.
[Full text article](http://crystal.uta.edu/~mcguigan/cse6350/papers/Bloom.pdf)
### Python
basic usage
```python
from fastbloom_rs import BloomFilter
bloom = BloomFilter(100_000_000, 0.01)
bloom.add_str('hello')
bloom.add_bytes(b'world')
bloom.add_int(9527)
assert bloom.contains('hello')
assert bloom.contains(b'world')
assert bloom.contains(9527)
assert not bloom.contains('hello world')
```
build bloom filter from bytes or list
```python
from fastbloom_rs import BloomFilter
bloom = BloomFilter(100_000_000, 0.01)
bloom.add_str('hello')
assert bloom.contains('hello')
bloom2 = BloomFilter.from_bytes(bloom.get_bytes(), bloom.hashes())
assert bloom2.contains('hello')
bloom3 = BloomFilter.from_int_array(bloom.get_int_array(), bloom.hashes())
assert bloom3.contains('hello')
```
there are some bulk api for python to reduce ffi cost between python and rust
```python
bloom = BloomFilter(100_000_000, 0.01)
inserts = [1, 2, 3, 4, 5, 6, 7, 9, 18, 68, 90, 100]
checks = [1, 2, 3, 4, 5, 6, 7, 9, 18, 68, 90, 100, 190, 290, 390]
results = [True, True, True, True, True, True, True, True, True, True, True, True, False, False, False]
bloom.add_int_batch(inserts)
contains = bloom.contains_int_batch(checks)
assert contains == results
bloom.add_str_batch(list(map(lambda x: str(x), inserts)))
assert bloom.contains_str_batch(list(map(lambda x: str(x), checks))) == results
bloom.add_bytes_batch(list(map(lambda x: bytes(x), inserts)))
assert bloom.contains_bytes_batch(list(map(lambda x: bytes(x), checks))) == results
```
more examples at [py_tests](py_tests/test_bloom.py).
### Rust
```rust
use fastbloom_rs::{BloomFilter, FilterBuilder};
let mut bloom = FilterBuilder::new(100_000_000, 0.01).build_bloom_filter();
bloom.add(b"helloworld");
assert_eq!(bloom.contains(b"helloworld"), true);
assert_eq!(bloom.contains(b"helloworld!"), false);
```
more examples at [docs.rs](https://docs.rs/fastbloom-rs)
## CountingBloomFilter
A Counting Bloom filter works in a similar manner as a regular Bloom filter; however, it is
able to keep track of insertions and deletions. In a counting Bloom filter, each entry in the
Bloom filter is a small counter associated with a basic Bloom filter bit.
**Reference**: F. Bonomi, M. Mitzenmacher, R. Panigrahy, S. Singh, and G. Varghese, “An Improved
Construction for Counting Bloom Filters,” in 14th Annual European Symposium on
Algorithms, LNCS 4168, 2006
### Python
```python
from fastbloom_rs import CountingBloomFilter
cbf = CountingBloomFilter(1000_000, 0.01)
cbf.add('hello')
cbf.add('hello')
assert 'hello' in cbf
cbf.remove('hello')
assert 'hello' in cbf # because 'hello' added twice.
# If add same element larger than 15 times, then remove 15 times the filter will not contain the element.
cbf.remove('hello')
assert 'hello' not in cbf
```
A CountingBloomFilter has a four bits counter to save hash index, so when insert an
element repeatedly, the counter will spill over quickly. So, you can set
`enable_repeat_insert` to `False` to check whether the element has added.
if it has added, it will not add again. `enable_repeat_insert` default set to `True`.
```python
from fastbloom_rs import CountingBloomFilter
cbf = CountingBloomFilter(1000_000, 0.01, False)
cbf.add('hello')
cbf.add('hello') # because enable_repeat_insert=False, this addition will not take effect.
assert 'hello' in cbf
cbf.remove('hello')
assert 'hello' not in cbf
```
more examples at [py_tests](py_tests/test_counting_bloom_filter.py).
### Rust
```rust
use fastbloom_rs::{CountingBloomFilter, FilterBuilder};
let mut builder = FilterBuilder::new(100_000, 0.01);
let mut cbf = builder.build_counting_bloom_filter();
cbf.add(b"helloworld");
assert_eq!(bloom.contains(b"helloworld"), true);
```
# benchmark
## computer info
| CPU | Memory | OS |
|----------------------------------------|--------|------------|
| AMD Ryzen 7 5800U with Radeon Graphics | 16G | Windows 10 |
## add one str to bloom filter
Benchmark insert one str to bloom filter:
```text
bloom_add_test time: [41.168 ns 41.199 ns 41.233 ns]
change: [-0.4891% -0.0259% +0.3417%] (p = 0.91 > 0.05)
No change in performance detected.
Found 13 outliers among 100 measurements (13.00%)
1 (1.00%) high mild
12 (12.00%) high severe
```
## add one million to bloom filter
Benchmark loop insert `(1..1_000_000).map(|n| { n.to_string() })` to bloom filter:
```text
bloom_add_all_test time: [236.24 ms 236.86 ms 237.55 ms]
change: [-3.4346% -2.9050% -2.3524%] (p = 0.00 < 0.05)
Performance has improved.
Found 5 outliers among 100 measurements (5.00%)
4 (4.00%) high mild
1 (1.00%) high severe
```
## check one contains in bloom filter
```text
bloom_contains_test time: [42.065 ns 42.102 ns 42.156 ns]
change: [-0.7830% -0.5901% -0.4029%] (p = 0.00 < 0.05)
Change within noise threshold.
Found 15 outliers among 100 measurements (15.00%)
1 (1.00%) low mild
5 (5.00%) high mild
9 (9.00%) high severe
```
## check one not contains in bloom filter
```text
bloom_not_contains_test time: [22.695 ns 22.727 ns 22.773 ns]
change: [-3.1948% -2.9695% -2.7268%] (p = 0.00 < 0.05)
Performance has improved.
Found 12 outliers among 100 measurements (12.00%)
4 (4.00%) high mild
8 (8.00%) high severe
```
## add one str to counting bloom filter
```text
counting_bloom_add_test time: [60.822 ns 60.861 ns 60.912 ns]
change: [+0.2427% +0.3772% +0.5579%] (p = 0.00 < 0.05)
Change within noise threshold.
Found 10 outliers among 100 measurements (10.00%)
1 (1.00%) low severe
4 (4.00%) low mild
1 (1.00%) high mild
4 (4.00%) high severe
```
## add one million to counting bloom filter
Benchmark loop insert `(1..1_000_000).map(|n| { n.to_string() })` to counting bloom filter:
```text
counting_bloom_add_million_test
time: [272.48 ms 272.58 ms 272.68 ms]
Found 2 outliers among 100 measurements (2.00%)
1 (1.00%) low mild
1 (1.00%) high mild
```
Raw data
{
"_id": null,
"home_page": "https://github.com/yankun1992/fastbloom",
"name": "fastbloom-rs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Yan Kun <1939810907@qq.com>",
"keywords": "bloom-filter,bloom,filter,bloomfilter,probabilistic data structure,counting-bloom-filter",
"author": "Yan Kun",
"author_email": "1939810907@qq.com",
"download_url": null,
"platform": null,
"description": "<h1>fastbloom</h1>\n\n[](https://www.oscs1024.com/project/yankun1992/fastbloom?ref=badge_small)\n[](https://docs.rs/fastbloom-rs)\n[](https://github.com/yankun1992/fastbloom/actions/workflows/test_rust.yml)\n[](https://github.com/yankun1992/fastbloom/actions/workflows/test_python.yml)\n[](https://github.com/yankun1992/fastbloom/actions/workflows/benchmark.yml)\n[](https://crates.io/crates/fastbloom-rs)\n[](https://pypi.org/project/fastbloom-rs/)\n\n\nA fast [bloom filter](#BloomFilter) | [counting bloom filter](#countingbloomfilter) implemented by Rust for Rust and\nPython!\n\nLanguage: [\u7b80\u4f53\u4e2d\u6587](./docs/README.zh_cn.md)\n\n- [setup](#setup)\n - [Python](#python)\n - [requirements](#requirements)\n - [install](#install)\n - [Rust](#rust)\n - [Java](#java)\n- [Examples](#examples)\n - [BloomFilter](#bloomfilter)\n - [Python](#python-1)\n - [Rust](#rust-1)\n - [CountingBloomFilter](#countingbloomfilter)\n - [Python](#python-2)\n - [Rust](#rust-2)\n- [benchmark](#benchmark)\n - [computer info](#computer-info)\n - [add one str to bloom filter](#add-one-str-to-bloom-filter)\n - [add one million to bloom filter](#add-one-million-to-bloom-filter)\n - [check one contains in bloom filter](#check-one-contains-in-bloom-filter)\n - [check one not contains in bloom filter](#check-one-not-contains-in-bloom-filter)\n - [add one str to counting bloom filter](#add-one-str-to-counting-bloom-filter)\n - [add one million to counting bloom filter](#add-one-million-to-counting-bloom-filter)\n\n# setup\n\n## Python\n\n### requirements\n\n```\nPython >= 3.7\n```\n\n### install\n\nInstall the latest fastbloom version with:\n\n```bash\npip install fastbloom-rs\n```\n\n## Rust\n\n```toml\nfastbloom-rs = \"{latest}\"\n```\n\n## Java\nmaven\n```xml\n<dependency>\n <groupId>io.github.yankun1992</groupId>\n <artifactId>fastbloom</artifactId>\n <version>{latest-version}</version>\n</dependency>\n```\n\n# Examples\n\n## BloomFilter\n\nA Bloom filter is a space-efficient probabilistic data structure, conceived by Burton Howard\nBloom in 1970, that is used to test whether an element is a member of a set. False positive\nmatches are possible, but false negatives are not.\n\n**Reference**: Bloom, B. H. (1970). Space/time trade-offs in hash coding with allowable errors.\nCommunications of the ACM, 13(7), 422-426.\n[Full text article](http://crystal.uta.edu/~mcguigan/cse6350/papers/Bloom.pdf)\n\n### Python\n\nbasic usage\n\n```python\nfrom fastbloom_rs import BloomFilter\n\nbloom = BloomFilter(100_000_000, 0.01)\n\nbloom.add_str('hello')\nbloom.add_bytes(b'world')\nbloom.add_int(9527)\n\nassert bloom.contains('hello')\nassert bloom.contains(b'world')\nassert bloom.contains(9527)\n\nassert not bloom.contains('hello world')\n```\n\nbuild bloom filter from bytes or list\n\n```python\nfrom fastbloom_rs import BloomFilter\n\nbloom = BloomFilter(100_000_000, 0.01)\nbloom.add_str('hello')\nassert bloom.contains('hello')\n\nbloom2 = BloomFilter.from_bytes(bloom.get_bytes(), bloom.hashes())\nassert bloom2.contains('hello')\n\nbloom3 = BloomFilter.from_int_array(bloom.get_int_array(), bloom.hashes())\nassert bloom3.contains('hello')\n\n```\n\nthere are some bulk api for python to reduce ffi cost between python and rust\n\n```python\nbloom = BloomFilter(100_000_000, 0.01)\ninserts = [1, 2, 3, 4, 5, 6, 7, 9, 18, 68, 90, 100]\nchecks = [1, 2, 3, 4, 5, 6, 7, 9, 18, 68, 90, 100, 190, 290, 390]\nresults = [True, True, True, True, True, True, True, True, True, True, True, True, False, False, False]\n\nbloom.add_int_batch(inserts)\ncontains = bloom.contains_int_batch(checks)\nassert contains == results\n\nbloom.add_str_batch(list(map(lambda x: str(x), inserts)))\nassert bloom.contains_str_batch(list(map(lambda x: str(x), checks))) == results\n\nbloom.add_bytes_batch(list(map(lambda x: bytes(x), inserts)))\nassert bloom.contains_bytes_batch(list(map(lambda x: bytes(x), checks))) == results\n```\n\nmore examples at [py_tests](py_tests/test_bloom.py).\n\n### Rust\n\n```rust\nuse fastbloom_rs::{BloomFilter, FilterBuilder};\n\nlet mut bloom = FilterBuilder::new(100_000_000, 0.01).build_bloom_filter();\n\nbloom.add(b\"helloworld\");\nassert_eq!(bloom.contains(b\"helloworld\"), true);\nassert_eq!(bloom.contains(b\"helloworld!\"), false);\n```\n\nmore examples at [docs.rs](https://docs.rs/fastbloom-rs)\n\n## CountingBloomFilter\n\nA Counting Bloom filter works in a similar manner as a regular Bloom filter; however, it is\nable to keep track of insertions and deletions. In a counting Bloom filter, each entry in the\nBloom filter is a small counter associated with a basic Bloom filter bit.\n\n**Reference**: F. Bonomi, M. Mitzenmacher, R. Panigrahy, S. Singh, and G. Varghese, \u201cAn Improved\nConstruction for Counting Bloom Filters,\u201d in 14th Annual European Symposium on\nAlgorithms, LNCS 4168, 2006\n\n### Python\n\n```python\nfrom fastbloom_rs import CountingBloomFilter\n\ncbf = CountingBloomFilter(1000_000, 0.01)\ncbf.add('hello')\ncbf.add('hello')\nassert 'hello' in cbf\ncbf.remove('hello')\nassert 'hello' in cbf # because 'hello' added twice. \n# If add same element larger than 15 times, then remove 15 times the filter will not contain the element.\ncbf.remove('hello')\nassert 'hello' not in cbf\n```\n\nA CountingBloomFilter has a four bits counter to save hash index, so when insert an\nelement repeatedly, the counter will spill over quickly. So, you can set\n`enable_repeat_insert` to `False` to check whether the element has added.\nif it has added, it will not add again. `enable_repeat_insert` default set to `True`.\n\n```python\nfrom fastbloom_rs import CountingBloomFilter\n\ncbf = CountingBloomFilter(1000_000, 0.01, False)\ncbf.add('hello')\ncbf.add('hello') # because enable_repeat_insert=False, this addition will not take effect. \nassert 'hello' in cbf\ncbf.remove('hello')\nassert 'hello' not in cbf \n```\n\nmore examples at [py_tests](py_tests/test_counting_bloom_filter.py).\n\n### Rust\n\n```rust\nuse fastbloom_rs::{CountingBloomFilter, FilterBuilder};\n\nlet mut builder = FilterBuilder::new(100_000, 0.01);\nlet mut cbf = builder.build_counting_bloom_filter();\ncbf.add(b\"helloworld\");\nassert_eq!(bloom.contains(b\"helloworld\"), true);\n```\n\n# benchmark\n\n## computer info\n\n| CPU | Memory | OS |\n|----------------------------------------|--------|------------|\n| AMD Ryzen 7 5800U with Radeon Graphics | 16G | Windows 10 |\n\n## add one str to bloom filter\n\nBenchmark insert one str to bloom filter:\n\n```text\nbloom_add_test time: [41.168 ns 41.199 ns 41.233 ns]\n change: [-0.4891% -0.0259% +0.3417%] (p = 0.91 > 0.05)\n No change in performance detected.\nFound 13 outliers among 100 measurements (13.00%)\n 1 (1.00%) high mild\n 12 (12.00%) high severe\n```\n\n## add one million to bloom filter\n\nBenchmark loop insert `(1..1_000_000).map(|n| { n.to_string() })` to bloom filter:\n\n```text\nbloom_add_all_test time: [236.24 ms 236.86 ms 237.55 ms]\n change: [-3.4346% -2.9050% -2.3524%] (p = 0.00 < 0.05)\n Performance has improved.\nFound 5 outliers among 100 measurements (5.00%)\n 4 (4.00%) high mild\n 1 (1.00%) high severe\n```\n\n## check one contains in bloom filter\n\n```text\nbloom_contains_test time: [42.065 ns 42.102 ns 42.156 ns]\n change: [-0.7830% -0.5901% -0.4029%] (p = 0.00 < 0.05)\n Change within noise threshold.\nFound 15 outliers among 100 measurements (15.00%)\n 1 (1.00%) low mild\n 5 (5.00%) high mild\n 9 (9.00%) high severe\n```\n\n## check one not contains in bloom filter\n\n```text\nbloom_not_contains_test time: [22.695 ns 22.727 ns 22.773 ns]\n change: [-3.1948% -2.9695% -2.7268%] (p = 0.00 < 0.05)\n Performance has improved.\nFound 12 outliers among 100 measurements (12.00%)\n 4 (4.00%) high mild\n 8 (8.00%) high severe\n```\n\n## add one str to counting bloom filter\n\n```text\ncounting_bloom_add_test time: [60.822 ns 60.861 ns 60.912 ns]\n change: [+0.2427% +0.3772% +0.5579%] (p = 0.00 < 0.05)\n Change within noise threshold.\nFound 10 outliers among 100 measurements (10.00%)\n 1 (1.00%) low severe\n 4 (4.00%) low mild\n 1 (1.00%) high mild\n 4 (4.00%) high severe\n```\n\n## add one million to counting bloom filter\n\nBenchmark loop insert `(1..1_000_000).map(|n| { n.to_string() })` to counting bloom filter:\n\n```text\ncounting_bloom_add_million_test\n time: [272.48 ms 272.58 ms 272.68 ms]\nFound 2 outliers among 100 measurements (2.00%)\n 1 (1.00%) low mild\n 1 (1.00%) high mild\n```\n",
"bugtrack_url": null,
"license": "Apache License\r\n\t Version 2.0, January 2004\r\n\t http://www.apache.org/licenses/\r\n\t\r\n\t TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\r\n\t\r\n\t 1. Definitions.\r\n\t\r\n\t \"License\" shall mean the terms and conditions for use, reproduction,\r\n\t and distribution as defined by Sections 1 through 9 of this document.\r\n\t\r\n\t \"Licensor\" shall mean the copyright owner or entity authorized by\r\n\t the copyright owner that is granting the License.\r\n\t\r\n\t \"Legal Entity\" shall mean the union of the acting entity and all\r\n\t other entities that control, are controlled by, or are under common\r\n\t control with that entity. For the purposes of this definition,\r\n\t \"control\" means (i) the power, direct or indirect, to cause the\r\n\t direction or management of such entity, whether by contract or\r\n\t otherwise, or (ii) ownership of fifty percent (50%) or more of the\r\n\t outstanding shares, or (iii) beneficial ownership of such entity.\r\n\t\r\n\t \"You\" (or \"Your\") shall mean an individual or Legal Entity\r\n\t exercising permissions granted by this License.\r\n\t\r\n\t \"Source\" form shall mean the preferred form for making modifications,\r\n\t including but not limited to software source code, documentation\r\n\t source, and configuration files.\r\n\t\r\n\t \"Object\" form shall mean any form resulting from mechanical\r\n\t transformation or translation of a Source form, including but\r\n\t not limited to compiled object code, generated documentation,\r\n\t and conversions to other media types.\r\n\t\r\n\t \"Work\" shall mean the work of authorship, whether in Source or\r\n\t Object form, made available under the License, as indicated by a\r\n\t copyright notice that is included in or attached to the work\r\n\t (an example is provided in the Appendix below).\r\n\t\r\n\t \"Derivative Works\" shall mean any work, whether in Source or Object\r\n\t form, that is based on (or derived from) the Work and for which the\r\n\t editorial revisions, annotations, elaborations, or other modifications\r\n\t represent, as a whole, an original work of authorship. For the purposes\r\n\t of this License, Derivative Works shall not include works that remain\r\n\t separable from, or merely link (or bind by name) to the interfaces of,\r\n\t the Work and Derivative Works thereof.\r\n\t\r\n\t \"Contribution\" shall mean any work of authorship, including\r\n\t the original version of the Work and any modifications or additions\r\n\t to that Work or Derivative Works thereof, that is intentionally\r\n\t submitted to Licensor for inclusion in the Work by the copyright owner\r\n\t or by an individual or Legal Entity authorized to submit on behalf of\r\n\t the copyright owner. For the purposes of this definition, \"submitted\"\r\n\t means any form of electronic, verbal, or written communication sent\r\n\t to the Licensor or its representatives, including but not limited to\r\n\t communication on electronic mailing lists, source code control systems,\r\n\t and issue tracking systems that are managed by, or on behalf of, the\r\n\t Licensor for the purpose of discussing and improving the Work, but\r\n\t excluding communication that is conspicuously marked or otherwise\r\n\t designated in writing by the copyright owner as \"Not a Contribution.\"\r\n\t\r\n\t \"Contributor\" shall mean Licensor and any individual or Legal Entity\r\n\t on behalf of whom a Contribution has been received by Licensor and\r\n\t subsequently incorporated within the Work.\r\n\t\r\n\t 2. Grant of Copyright License. Subject to the terms and conditions of\r\n\t this License, each Contributor hereby grants to You a perpetual,\r\n\t worldwide, non-exclusive, no-charge, royalty-free, irrevocable\r\n\t copyright license to reproduce, prepare Derivative Works of,\r\n\t publicly display, publicly perform, sublicense, and distribute the\r\n\t Work and such Derivative Works in Source or Object form.\r\n\t\r\n\t 3. Grant of Patent License. Subject to the terms and conditions of\r\n\t this License, each Contributor hereby grants to You a perpetual,\r\n\t worldwide, non-exclusive, no-charge, royalty-free, irrevocable\r\n\t (except as stated in this section) patent license to make, have made,\r\n\t use, offer to sell, sell, import, and otherwise transfer the Work,\r\n\t where such license applies only to those patent claims licensable\r\n\t by such Contributor that are necessarily infringed by their\r\n\t Contribution(s) alone or by combination of their Contribution(s)\r\n\t with the Work to which such Contribution(s) was submitted. If You\r\n\t institute patent litigation against any entity (including a\r\n\t cross-claim or counterclaim in a lawsuit) alleging that the Work\r\n\t or a Contribution incorporated within the Work constitutes direct\r\n\t or contributory patent infringement, then any patent licenses\r\n\t granted to You under this License for that Work shall terminate\r\n\t as of the date such litigation is filed.\r\n\t\r\n\t 4. Redistribution. You may reproduce and distribute copies of the\r\n\t Work or Derivative Works thereof in any medium, with or without\r\n\t modifications, and in Source or Object form, provided that You\r\n\t meet the following conditions:\r\n\t\r\n\t (a) You must give any other recipients of the Work or\r\n\t Derivative Works a copy of this License; and\r\n\t\r\n\t (b) You must cause any modified files to carry prominent notices\r\n\t stating that You changed the files; and\r\n\t\r\n\t (c) You must retain, in the Source form of any Derivative Works\r\n\t that You distribute, all copyright, patent, trademark, and\r\n\t attribution notices from the Source form of the Work,\r\n\t excluding those notices that do not pertain to any part of\r\n\t the Derivative Works; and\r\n\t\r\n\t (d) If the Work includes a \"NOTICE\" text file as part of its\r\n\t distribution, then any Derivative Works that You distribute must\r\n\t include a readable copy of the attribution notices contained\r\n\t within such NOTICE file, excluding those notices that do not\r\n\t pertain to any part of the Derivative Works, in at least one\r\n\t of the following places: within a NOTICE text file distributed\r\n\t as part of the Derivative Works; within the Source form or\r\n\t documentation, if provided along with the Derivative Works; or,\r\n\t within a display generated by the Derivative Works, if and\r\n\t wherever such third-party notices normally appear. The contents\r\n\t of the NOTICE file are for informational purposes only and\r\n\t do not modify the License. You may add Your own attribution\r\n\t notices within Derivative Works that You distribute, alongside\r\n\t or as an addendum to the NOTICE text from the Work, provided\r\n\t that such additional attribution notices cannot be construed\r\n\t as modifying the License.\r\n\t\r\n\t You may add Your own copyright statement to Your modifications and\r\n\t may provide additional or different license terms and conditions\r\n\t for use, reproduction, or distribution of Your modifications, or\r\n\t for any such Derivative Works as a whole, provided Your use,\r\n\t reproduction, and distribution of the Work otherwise complies with\r\n\t the conditions stated in this License.\r\n\t\r\n\t 5. Submission of Contributions. Unless You explicitly state otherwise,\r\n\t any Contribution intentionally submitted for inclusion in the Work\r\n\t by You to the Licensor shall be under the terms and conditions of\r\n\t this License, without any additional terms or conditions.\r\n\t Notwithstanding the above, nothing herein shall supersede or modify\r\n\t the terms of any separate license agreement you may have executed\r\n\t with Licensor regarding such Contributions.\r\n\t\r\n\t 6. Trademarks. This License does not grant permission to use the trade\r\n\t names, trademarks, service marks, or product names of the Licensor,\r\n\t except as required for reasonable and customary use in describing the\r\n\t origin of the Work and reproducing the content of the NOTICE file.\r\n\t\r\n\t 7. Disclaimer of Warranty. Unless required by applicable law or\r\n\t agreed to in writing, Licensor provides the Work (and each\r\n\t Contributor provides its Contributions) on an \"AS IS\" BASIS,\r\n\t WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\r\n\t implied, including, without limitation, any warranties or conditions\r\n\t of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\r\n\t PARTICULAR PURPOSE. You are solely responsible for determining the\r\n\t appropriateness of using or redistributing the Work and assume any\r\n\t risks associated with Your exercise of permissions under this License.\r\n\t\r\n\t 8. Limitation of Liability. In no event and under no legal theory,\r\n\t whether in tort (including negligence), contract, or otherwise,\r\n\t unless required by applicable law (such as deliberate and grossly\r\n\t negligent acts) or agreed to in writing, shall any Contributor be\r\n\t liable to You for damages, including any direct, indirect, special,\r\n\t incidental, or consequential damages of any character arising as a\r\n\t result of this License or out of the use or inability to use the\r\n\t Work (including but not limited to damages for loss of goodwill,\r\n\t work stoppage, computer failure or malfunction, or any and all\r\n\t other commercial damages or losses), even if such Contributor\r\n\t has been advised of the possibility of such damages.\r\n\t\r\n\t 9. Accepting Warranty or Additional Liability. While redistributing\r\n\t the Work or Derivative Works thereof, You may choose to offer,\r\n\t and charge a fee for, acceptance of support, warranty, indemnity,\r\n\t or other liability obligations and/or rights consistent with this\r\n\t License. However, in accepting such obligations, You may act only\r\n\t on Your own behalf and on Your sole responsibility, not on behalf\r\n\t of any other Contributor, and only if You agree to indemnify,\r\n\t defend, and hold each Contributor harmless for any liability\r\n\t incurred by, or claims asserted against, such Contributor by reason\r\n\t of your accepting any such warranty or additional liability.\r\n\t\r\n\t END OF TERMS AND CONDITIONS\r\n\t\r\n\t APPENDIX: How to apply the Apache License to your work.\r\n\t\r\n\t To apply the Apache License to your work, attach the following\r\n\t boilerplate notice, with the fields enclosed by brackets \"[]\"\r\n\t replaced with your own identifying information. (Don't include\r\n\t the brackets!) The text should be enclosed in the appropriate\r\n\t comment syntax for the file format. We also recommend that a\r\n\t file or class name and description of purpose be included on the\r\n\t same \"printed page\" as the copyright notice for easier\r\n\t identification within third-party archives.\r\n\t\r\n\t Copyright 2022 Yan Kun <1939810907@qq.com>\r\n\t\r\n\t Licensed under the Apache License, Version 2.0 (the \"License\");\r\n\t you may not use this file except in compliance with the License.\r\n\t You may obtain a copy of the License at\r\n\t\r\n\t http://www.apache.org/licenses/LICENSE-2.0\r\n\t\r\n\t Unless required by applicable law or agreed to in writing, software\r\n\t distributed under the License is distributed on an \"AS IS\" BASIS,\r\n\t WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\n\t See the License for the specific language governing permissions and\r\n\t limitations under the License.\r\n\t",
"summary": "Some fast bloom filter implemented by Rust for Python and Rust! 10x faster than pybloom!",
"version": "0.5.7",
"project_urls": {
"Homepage": "https://github.com/yankun1992/fastbloom",
"documentation": "https://github.com/yankun1992/fastbloom/blob/main/README.md",
"repository": "https://github.com/yankun1992/fastbloom"
},
"split_keywords": [
"bloom-filter",
"bloom",
"filter",
"bloomfilter",
"probabilistic data structure",
"counting-bloom-filter"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e1f8015e429a0e2950df9dc3cd831072e91b453c738b5ec6794f6440e007446f",
"md5": "ab2c30ef1051d94de5eb1420e699d9e3",
"sha256": "b074c285a89e294bb6c960f3687c13970e6300c69747b68fb51d7ed833e527ec"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-macosx_10_7_x86_64.whl",
"has_sig": false,
"md5_digest": "ab2c30ef1051d94de5eb1420e699d9e3",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 244978,
"upload_time": "2023-10-07T14:45:25",
"upload_time_iso_8601": "2023-10-07T14:45:25.609720Z",
"url": "https://files.pythonhosted.org/packages/e1/f8/015e429a0e2950df9dc3cd831072e91b453c738b5ec6794f6440e007446f/fastbloom_rs-0.5.7-cp37-abi3-macosx_10_7_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9af34c42e23d55ac342dbb4005183c357d897656e58b11a3df90904a6546e955",
"md5": "70deeaced2a3de4208b50cd248da5836",
"sha256": "7e2c132412e51fb14e62ee7f58b9c7791e82d990d5d5f6e3410d07f7e8d6955a"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-macosx_11_0_arm64.whl",
"has_sig": false,
"md5_digest": "70deeaced2a3de4208b50cd248da5836",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 240235,
"upload_time": "2023-10-07T14:44:18",
"upload_time_iso_8601": "2023-10-07T14:44:18.748060Z",
"url": "https://files.pythonhosted.org/packages/9a/f3/4c42e23d55ac342dbb4005183c357d897656e58b11a3df90904a6546e955/fastbloom_rs-0.5.7-cp37-abi3-macosx_11_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f4d8a0e3a2d4c7f3dc1ec0008c227b3b1b51120cac164e3f805b36b51a8bcce0",
"md5": "df617283f2c3133a7ba9d241240c4f0a",
"sha256": "3718aaab684134e64a5b4901c8b6a02ffbcbf0b8aeb1344bb61f5c798d864b54"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"has_sig": false,
"md5_digest": "df617283f2c3133a7ba9d241240c4f0a",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 270373,
"upload_time": "2023-10-07T14:44:56",
"upload_time_iso_8601": "2023-10-07T14:44:56.865433Z",
"url": "https://files.pythonhosted.org/packages/f4/d8/a0e3a2d4c7f3dc1ec0008c227b3b1b51120cac164e3f805b36b51a8bcce0/fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "55a79b451c2f856f4369a6bf7268f01339bc0b37d53eb3e38183d818dcadaad3",
"md5": "f9e1d5652a5ed7553667dee0611333cc",
"sha256": "dc5f4d9e91cf904ce34a08d763170e13745578d0f45f01f229c6b32da38ea314"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"has_sig": false,
"md5_digest": "f9e1d5652a5ed7553667dee0611333cc",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 268478,
"upload_time": "2023-10-07T14:45:00",
"upload_time_iso_8601": "2023-10-07T14:45:00.399466Z",
"url": "https://files.pythonhosted.org/packages/55/a7/9b451c2f856f4369a6bf7268f01339bc0b37d53eb3e38183d818dcadaad3/fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5434714503b9ef7533f55d5562a89e181c1be06c535b03c832bbd9d77fd945b1",
"md5": "7dcfb33e9638602d47883d9500ddbf13",
"sha256": "68926cb70a5ead5267f43999287b0133769cd15b993374b108536e660eddb723"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
"has_sig": false,
"md5_digest": "7dcfb33e9638602d47883d9500ddbf13",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 377372,
"upload_time": "2023-10-07T14:44:47",
"upload_time_iso_8601": "2023-10-07T14:44:47.612807Z",
"url": "https://files.pythonhosted.org/packages/54/34/714503b9ef7533f55d5562a89e181c1be06c535b03c832bbd9d77fd945b1/fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "54f2533cfcc114452474677e6e33cf4e20c513bf4a9a1e510b079594e8e3fddf",
"md5": "9e6a88be398129a5cfbd33a4eda40e19",
"sha256": "5ebac10a0d024a397d950540beb3d20c7db0b855b27467070ace83988e5565e3"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_ppc64.manylinux2014_ppc64.whl",
"has_sig": false,
"md5_digest": "9e6a88be398129a5cfbd33a4eda40e19",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 395006,
"upload_time": "2023-10-07T14:45:31",
"upload_time_iso_8601": "2023-10-07T14:45:31.344804Z",
"url": "https://files.pythonhosted.org/packages/54/f2/533cfcc114452474677e6e33cf4e20c513bf4a9a1e510b079594e8e3fddf/fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_ppc64.manylinux2014_ppc64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "32437659b6d991841161336b264bdb1445c869beac854ccf19ebbff8975e71ab",
"md5": "ce093885a24b70335c72bd3ecd95a5a0",
"sha256": "bc763e05c9c906b92c24e51fcc12fa0d4de486801f6bd04729b3c4c1ba8c75a5"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "ce093885a24b70335c72bd3ecd95a5a0",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 283330,
"upload_time": "2023-10-07T14:44:26",
"upload_time_iso_8601": "2023-10-07T14:44:26.671837Z",
"url": "https://files.pythonhosted.org/packages/32/43/7659b6d991841161336b264bdb1445c869beac854ccf19ebbff8975e71ab/fastbloom_rs-0.5.7-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f9561e731815e2acd5e70690289528860e05ec03b72f661fb38c38672eabedc8",
"md5": "1f0e7bc5de7d9a30d0f7721f4fe728c1",
"sha256": "b4cc4cc0f31a40312b4ecfa2186fd53f3b6b7b52ad4e2d016c829428064fcc86"
},
"downloads": -1,
"filename": "fastbloom_rs-0.5.7-cp37-abi3-win_amd64.whl",
"has_sig": false,
"md5_digest": "1f0e7bc5de7d9a30d0f7721f4fe728c1",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 183216,
"upload_time": "2023-10-07T14:45:37",
"upload_time_iso_8601": "2023-10-07T14:45:37.095615Z",
"url": "https://files.pythonhosted.org/packages/f9/56/1e731815e2acd5e70690289528860e05ec03b72f661fb38c38672eabedc8/fastbloom_rs-0.5.7-cp37-abi3-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-07 14:45:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yankun1992",
"github_project": "fastbloom",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fastbloom-rs"
}
