added LayeredBloomFilter to overview.

apache · Jul 6, 2023 · 6188866 · 6188866
1 parent ac92c7d
commit 6188866
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
@@ -43,7 +43,7 @@
  * representation of the internal structure. Additional methods are available in the {@code BitMap} to assist in
  * manipulation of the representations.</p>
  *
- * <p>The bloom filter code is an interface that requires implementation of 9 methods:</p>
+ * <p>The Bloom filter code is an interface that requires implementation of 9 methods:</p>
  * <ul>
  * <li>{@link BloomFilter#cardinality()} returns the number of bits enabled in the Bloom filter.</li>
  *
@@ -69,9 +69,14 @@
  *
  * <h3>CountingBloomFilter</h3>
  *
- * <p>The counting bloom filter extends the Bloom filter by counting the number of times a specific bit has been
+ * <p>The counting Bloom filter extends the Bloom filter by counting the number of times a specific bit has been
  * enabled or disabled. This allows the removal (opposite of merge) of Bloom filters at the expense of additional
  * overhead.</p>
+ * 
+ * <h3>LayeredBloomFilter</h3>
+ *
+ * <p>The layered Bloom filter extends the Bloom filter by creating layers of Bloom filters that can be queried as a single 
+ * Filter or as a set of filters.  This adds the ability to perform windowing on streams of data.</p>
  *
  * <h3>Shape</h3>
  *