Class BloomFilter<T extends @Nullable Object>

java.lang.Object

com.google.common.hash.BloomFilter<T>

Type Parameters:

T - the type of instances that the BloomFilter accepts

All Implemented Interfaces:

Predicate<T>, Serializable, Predicate<T>

@Beta
public final class BloomFilter<T extends @Nullable Object>
extends Object
implements Predicate<T>, Serializable

A Bloom filter for instances of T. A Bloom filter offers an approximate containment test with one-sided error: if it claims that an element is contained in it, this might be in error, but if it claims that an element is not contained in it, then this is definitely true.

If you are unfamiliar with Bloom filters, this nice tutorial may help you understand how they work.

The false positive probability (FPP) of a Bloom filter is defined as the probability that mightContain(Object) will erroneously return true for an object that has not actually been put in the BloomFilter.

Bloom filters are serializable. They also support a more compact serial representation via the writeTo(OutputStream) and readFrom(InputStream, Funnel) methods. Both serialized forms will continue to be supported by future versions of this library. However, serial forms generated by newer versions of the code may not be readable by older versions of the code (e.g., a serialized Bloom filter generated today may not be readable by a binary that was compiled 6 months ago).

As of Guava 23.0, this class is thread-safe and lock-free. It internally uses atomics and compare-and-swap to ensure correctness when multiple threads are used to access it.

Since:

11.0 (thread-safe since 23.0)

Author:

Dimitris Andreou, Kevin Bourrillion

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	apply(T input)	Deprecated. Provided only to satisfy the Predicate interface; use mightContain(T) instead.
long	approximateElementCount()	Returns an estimate for the total number of distinct elements that have been added to this Bloom filter.
BloomFilter<T>	copy()	Creates a new BloomFilter that's a copy of this instance.
static <T extends @Nullable Object> BloomFilter<T>	create(Funnel<? super T> funnel, int expectedInsertions)	Creates a BloomFilter with the expected number of insertions and a default expected false positive probability of 3%.
static <T extends @Nullable Object> BloomFilter<T>	create(Funnel<? super T> funnel, int expectedInsertions, double fpp)	Creates a BloomFilter with the expected number of insertions and expected false positive probability.
static <T extends @Nullable Object> BloomFilter<T>	create(Funnel<? super T> funnel, long expectedInsertions)	Creates a BloomFilter with the expected number of insertions and a default expected false positive probability of 3%.
static <T extends @Nullable Object> BloomFilter<T>	create(Funnel<? super T> funnel, long expectedInsertions, double fpp)	Creates a BloomFilter with the expected number of insertions and expected false positive probability.
boolean	equals(@Nullable Object object)	Indicates whether another object is equal to this predicate.
double	expectedFpp()	Returns the probability that mightContain(Object) will erroneously return true for an object that has not actually been put in the BloomFilter.
int	hashCode()
boolean	isCompatible(BloomFilter<T> that)	Determines whether a given Bloom filter is compatible with this Bloom filter.
boolean	mightContain(T object)	Returns true if the element might have been put in this Bloom filter, false if this is definitely not the case.
boolean	put(T object)	Puts an element into this BloomFilter.
void	putAll(BloomFilter<T> that)	Combines this Bloom filter with another Bloom filter by performing a bitwise OR of the underlying data.
static <T extends @Nullable Object> BloomFilter<T>	readFrom(InputStream in, Funnel<? super T> funnel)	Reads a byte stream, which was written by writeTo(OutputStream), into a BloomFilter.
boolean	test(T input)	Deprecated. Provided only to satisfy the Predicate interface; use mightContain(T) instead.
static <T extends @Nullable Object> Collector<T, ?, BloomFilter<T>>	toBloomFilter(Funnel<? super T> funnel, long expectedInsertions)	Returns a Collector expecting the specified number of insertions, and yielding a BloomFilter with false positive probability 3%.
static <T extends @Nullable Object> Collector<T, ?, BloomFilter<T>>	toBloomFilter(Funnel<? super T> funnel, long expectedInsertions, double fpp)	Returns a Collector expecting the specified number of insertions, and yielding a BloomFilter with the specified expected false positive probability.
void	writeTo(OutputStream out)	Writes this BloomFilter to an output stream, with a custom format (not Java serialization).

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Predicate

and, negate, or

Method Details

copy

public BloomFilter<T> copy()

Creates a new BloomFilter that's a copy of this instance. The new instance is equal to this instance but shares no mutable state.

Since:

12.0

mightContain

public boolean mightContain(T object)

Returns true if the element might have been put in this Bloom filter, false if this is definitely not the case.

apply

@InlineMe(replacement="this.mightContain(input)")
@Deprecated
public boolean apply(T input)

Deprecated.

Provided only to satisfy the Predicate interface; use mightContain(T) instead.

Description copied from interface: Predicate

Returns the result of applying this predicate to input (Java 8+ users, see notes in the class documentation above). This method is generally expected, but not absolutely required, to have the following properties:

• Its execution does not cause any observable side effects.
• The computation is consistent with equals; that is, Objects.equal(a, b) implies that predicate.apply(a) == predicate.apply(b)).

Specified by:

apply in interface Predicate<T extends @Nullable Object>

test

@InlineMe(replacement="this.mightContain(input)")
@Deprecated
public boolean test(T input)

Deprecated.

Provided only to satisfy the Predicate interface; use mightContain(T) instead.

Specified by:

test in interface Predicate<T extends @Nullable Object>

Specified by:

test in interface Predicate<T extends @Nullable Object>

Since:

21.0

put

@CanIgnoreReturnValue
public boolean put(T object)

Puts an element into this BloomFilter. Ensures that subsequent invocations of mightContain(Object) with the same element will always return true.

Returns:

true if the Bloom filter's bits changed as a result of this operation. If the bits changed, this is definitely the first time object has been added to the filter. If the bits haven't changed, this might be the first time object has been added to the filter. Note that put(t) always returns the opposite result to what mightContain(t) would have returned at the time it is called.

Since:

12.0 (present in 11.0 with void return type})

expectedFpp

public double expectedFpp()

Returns the probability that mightContain(Object) will erroneously return true for an object that has not actually been put in the BloomFilter.

Ideally, this number should be close to the fpp parameter passed in create(Funnel, int, double), or smaller. If it is significantly higher, it is usually the case that too many elements (more than expected) have been put in the BloomFilter, degenerating it.

Since:

14.0 (since 11.0 as expectedFalsePositiveProbability())

approximateElementCount

public long approximateElementCount()

Returns an estimate for the total number of distinct elements that have been added to this Bloom filter. This approximation is reasonably accurate if it does not exceed the value of expectedInsertions that was used when constructing the filter.

Since:

22.0

isCompatible

public boolean isCompatible(BloomFilter<T> that)

Determines whether a given Bloom filter is compatible with this Bloom filter. For two Bloom filters to be compatible, they must:

• not be the same instance
• have the same number of hash functions
• have the same bit size
• have the same strategy
• have equal funnels

Parameters:

that - The Bloom filter to check for compatibility.

Since:

15.0

putAll

public void putAll(BloomFilter<T> that)

Combines this Bloom filter with another Bloom filter by performing a bitwise OR of the underlying data. The mutations happen to this instance. Callers must ensure the Bloom filters are appropriately sized to avoid saturating them.

Parameters:

that - The Bloom filter to combine this Bloom filter with. It is not mutated.

Throws:

IllegalArgumentException - if isCompatible(that) == false

Since:

15.0

equals

public boolean equals(@Nullable Object object)

Description copied from interface: Predicate

Indicates whether another object is equal to this predicate.

Warning: do not depend on the behavior of this method.

Historically, Predicate instances in this library have implemented this method to recognize certain cases where distinct Predicate instances would in fact behave identically. However, as code migrates to java.util.function, that behavior will disappear. It is best not to depend on it.

Specified by:

equals in interface Predicate<T extends @Nullable Object>

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBloomFilter

public static <T extends @Nullable Object>
Collector<T, ?, BloomFilter<T>> toBloomFilter(Funnel<? super T> funnel,
 long expectedInsertions)

Returns a Collector expecting the specified number of insertions, and yielding a BloomFilter with false positive probability 3%.

Note that if the Collector receives significantly more elements than specified, the resulting BloomFilter will suffer a sharp deterioration of its false positive probability.

The constructed BloomFilter will be serializable if the provided Funnel<T> is.

It is recommended that the funnel be implemented as a Java enum. This has the benefit of ensuring proper serialization and deserialization, which is important since equals(Object) also relies on object identity of funnels.

Parameters:

funnel - the funnel of T's that the constructed BloomFilter will use

expectedInsertions - the number of expected insertions to the constructed BloomFilter; must be positive

Returns:

a Collector generating a BloomFilter of the received elements

Since:

23.0 (but only since 33.4.0 in the Android flavor)

toBloomFilter

public static <T extends @Nullable Object>
Collector<T, ?, BloomFilter<T>> toBloomFilter(Funnel<? super T> funnel,
 long expectedInsertions,
 double fpp)

Returns a Collector expecting the specified number of insertions, and yielding a BloomFilter with the specified expected false positive probability.

Note that if the Collector receives significantly more elements than specified, the resulting BloomFilter will suffer a sharp deterioration of its false positive probability.

The constructed BloomFilter will be serializable if the provided Funnel<T> is.

It is recommended that the funnel be implemented as a Java enum. This has the benefit of ensuring proper serialization and deserialization, which is important since equals(Object) also relies on object identity of funnels.

Parameters:

funnel - the funnel of T's that the constructed BloomFilter will use

expectedInsertions - the number of expected insertions to the constructed BloomFilter; must be positive

fpp - the desired false positive probability (must be positive and less than 1.0)

Returns:

a Collector generating a BloomFilter of the received elements

Since:

23.0 (but only since 33.4.0 in the Android flavor)

create

public static <T extends @Nullable Object>
BloomFilter<T> create(Funnel<? super T> funnel,
 int expectedInsertions,
 double fpp)

Creates a BloomFilter with the expected number of insertions and expected false positive probability.

Note that overflowing a BloomFilter with significantly more elements than specified, will result in its saturation, and a sharp deterioration of its false positive probability.

The constructed BloomFilter will be serializable if the provided Funnel<T> is.

It is recommended that the funnel be implemented as a Java enum. This has the benefit of ensuring proper serialization and deserialization, which is important since equals(Object) also relies on object identity of funnels.

Parameters:

funnel - the funnel of T's that the constructed BloomFilter will use

expectedInsertions - the number of expected insertions to the constructed BloomFilter; must be positive

fpp - the desired false positive probability (must be positive and less than 1.0)

Returns:

a BloomFilter

create

public static <T extends @Nullable Object>
BloomFilter<T> create(Funnel<? super T> funnel,
 long expectedInsertions,
 double fpp)

Creates a BloomFilter with the expected number of insertions and expected false positive probability.

Note that overflowing a BloomFilter with significantly more elements than specified, will result in its saturation, and a sharp deterioration of its false positive probability.

The constructed BloomFilter will be serializable if the provided Funnel<T> is.

It is recommended that the funnel be implemented as a Java enum. This has the benefit of ensuring proper serialization and deserialization, which is important since equals(Object) also relies on object identity of funnels.

Parameters:

funnel - the funnel of T's that the constructed BloomFilter will use

expectedInsertions - the number of expected insertions to the constructed BloomFilter; must be positive

fpp - the desired false positive probability (must be positive and less than 1.0)

Returns:

a BloomFilter

Since:

19.0

create

public static <T extends @Nullable Object>
BloomFilter<T> create(Funnel<? super T> funnel,
 int expectedInsertions)

Creates a BloomFilter with the expected number of insertions and a default expected false positive probability of 3%.

Note that overflowing a BloomFilter with significantly more elements than specified, will result in its saturation, and a sharp deterioration of its false positive probability.

The constructed BloomFilter will be serializable if the provided Funnel<T> is.

It is recommended that the funnel be implemented as a Java enum. This has the benefit of ensuring proper serialization and deserialization, which is important since equals(Object) also relies on object identity of funnels.

Parameters:

funnel - the funnel of T's that the constructed BloomFilter will use

expectedInsertions - the number of expected insertions to the constructed BloomFilter; must be positive

Returns:

a BloomFilter

create

public static <T extends @Nullable Object>
BloomFilter<T> create(Funnel<? super T> funnel,
 long expectedInsertions)

Creates a BloomFilter with the expected number of insertions and a default expected false positive probability of 3%.

Note that overflowing a BloomFilter with significantly more elements than specified, will result in its saturation, and a sharp deterioration of its false positive probability.

The constructed BloomFilter will be serializable if the provided Funnel<T> is.

It is recommended that the funnel be implemented as a Java enum. This has the benefit of ensuring proper serialization and deserialization, which is important since equals(Object) also relies on object identity of funnels.

Parameters:

funnel - the funnel of T's that the constructed BloomFilter will use

expectedInsertions - the number of expected insertions to the constructed BloomFilter; must be positive

Returns:

a BloomFilter

Since:

19.0

writeTo

public void writeTo(OutputStream out)
             throws IOException

Writes this BloomFilter to an output stream, with a custom format (not Java serialization). This has been measured to save at least 400 bytes compared to regular serialization.

Use readFrom(InputStream, Funnel) to reconstruct the written BloomFilter.

Throws:

IOException

readFrom

public static <T extends @Nullable Object>
BloomFilter<T> readFrom(InputStream in,
 Funnel<? super T> funnel)
                 throws IOException

Reads a byte stream, which was written by writeTo(OutputStream), into a BloomFilter.

The Funnel to be used is not encoded in the stream, so it must be provided here. Warning: the funnel provided must behave identically to the one used to populate the original Bloom filter!

Throws:

IOException - if the InputStream throws an IOException, or if its data does not appear to be a BloomFilter serialized using the writeTo(OutputStream) method.