CountingBloomFilterRedis (bloom-filter 1.0 API)

java.lang.Object
- orestes.bloomfilter.redis.CountingBloomFilterRedis<T>

Type Parameters:

T -

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, BloomFilter<T>, CountingBloomFilter<T>
```
public class CountingBloomFilterRedis<T>
extends java.lang.Object
implements CountingBloomFilter<T>
```
Uses regular key-value pairs for counting instead of a bitarray. This introduces a space overhead but allows distribution of keys, thus increasing throughput. Pipelining can also be leveraged in this approach to minimize network latency.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CountingBloomFilterRedis(FilterBuilder builder)

Constructors
Constructor and Description
`CountingBloomFilterRedis(FilterBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`addAndEstimateCount(byte[] element)` Adds an element and returns its estimated frequency after the insertion (i.e. the number of times the element was added to the filter).
`void`	`clear()` Removes all elements from the filter (i.e. resets all bits to zero).
`CountingBloomFilter<T>`	`clone()` Constructs a deep copy of the Bloom filter
`FilterBuilder`	`config()` Returns the configuration/builder of the Bloom filter.
`boolean`	`contains(byte[] element)` Tests whether an element is present in the filter (subject to the specified false positive rate).
`boolean`	`equals(java.lang.Object o)`
`java.util.BitSet`	`getBitSet()` Return the underyling bit vector of the Bloom filter.
`long`	`getEstimatedCount(T element)` Return the estimated count for an element using the Mininum Selection algorithm (i.e. by choosing the minimum counter for the given element).
`java.lang.Double`	`getEstimatedPopulation()` Estimates the current population of the Bloom filter (see: http://en.wikipedia.org/wiki/Bloom_filter#Approximating_the_number_of_items_in_a_Bloom_filter )
`protected RedisBitSet`	`getRedisBitSet()`
`boolean`	`intersect(BloomFilter<T> other)` Performs the intersection operation on two compatible bloom filters.
`boolean`	`isEmpty()` Returns `true` if the Bloom filter does not contain any elements
`void`	`remove()` Destroys the Bloom filter by deleting its contents and metadata
`boolean`	`remove(byte[] value)` Removes the object from the counting bloom filter.
`long`	`removeAndEstimateCount(byte[] value)` Removes an element and returns its estimated frequency after the insertion (i.e. the number of times the element was added to the filter).
`boolean`	`union(BloomFilter<T> other)` Performs the union operation on two compatible bloom filters.

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

Methods inherited from interface orestes.bloomfilter.CountingBloomFilter
add, addAndEstimateCount, getCountingBits, remove, removeAll, removeAndEstimateCount

Methods inherited from interface orestes.bloomfilter.BloomFilter
add, addAll, asString, compatible, contains, contains, containsAll, getBitsPerElement, getBitZeroProbability, getEstimatedFalsePositiveProbability, getExpectedElements, getFalsePositiveProbability, getFalsePositiveProbability, getHashes, getSize, hash, hash, population, toBytes

- Constructor Detail
  - CountingBloomFilterRedis
```
public CountingBloomFilterRedis(FilterBuilder builder)
```
- Method Detail
  - addAndEstimateCount
```
public long addAndEstimateCount(byte[] element)
```
    Description copied from interface: CountingBloomFilter
    
    Adds an element and returns its estimated frequency after the insertion (i.e. the number of times the element was added to the filter).
    
    Specified by:
    
    addAndEstimateCount in interface CountingBloomFilter<T>
    
    Parameters:
    
    element - element to add
    
    Returns:
    
    estimated frequency of the element after insertion
  - remove
```
public boolean remove(byte[] value)
```
    Description copied from interface: CountingBloomFilter
    
    Removes the object from the counting bloom filter.
    
    Specified by:
    
    remove in interface CountingBloomFilter<T>
    
    Parameters:
    
    value - object to be deleted
    
    Returns:
    
    true if the element is not present after removal
  - removeAndEstimateCount
```
public long removeAndEstimateCount(byte[] value)
```
    Description copied from interface: CountingBloomFilter
    
    Removes an element and returns its estimated frequency after the insertion (i.e. the number of times the element was added to the filter).
    
    Specified by:
    
    removeAndEstimateCount in interface CountingBloomFilter<T>
    
    Parameters:
    
    value - element to remove
    
    Returns:
    
    estimated frequency of the element after deletion
  - getEstimatedCount
```
public long getEstimatedCount(T element)
```
    Description copied from interface: CountingBloomFilter
    
    Return the estimated count for an element using the Mininum Selection algorithm (i.e. by choosing the minimum counter for the given element). This estimation is biased, as it doest not consider how full the filter is, but performs best in practice. The underlying theoretical foundation are spectral Bloom filters, see: http://theory.stanford.edu/~matias/papers/sbf_thesis.pdf
    
    Specified by:
    
    getEstimatedCount in interface CountingBloomFilter<T>
    
    Parameters:
    
    element - element to query
    
    Returns:
    
    estimated count of the element
  - clear
```
public void clear()
```
    Description copied from interface: BloomFilter
    
    Removes all elements from the filter (i.e. resets all bits to zero).
    
    Specified by:
    
    clear in interface BloomFilter<T>
  - remove
```
public void remove()
```
    Description copied from interface: BloomFilter
    
    Destroys the Bloom filter by deleting its contents and metadata
    
    Specified by:
    
    remove in interface BloomFilter<T>
  - contains
```
public boolean contains(byte[] element)
```
    Description copied from interface: BloomFilter
    
    Tests whether an element is present in the filter (subject to the specified false positive rate).
    
    Specified by:
    
    contains in interface BloomFilter<T>
    
    Returns:
    
    true if the element is contained
  - getRedisBitSet
```
protected RedisBitSet getRedisBitSet()
```
  - getBitSet
```
public java.util.BitSet getBitSet()
```
    Description copied from interface: BloomFilter
    
    Return the underyling bit vector of the Bloom filter.
    
    Specified by:
    
    getBitSet in interface BloomFilter<T>
    
    Returns:
    
    the underyling bit vector of the Bloom filter.
  - config
```
public FilterBuilder config()
```
    Description copied from interface: BloomFilter
    
    Returns the configuration/builder of the Bloom filter.
    
    Specified by:
    
    config in interface BloomFilter<T>
    
    Returns:
    
    the configuration/builder of the Bloom filter.
  - clone
```
public CountingBloomFilter<T> clone()
```
    Description copied from interface: BloomFilter
    
    Constructs a deep copy of the Bloom filter
    
    Specified by:
    
    clone in interface BloomFilter<T>
    
    Specified by:
    
    clone in interface CountingBloomFilter<T>
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    copy of the filter.
  - union
```
public boolean union(BloomFilter<T> other)
```
    Description copied from interface: BloomFilter
    
    Performs the union operation on two compatible bloom filters. This is achieved through a bitwise OR operation on their bit vectors. This operations is lossless, i.e. no elements are lost and the bloom filter is the same that would have resulted if all elements wer directly inserted in just one bloom filter.
    
    Specified by:
    
    union in interface BloomFilter<T>
    
    Parameters:
    
    other - the other bloom filter
    
    Returns:
    
    true if this bloom filter could successfully be updated through the union with the provided bloom filter
  - intersect
```
public boolean intersect(BloomFilter<T> other)
```
    Description copied from interface: BloomFilter
    
    Performs the intersection operation on two compatible bloom filters. This is achieved through a bitwise AND operation on their bit vectors. The operations doesn't introduce any false negatives but it does raise the false positive probability. The the false positive probability in the resulting Bloom filter is at most the false-positive probability in one of the constituent bloom filters
    
    Specified by:
    
    intersect in interface BloomFilter<T>
    
    Parameters:
    
    other - the other bloom filter
    
    Returns:
    
    true if this bloom filter could successfully be updated through the intersection with the provided bloom filter
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: BloomFilter
    
    Returns true if the Bloom filter does not contain any elements
    
    Specified by:
    
    isEmpty in interface BloomFilter<T>
    
    Returns:
    
    true if the Bloom filter does not contain any elements
  - getEstimatedPopulation
```
public java.lang.Double getEstimatedPopulation()
```
    Description copied from interface: BloomFilter
    
    Estimates the current population of the Bloom filter (see: http://en.wikipedia.org/wiki/Bloom_filter#Approximating_the_number_of_items_in_a_Bloom_filter )
    
    Specified by:
    
    getEstimatedPopulation in interface BloomFilter<T>
    
    Returns:
    
    the estimated amount of elements in the filter
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class CountingBloomFilterRedis<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface orestes.bloomfilter.CountingBloomFilter

Methods inherited from interface orestes.bloomfilter.BloomFilter

Constructor Detail

CountingBloomFilterRedis

Method Detail

addAndEstimateCount

remove

removeAndEstimateCount

getEstimatedCount

clear

remove

contains

getRedisBitSet

getBitSet

config

clone

union

intersect

isEmpty

getEstimatedPopulation

equals