Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[COLLECTIONS-857] Update documentation to match bloomfilter 

implementation
This commit is contained in:
Gary Gregory 2024-11-15 10:11:32 -05:00
parent 70c7a2acc0
commit 45cd711539
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
View File

@ -37,8 +37,8 @@
*
* <h3>BloomFilter</h3>
*
* <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@code merge}, {@code remove},
* {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.
* <p>The Bloom filter architecture here is designed for speed of execution, so some methods like {@link org.apache.commons.collections4.bloomfilter.CountingBloomFilter}'s
* {@code merge}, {@code remove}, {@code add}, and {@code subtract} may throw exceptions. Once an exception is thrown the state of the Bloom filter is unknown.
* The choice to use not use atomic transactions was made to achieve maximum performance under correct usage.</p>
*
* <h4>Nomenclature</h4>