java.lang.Object

org.drasyl.util.BloomFilter<E>

org.drasyl.util.CountingBloomFilter<E>

Type Parameters:: E - the type of elements maintained by this set

All Implemented Interfaces:: Iterable<E>, Collection<E>, Set<E>

public class CountingBloomFilter<E> extends BloomFilter<E>

A special BloomFilter that allows you to remove elements.

Nested Class Summary

Nested classes/interfaces inherited from class org.drasyl.util.BloomFilter
BloomFilter.Parameters
Field Summary

Fields inherited from class org.drasyl.util.BloomFilter
bitSet, bytesSupplier, parameters
Constructor Summary

Constructors

Modifier

Constructor

Description

CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier)

Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters.

CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier, int countingBits)

Create a new bloom filter.

CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier, BitSet bitSet)

Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters.

CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier, BitSet bitSet, int countingBits)

Create a new bloom filter.

CountingBloomFilter(int n, double p, Function<E,byte[]> bytesSupplier)

Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters.

CountingBloomFilter(int n, double p, Function<E,byte[]> bytesSupplier, int countingBits)

Create a new counting bloom filter.

CountingBloomFilter(int n, double p, Function<E,byte[]> bytesSupplier, BitSet bitSet)

Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters.

protected

CountingBloomFilter(BloomFilter.Parameters parameters, Function<E,byte[]> bytesSupplier, int countingBits)

protected

CountingBloomFilter(BloomFilter.Parameters parameters, Function<E,byte[]> bytesSupplier, BitSet bitSet, int countingBits)
Method Summary

Modifier and Type

Method

Description

protected boolean

getBit(int index)

void

merge(BloomFilter<E> other)

Merges this filter with other.

boolean

remove(Object o)

Not supported.

boolean

removeAll(Collection<?> c)

Not supported.

protected boolean

setBit(int index)

String

toString()

protected boolean

unsetBit(int index)

Methods inherited from class org.drasyl.util.BloomFilter
add, addAll, bitset, clear, contains, containsAll, hashes, isEmpty, iterator, k, m, n, p, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.Set
equals, hashCode, spliterator

Constructor Details
- CountingBloomFilter
  
  protected CountingBloomFilter(BloomFilter.Parameters parameters, Function<E,byte[]> bytesSupplier, BitSet bitSet, int countingBits)
- CountingBloomFilter
  
  protected CountingBloomFilter(BloomFilter.Parameters parameters, Function<E,byte[]> bytesSupplier, int countingBits)
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier, BitSet bitSet, int countingBits)
  
  Create a new bloom filter. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  If m is not a multiple of MurmurHash3 x86 32-bit hash, this bloom filter is subject of the "modulo bias" effect.
  
  Parameters:
  
  n - Number of items in the filter. If 0, this value is derived from p, m, and k
  
  p - Probability of false positives, fraction between 0 and 1. If 0, this value is derived from n, m, and k
  
  m - Number of bits in the filter. If 0, this value is derived from n and p
  
  k - Number of hash functions. If 0, this value is derived from m and n
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  bitSet - BitSet holding this bloom filter's state. Caller must ensure that it has the correct size.
  
  countingBits - number to bits used for the counter
  
  Throws:
  
  IllegalArgumentException - if one parameter is not 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier, int countingBits)
  
  Create a new bloom filter. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  If m is not a multiple of MurmurHash3 x86 32-bit hash, this bloom filter is subject of the "modulo bias" effect.
  
  Parameters:
  
  n - Number of items in the filter. If 0, this value is derived from p, m, and k
  
  p - Probability of false positives, fraction between 0 and 1. If 0, this value is derived from n, m, and k
  
  m - Number of bits in the filter. If 0, this value is derived from n and p
  
  k - Number of hash functions. If 0, this value is derived from m and n
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  countingBits - number to bits used for the counter
  
  Throws:
  
  IllegalArgumentException - if one parameter is not 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier, BitSet bitSet)
  
  Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  
  Parameters:
  
  n - Number of items in the filter
  
  p - Probability of false positives, fraction between 0 and 1
  
  m - Number of bits in the filter. If 0, this value is derived from n and p
  
  k - Number of hash functions. If 0, this value is derived from m and n
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  bitSet - BitSet holding this bloom filter's state. Caller must ensure that it has the correct size.
  
  Throws:
  
  IllegalArgumentException - if n or p is 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, int m, int k, Function<E,byte[]> bytesSupplier)
  
  Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  
  Parameters:
  
  n - Number of items in the filter
  
  p - Probability of false positives, fraction between 0 and 1
  
  m - Number of bits in the filter. If 0, this value is derived from n and p
  
  k - Number of hash functions. If 0, this value is derived from m and n
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  Throws:
  
  IllegalArgumentException - if n or p is 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, Function<E,byte[]> bytesSupplier, int countingBits)
  
  Create a new counting bloom filter. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  
  Parameters:
  
  n - Number of items in the filter
  
  p - Probability of false positives, fraction between 0 and 1
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  countingBits - number to bits used for the counter
  
  Throws:
  
  IllegalArgumentException - if n or p is 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, Function<E,byte[]> bytesSupplier)
  
  Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  
  Parameters:
  
  n - Number of items in the filter
  
  p - Probability of false positives, fraction between 0 and 1
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  Throws:
  
  IllegalArgumentException - if n or p is 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
- CountingBloomFilter
  
  public CountingBloomFilter(int n, double p, Function<E,byte[]> bytesSupplier, BitSet bitSet)
  
  Create a new counting bloom filter with Short.BYTES * 8 bits reserved for the counters. Make sure to leave one parameter 0 as it must be derived from the other parameters.
  Visit Bloom Filter Calculator to get more information about the implications/calculation of these parameters.
  
  Parameters:
  
  n - Number of items in the filter
  
  p - Probability of false positives, fraction between 0 and 1
  
  bytesSupplier - a Function that convert objects of type E to byte[] arrays
  
  bitSet - BitSet holding this bloom filter's state. Caller must ensure that it has the correct size.
  
  Throws:
  
  IllegalArgumentException - if n or p is 0 or p is not between 0 and 1
  
  NullPointerException - if bytesSupplier is null
Method Details
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class BloomFilter<E>
- remove
  
  public boolean remove(Object o)
  
  Description copied from class: BloomFilter
  
  Not supported. Throws UnsupportedOperationException.
  
  Specified by:
  
  remove in interface Collection<E>
  
  Specified by:
  
  remove in interface Set<E>
  
  Overrides:
  
  remove in class BloomFilter<E>
  
  Returns:
  
  throws UnsupportedOperationException
- removeAll
  
  public boolean removeAll(Collection<?> c)
  
  Description copied from class: BloomFilter
  
  Not supported. Throws UnsupportedOperationException.
  
  Specified by:
  
  removeAll in interface Collection<E>
  
  Specified by:
  
  removeAll in interface Set<E>
  
  Overrides:
  
  removeAll in class BloomFilter<E>
  
  Returns:
  
  throws UnsupportedOperationException
- merge
  
  public void merge(BloomFilter<E> other)
  
  Description copied from class: BloomFilter
  
  Merges this filter with other. While this filter will be contain the merged result, other will be unchanged.
  
  Overrides:
  
  merge in class BloomFilter<E>
  
  Parameters:
  
  other - bloom filter to merge
- getBit
  
  protected boolean getBit(int index)
  
  Overrides:
  
  getBit in class BloomFilter<E>
- setBit
  
  protected boolean setBit(int index)
  
  Overrides:
  
  setBit in class BloomFilter<E>
- unsetBit
  
  protected boolean unsetBit(int index)

Class CountingBloomFilter<E>

Nested Class Summary

Nested classes/interfaces inherited from class org.drasyl.util.BloomFilter

Field Summary

Fields inherited from class org.drasyl.util.BloomFilter

Constructor Summary

Method Summary

Methods inherited from class org.drasyl.util.BloomFilter

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Set

Constructor Details

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

CountingBloomFilter

Method Details

toString

remove

removeAll

merge

getBit

setBit

unsetBit