# Uses of Interface
org.apache.commons.collections4.bloomfilter.BloomFilter

Packages that use BloomFilter
Package
Description
org.apache.commons.collections4.bloomfilter
Collects extensible Bloom filter classes and interfaces.

- ## Uses of BloomFilter in org.apache.commons.collections4.bloomfilter

  Classes in org.apache.commons.collections4.bloomfilter with type parameters of type BloomFilter
  Modifier and Type
  Class
  Description
  `class`
  `LayeredBloomFilter<T extends BloomFilter>`
  Layered Bloom filters are described in Zhiwang, Cen; Jungang, Xu; Jian, Sun (2010), "A multi-layer Bloom filter for duplicated URL detection", Proc.
  `class`
  `LayerManager<T extends BloomFilter>`
  Implementation of the methods to manage the layers in a layered Bloom filter.
  `static class`
  `LayerManager.Builder<T extends BloomFilter>`
  Builder to create Layer Manager
  Subinterfaces of BloomFilter in org.apache.commons.collections4.bloomfilter
  Modifier and Type
  Interface
  Description
  `interface`
  `CountingBloomFilter`
  The interface that describes a Bloom filter that associates a count with each bit index rather than a bit.
  Classes in org.apache.commons.collections4.bloomfilter that implement BloomFilter
  Modifier and Type
  Class
  Description
  `final class`
  `ArrayCountingBloomFilter`
  A counting Bloom filter using an int array to track cells for each enabled bit.
  `class`
  `LayeredBloomFilter<T extends BloomFilter>`
  Layered Bloom filters are described in Zhiwang, Cen; Jungang, Xu; Jian, Sun (2010), "A multi-layer Bloom filter for duplicated URL detection", Proc.
  `final class`
  `SimpleBloomFilter`
  A bloom filter using an array of bit maps to track enabled bits.
  `final class`
  `SparseBloomFilter`
  A bloom filter using a TreeSet of integers to track enabled bits.
  `class`
  `WrappedBloomFilter`
  An abstract class to assist in implementing Bloom filter decorators.
  Methods in org.apache.commons.collections4.bloomfilter with type parameters of type BloomFilter
  Modifier and Type
  Method
  Description
  `static <T extends BloomFilter>
  Predicate<LayerManager<T>>`
  LayerManager.ExtendCheck.`advanceOnCount(int breakAt)`
  Creates a new target after a specific number of filters have been added to the current target.
  `static <T extends BloomFilter>
  Predicate<LayerManager<T>>`
  LayerManager.ExtendCheck.`advanceOnPopulated()`
  Advances the target once a merge has been performed.
  `static <T extends BloomFilter>
  Predicate<LayerManager<T>>`
  LayerManager.ExtendCheck.`advanceOnSaturation(double maxN)`
  Creates a new target after the current target is saturated.
  `static <T extends BloomFilter>
  LayerManager.Builder<T>`
  LayerManager.`builder()`
  Creates a new Builder with defaults of `ExtendCheck.neverAdvance()` and `Cleanup.noCleanup()`.
  `<T extends BloomFilter>
  T`
  BloomFilter.`copy()`
  Creates a new instance of the BloomFilter with the same properties as the current one.
  `static <T extends BloomFilter>
  Predicate<LayerManager<T>>`
  LayerManager.ExtendCheck.`neverAdvance()`
  Does not automatically advance the target.
  `static <T extends BloomFilter>
  Consumer<Deque<T>>`
  LayerManager.Cleanup.`noCleanup()`
  A Cleanup that never removes anything.
  `static <T extends BloomFilter>
  Consumer<Deque<T>>`
  LayerManager.Cleanup.`onMaxSize(int maxSize)`
  Removes the earliest filters in the list when the the number of filters exceeds maxSize.
  `static <T extends BloomFilter>
  Consumer<Deque<T>>`
  LayerManager.Cleanup.`removeEmptyTarget()`
  Removes the last added target if it is empty.
  `static <T extends BloomFilter>
  Consumer<Deque<T>>`
  LayerManager.Cleanup.`removeIf(Predicate<? super T> test)`
  Removes any layer identified by the predicate.
  Methods in org.apache.commons.collections4.bloomfilter that return BloomFilter
  Modifier and Type
  Method
  Description
  `default BloomFilter[]`
  BloomFilterExtractor.`asBloomFilterArray()`
  Return an array of the Bloom filters in the collection.
  `default BloomFilter`
  BloomFilterExtractor.`flatten()`
  Create a standard (non-layered) Bloom filter by merging all of the layers.
  `BloomFilter`
  LayeredBloomFilter.`flatten()`
  Create a standard (non-layered) Bloom filter by merging all of the layers.
  `protected BloomFilter`
  WrappedBloomFilter.`getWrapped()`
  Methods in org.apache.commons.collections4.bloomfilter with parameters of type BloomFilter
  Modifier and Type
  Method
  Description
  `default boolean`
  BloomFilter.`contains(BloomFilter other)`
  Returns `true` if this filter contains the specified filter.
  `boolean`
  LayeredBloomFilter.`contains(BloomFilter other)`
  Returns `true` if this any layer contained by this filter contains the specified filter.
  `boolean`
  WrappedBloomFilter.`contains(BloomFilter other)`
  `static double`
  SetOperations.`cosineSimilarity(BloomFilter first, BloomFilter second)`
  Calculates the Cosine similarity between two Bloom filters.
  `default int`
  BloomFilter.`estimateIntersection(BloomFilter other)`
  Estimates the number of items in the intersection of this Bloom filter with the other bloom filter.
  `int`
  WrappedBloomFilter.`estimateIntersection(BloomFilter other)`
  `default int`
  BloomFilter.`estimateUnion(BloomFilter other)`
  Estimates the number of items in the union of this Bloom filter with the other bloom filter.
  `int`
  LayeredBloomFilter.`estimateUnion(BloomFilter other)`
  `int`
  WrappedBloomFilter.`estimateUnion(BloomFilter other)`
  `int[]`
  LayeredBloomFilter.`find(BloomFilter bf)`
  Finds the layers in which the Bloom filter is found.
  `static BloomFilterExtractor`
  BloomFilterExtractor.`fromBloomFilterArray(BloomFilter... filters)`
  Creates a BloomFilterExtractor from an array of Bloom filters.
  `default int`
  CountingBloomFilter.`getMaxInsert(BloomFilter bloomFilter)`
  Determines the maximum number of times the Bloom filter could have been merged into this counting filter.
  `default boolean`
  BloomFilter.`merge(BloomFilter other)`
  Merges the specified Bloom filter into this Bloom filter.
  `default boolean`
  CountingBloomFilter.`merge(BloomFilter other)`
  Merges the specified Bloom filter into this Bloom filter.
  `boolean`
  LayeredBloomFilter.`merge(BloomFilter bf)`
  `boolean`
  SimpleBloomFilter.`merge(BloomFilter other)`
  `boolean`
  SparseBloomFilter.`merge(BloomFilter other)`
  `boolean`
  WrappedBloomFilter.`merge(BloomFilter other)`
  `default boolean`
  CountingBloomFilter.`remove(BloomFilter other)`
  Removes the specified Bloom filter from this Bloom filter.
  Method parameters in org.apache.commons.collections4.bloomfilter with type arguments of type BloomFilter
  Modifier and Type
  Method
  Description
  `default boolean`
  BloomFilterExtractor.`processBloomFilterPair(BloomFilterExtractor other, BiPredicate<BloomFilter,BloomFilter> func)`
  Applies the `func` to each Bloom filter pair in order.
  `default boolean`
  BloomFilterExtractor.`processBloomFilterPair(BloomFilterExtractor other, BiPredicate<BloomFilter,BloomFilter> func)`
  Applies the `func` to each Bloom filter pair in order.
  `boolean`
  BloomFilterExtractor.`processBloomFilters(Predicate<BloomFilter> bloomFilterPredicate)`
  Executes a Bloom filter Predicate on each Bloom filter in the collection.
  `final boolean`
  LayeredBloomFilter.`processBloomFilters(Predicate<BloomFilter> bloomFilterPredicate)`
  Processes the Bloom filters in depth order with the most recent filters first.
  `boolean`
  LayerManager.`processBloomFilters(Predicate<BloomFilter> bloomFilterPredicate)`
  Executes a Bloom filter Predicate on each Bloom filter in the manager in depth order.
  Constructors in org.apache.commons.collections4.bloomfilter with parameters of type BloomFilter
  Modifier
  Constructor
  Description
  ``
  `WrappedBloomFilter(BloomFilter bf)`
  Wraps a Bloom filter.