com.clearspring.analytics.stream.cardinality

Interface ICardinality

All Known Implementing Classes:

AdaptiveCounting, CountThenEstimate, HyperBitBit, HyperLogLog, HyperLogLogPlus, LinearCounting, LogLog

public interface ICardinality

Method Summary

Modifier and Type	Method and Description
long	cardinality()
byte[]	getBytes()
ICardinality	merge(ICardinality... estimators) Merges estimators to produce a new estimator for the combined streams of this estimator and those passed as arguments.
boolean	offer(Object o)
boolean	offerHashed(int hashedInt) Offer the value as a hashed long value
boolean	offerHashed(long hashedLong) Offer the value as a hashed long value
int	sizeof()

Method Detail

offer

boolean offer(Object o)

Parameters:

o - stream element

Returns:

false if the value returned by cardinality() is unaffected by the appearance of o in the stream.

offerHashed

boolean offerHashed(long hashedLong)

Offer the value as a hashed long value

Parameters:

hashedLong - - the hash of the item to offer to the estimator

Returns:

false if the value returned by cardinality() is unaffected by the appearance of hashedLong in the stream

offerHashed

boolean offerHashed(int hashedInt)

Offer the value as a hashed long value

Parameters:

hashedInt - - the hash of the item to offer to the estimator

Returns:

false if the value returned by cardinality() is unaffected by the appearance of hashedInt in the stream

cardinality

long cardinality()

Returns:

the number of unique elements in the stream or an estimate thereof

sizeof

int sizeof()

Returns:

size in bytes needed for serialization

getBytes

byte[] getBytes()
         throws IOException

Returns:

Throws:

IOException

merge

ICardinality merge(ICardinality... estimators)
            throws CardinalityMergeException

Merges estimators to produce a new estimator for the combined streams of this estimator and those passed as arguments.

Nor this estimator nor the one passed as parameters are modified.

Parameters:

estimators - Zero or more compatible estimators

Throws:

CardinalityMergeException - If at least one of the estimators is not compatible with this one