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

Packages that use BitMapExtractor
Package
Description
org.apache.commons.collections4.bloomfilter
Implements Bloom filter classes and interfaces.

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

  Subinterfaces of BitMapExtractor in org.apache.commons.collections4.bloomfilter
  Modifier and Type
  Interface
  Description
  `interface`
  `BloomFilter<T extends BloomFilter<T>>`
  The interface that describes a Bloom filter.
  `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 BitMapExtractor
  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<T>>`
  Layered Bloom filters are described in Zhiwang, Cen; Jungang, Xu; Jian, Sun (2010), "A multi-layer Bloom filter for duplicated URL detection", Proc. 3rd International Conference on Advanced Computer Theory and Engineering (ICACTE 2010), vol. 1, pp.
  `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<T extends WrappedBloomFilter<T,W>,W extends BloomFilter<W>>`
  An abstract class to assist in implementing Bloom filter decorators.
  Methods in org.apache.commons.collections4.bloomfilter that return BitMapExtractor
  Modifier and Type
  Method
  Description
  `static BitMapExtractor`
  BitMapExtractor.`fromBitMapArray(long... bitMaps)`
  Creates a BitMapExtractor from an array of Long.
  `static BitMapExtractor`
  BitMapExtractor.`fromIndexExtractor(IndexExtractor extractor, int numberOfBits)`
  Creates a BitMapExtractor from an IndexExtractor.
  Methods in org.apache.commons.collections4.bloomfilter with parameters of type BitMapExtractor
  Modifier and Type
  Method
  Description
  `static int`
  SetOperations.`andCardinality(BitMapExtractor first, BitMapExtractor second)`
  Calculates the cardinality of the logical `AND` of the bit maps for the two filters.
  `static int`
  SetOperations.`cardinality(BitMapExtractor bitMapExtractor)`
  Calculates the cardinality of a BitMapExtractor.
  `boolean`
  ArrayCountingBloomFilter.`contains(BitMapExtractor bitMapExtractor)`
  `default boolean`
  BloomFilter.`contains(BitMapExtractor bitMapExtractor)`
  Returns `true` if this filter contains the bits specified in the bit maps produced by the bitMapExtractor.
  `boolean`
  LayeredBloomFilter.`contains(BitMapExtractor bitMapExtractor)`
  `boolean`
  SparseBloomFilter.`contains(BitMapExtractor bitMapExtractor)`
  `boolean`
  WrappedBloomFilter.`contains(BitMapExtractor bitMapExtractor)`
  `static double`
  SetOperations.`cosineDistance(BitMapExtractor first, BitMapExtractor second)`
  Calculates the Cosine distance between two BitMapExtractor.
  `static double`
  SetOperations.`cosineSimilarity(BitMapExtractor first, BitMapExtractor second)`
  Calculates the Cosine similarity between two BitMapExtractors.
  `int[]`
  LayeredBloomFilter.`find(BitMapExtractor bitMapExtractor)`
  Finds the layers in which the BitMapExtractor is found.
  `static IndexExtractor`
  IndexExtractor.`fromBitMapExtractor(BitMapExtractor bitMapExtractor)`
  Creates an IndexExtractor from a `BitMapExtractor`.
  `default int`
  CountingBloomFilter.`getMaxInsert(BitMapExtractor bitMapExtractor)`
  Determines the maximum number of times the BitMapExtractor could have been merged into this counting filter.
  `static int`
  SetOperations.`hammingDistance(BitMapExtractor first, BitMapExtractor second)`
  Calculates the Hamming distance between two BitMapExtractors.
  `static double`
  SetOperations.`jaccardDistance(BitMapExtractor first, BitMapExtractor second)`
  Calculates the Jaccard distance between two BitMapExtractor.
  `static double`
  SetOperations.`jaccardSimilarity(BitMapExtractor first, BitMapExtractor second)`
  Calculates the Jaccard similarity between two BitMapExtractor.
  `boolean`
  BloomFilter.`merge(BitMapExtractor bitMapExtractor)`
  Merges the specified hasher into this Bloom filter.
  `default boolean`
  CountingBloomFilter.`merge(BitMapExtractor bitMapExtractor)`
  Merges the specified BitMap extractor into this Bloom filter.
  `boolean`
  LayeredBloomFilter.`merge(BitMapExtractor bitMapExtractor)`
  `boolean`
  SimpleBloomFilter.`merge(BitMapExtractor bitMapExtractor)`
  `boolean`
  SparseBloomFilter.`merge(BitMapExtractor bitMapExtractor)`
  `boolean`
  WrappedBloomFilter.`merge(BitMapExtractor bitMapExtractor)`
  `static int`
  SetOperations.`orCardinality(BitMapExtractor first, BitMapExtractor second)`
  Calculates the cardinality of the logical `OR` of the bit maps for the two filters.
  `default boolean`
  BitMapExtractor.`processBitMapPairs(BitMapExtractor other, LongBiPredicate func)`
  Applies the `func` to each bit map pair in order.
  `boolean`
  SimpleBloomFilter.`processBitMapPairs(BitMapExtractor other, LongBiPredicate func)`
  `boolean`
  WrappedBloomFilter.`processBitMapPairs(BitMapExtractor other, LongBiPredicate func)`
  `default boolean`
  CountingBloomFilter.`remove(BitMapExtractor bitMapExtractor)`
  Removes the specified BitMapExtractor from this Bloom filter.
  `static int`
  SetOperations.`xorCardinality(BitMapExtractor first, BitMapExtractor second)`
  Calculates the cardinality of the logical `XOR` of the bit maps for the two filters.