Java Bloom Filter 技术文档
2024-12-23 14:45:51作者:明树来
1. 安装指南
1.1 通过 JAR 文件安装
- 从 GitHub 下载最新版本的
java-bloomfilter
项目。 - 使用
ant
命令编译项目:ant
- 编译完成后,将生成的
dist/java-bloomfilter.jar
文件添加到你的项目中。
1.2 通过源码集成
- 从 GitHub 下载
BloomFilter.java
文件。 - 将
BloomFilter.java
文件直接复制到你的项目中。 - 确保保留文件中的 LGPL 许可证注释,并引用
java-bloomfilter
的网页。
2. 项目的使用说明
2.1 创建 Bloom Filter
要创建一个空的 Bloom Filter,可以使用以下代码:
double falsePositiveProbability = 0.1;
int expectedNumberOfElements = 100;
BloomFilter<String> bloomFilter = new BloomFilter<String>(falsePositiveProbability, expectedNumberOfElements);
构造函数会根据给定的误判概率和预期元素数量,自动选择合适的长度和哈希函数数量。
2.2 添加元素
使用 add()
方法向 Bloom Filter 中添加元素:
bloomFilter.add("foo");
2.3 检查元素
使用 contains()
方法检查元素是否存在于 Bloom Filter 中:
bloomFilter.contains("foo"); // 返回 true
注意,contains()
方法可能会返回误判结果(false positive),但不会出现漏判(false negative)。
2.4 完整示例
以下是一个完整的示例代码:
double falsePositiveProbability = 0.1;
int expectedSize = 100;
BloomFilter<String> bloomFilter = new BloomFilter<String>(falsePositiveProbability, expectedSize);
bloomFilter.add("foo");
if (bloomFilter.contains("foo")) { // 总是返回 true
System.out.println("BloomFilter contains foo!");
System.out.println("Probability of a false positive: " + bloomFilter.expectedFalsePositiveProbability());
}
if (bloomFilter.contains("bar")) { // 应该返回 false,但可能会返回 true
System.out.println("There was a false positive.");
}
3. 项目 API 使用文档
3.1 构造函数
-
BloomFilter(double falsePositiveProbability, int expectedNumberOfElements)
- 根据误判概率和预期元素数量创建 Bloom Filter。
-
BloomFilter(int bitSetSize, int expectedNumberOfElements)
- 根据位集大小和预期元素数量创建 Bloom Filter。
-
BloomFilter(int bitSetSize, int expectedNumberOfElements, int numberOfHashFunctions)
- 根据位集大小、预期元素数量和哈希函数数量创建 Bloom Filter。
3.2 方法
-
void add(T element)
- 向 Bloom Filter 中添加元素。
-
boolean contains(T element)
- 检查元素是否存在于 Bloom Filter 中。
-
double expectedFalsePositiveProbability()
- 返回预期的误判概率。
-
int getExpectedBitsPerElement()
- 返回预期的每元素位数。
-
int getBitsPerElement()
- 返回实际的每元素位数。
4. 项目安装方式
4.1 通过 JAR 文件安装
- 下载并编译项目。
- 将生成的
dist/java-bloomfilter.jar
文件添加到你的项目中。
4.2 通过源码集成
- 下载
BloomFilter.java
文件。 - 将文件直接复制到你的项目中,并保留 LGPL 许可证注释。
热门项目推荐
相关项目推荐
- PDFMathTranslatePDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython02
- topiam-eiam开源IDaas/IAM平台,用于管理企业内员工账号、权限、身份认证、应用访问,帮助整合部署在本地或云端的内部办公系统、业务系统及三方 SaaS 系统的所有身份,实现一个账号打通所有应用的服务。Java00
- 每日精选项目🔥🔥 12.23日推荐:跨平台终端工具,终端中实现编辑、运行、预览,无需来回切换🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~017
- Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie039
- 毕方Talon工具本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python039
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript0102
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript010
- Yi-CoderYi Coder 编程模型,小而强大的编程助手HTML012
- CommunityCangjie-TPC(Third Party Components)仓颉编程语言三方库社区资源汇总05
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTSX026
热门内容推荐
最新内容推荐
项目优选
收起
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
46
34
PDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/Docker
Python
25
2
Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
171
39
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
164
33
HarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
248
63
RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
21
17
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
892
0
GitCode光引计划有奖征文大赛
GitCode光引计划有奖征文大赛
16
1
RuoYi-Cloud
🎉 基于Spring Boot、Spring Cloud & Alibaba的分布式微服务架构权限管理系统,同时提供了 Vue3 的版本
Java
25
10
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
389
102