Class SimpleBloomFilter
- All Implemented Interfaces:
BitMapProducer
,BloomFilter
,IndexProducer
- Since:
- 4.5
-
Field Summary
Fields inherited from interface org.apache.commons.collections4.bloomfilter.BloomFilter
SPARSE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionlong[]
Return a copy of the BitMapProducer data as a bit map array.int
Gets the cardinality (number of enabled bits) of this Bloom filter.int
Returns the characteristics of the filter.void
clear()
Resets the filter to its initial, unpopulated state.boolean
contains
(IndexProducer indexProducer) Returnstrue
if this filter contains the indices specified IndexProducer.copy()
Creates a new instance of the BloomFilter with the same properties as the current one.boolean
forEachBitMap
(LongPredicate consumer) Each bit map is passed to the predicate in order.boolean
forEachBitMapPair
(BitMapProducer other, LongBiPredicate func) Applies thefunc
to each bit map pair in order.boolean
forEachIndex
(IntPredicate consumer) Each index is passed to the predicate.getShape()
Gets the shape that was used when the filter was built.boolean
isEmpty()
Determines if all the bits are off.boolean
merge
(BitMapProducer bitMapProducer) Merges the specified hasher into this Bloom filter.boolean
merge
(BloomFilter other) Merges the specified Bloom filter into this Bloom filter.boolean
Merges the specified hasher into this Bloom filter.boolean
merge
(IndexProducer indexProducer) Merges the specified IndexProducer into this Bloom filter.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.commons.collections4.bloomfilter.BloomFilter
contains, contains, contains, estimateIntersection, estimateN, estimateUnion, isFull, uniqueIndices
Methods inherited from interface org.apache.commons.collections4.bloomfilter.IndexProducer
asIndexArray
-
Constructor Details
-
SimpleBloomFilter
Creates an empty instance.- Parameters:
shape
- The shape for the filter.
-
-
Method Details
-
asBitMapArray
Description copied from interface:BitMapProducer
Return a copy of the BitMapProducer data as a bit map array.The default implementation of this method is slow. It is recommended that implementing classes reimplement this method.
- Specified by:
asBitMapArray
in interfaceBitMapProducer
- Returns:
- An array of bit map data.
-
cardinality
Description copied from interface:BloomFilter
Gets the cardinality (number of enabled bits) of this Bloom filter.This is also known as the Hamming value or Hamming number.
- Specified by:
cardinality
in interfaceBloomFilter
- Returns:
- the cardinality of this filter
-
characteristics
Description copied from interface:BloomFilter
Returns the characteristics of the filter.Characteristics are defined as bits within the characteristics integer.
- Specified by:
characteristics
in interfaceBloomFilter
- Returns:
- the characteristics for this bloom filter.
-
clear
Description copied from interface:BloomFilter
Resets the filter to its initial, unpopulated state.- Specified by:
clear
in interfaceBloomFilter
-
contains
Description copied from interface:BloomFilter
Returnstrue
if this filter contains the indices specified IndexProducer.Specifically this returns
true
if this filter is enabled for all bit indexes identified by theIndexProducer
.- Specified by:
contains
in interfaceBloomFilter
- Parameters:
indexProducer
- the IndexProducer to provide the indexes- Returns:
true
if this filter is enabled for all bits specified by the IndexProducer
-
copy
Description copied from interface:BloomFilter
Creates a new instance of the BloomFilter with the same properties as the current one.- Specified by:
copy
in interfaceBloomFilter
- Returns:
- a copy of this BloomFilter
-
forEachBitMap
Description copied from interface:BitMapProducer
Each bit map is passed to the predicate in order. The predicate is applied to each bit map value, if the predicate returnsfalse
the execution is stopped,false
is returned, and no further bit maps are processed.If the producer is empty this method will return true.
Any exceptions thrown by the action are relayed to the caller.
- Specified by:
forEachBitMap
in interfaceBitMapProducer
- Parameters:
consumer
- the function to execute- Returns:
true
if all bit maps returnedtrue
,false
otherwise.
-
forEachBitMapPair
Description copied from interface:BitMapProducer
Applies thefunc
to each bit map pair in order. Will apply all of the bit maps from the other BitMapProducer to this producer. If this producer does not have as many bit maps it will provide 0 (zero) for all excess calls to the LongBiPredicate.The default implementation of this method uses
asBitMapArray()
. It is recommended that implementations of BitMapProducer that have local arrays reimplement this method.- Specified by:
forEachBitMapPair
in interfaceBitMapProducer
- Parameters:
other
- The other BitMapProducer that provides the y values in the (x,y) pair.func
- The function to apply.- Returns:
- A LongPredicate that tests this BitMapProducers bitmap values in order.
-
forEachIndex
Description copied from interface:IndexProducer
Each index is passed to the predicate. The predicate is applied to each index value, if the predicate returnsfalse
the execution is stopped,false
is returned, and no further indices are processed.Any exceptions thrown by the action are relayed to the caller.
Indices ordering and uniqueness is not guaranteed.
- Specified by:
forEachIndex
in interfaceIndexProducer
- Parameters:
consumer
- the action to be performed for each non-zero bit index.- Returns:
true
if all indexes return true from consumer,false
otherwise.
-
getShape
Description copied from interface:BloomFilter
Gets the shape that was used when the filter was built.- Specified by:
getShape
in interfaceBloomFilter
- Returns:
- The shape the filter was built with.
-
isEmpty
Description copied from interface:BloomFilter
Determines if all the bits are off. This is equivalent tocardinality() == 0
.Note: This method is optimised for non-sparse filters. Implementers are encouraged to implement faster checks if possible.
- Specified by:
isEmpty
in interfaceBloomFilter
- Returns:
true
if no bits are enabled,false
otherwise.
-
merge
Description copied from interface:BloomFilter
Merges the specified hasher into this Bloom filter. Specifically all bit indexes that are identified by theproducer
will be enabled in this filter.Note: This method should return
true
even if no additional bit indexes were enabled. Afalse
result indicates that this filter may or may not contain all the indexes enabled in theproducer
. This state may occur in complex Bloom filter implementations like counting Bloom filters.- Specified by:
merge
in interfaceBloomFilter
- Parameters:
bitMapProducer
- The producer to merge.- Returns:
- true if the merge was successful
-
merge
Description copied from interface:BloomFilter
Merges the specified Bloom filter into this Bloom filter.Specifically all bit indexes that are identified by the
other
will be enabled in this filter.Note: This method should return
true
even if no additional bit indexes were enabled. Afalse
result indicates that this filter may or may not contain theother
Bloom filter. This state may occur in complex Bloom filter implementations like counting Bloom filters.- Specified by:
merge
in interfaceBloomFilter
- Parameters:
other
- The bloom filter to merge into this one.- Returns:
- true if the merge was successful
-
merge
Description copied from interface:BloomFilter
Merges the specified hasher into this Bloom filter. Specifically all bit indexes that are identified by thehasher
will be enabled in this filter.Note: This method should return
true
even if no additional bit indexes were enabled. Afalse
result indicates that this filter may or may not contain thehasher
values. This state may occur in complex Bloom filter implementations like counting Bloom filters.- Specified by:
merge
in interfaceBloomFilter
- Parameters:
hasher
- The hasher to merge.- Returns:
- true if the merge was successful
-
merge
Description copied from interface:BloomFilter
Merges the specified IndexProducer into this Bloom filter. Specifically all bit indexes that are identified by theproducer
will be enabled in this filter.Note: This method should return
true
even if no additional bit indexes were enabled. Afalse
result indicates that this filter may or may not contain all the indexes of theproducer
. This state may occur in complex Bloom filter implementations like counting Bloom filters.- Specified by:
merge
in interfaceBloomFilter
- Parameters:
indexProducer
- The IndexProducer to merge.- Returns:
- true if the merge was successful
-