com.datadoghq.sketch

Class WithExactSummaryStatistics<QS extends QuantileSketch<QS>>

java.lang.Object

com.datadoghq.sketch.WithExactSummaryStatistics<QS>

Type Parameters:

QS - the type of the wrapped sketch that is used to compute quantiles

All Implemented Interfaces:

QuantileSketch<WithExactSummaryStatistics<QS>>, java.util.function.DoubleConsumer

Direct Known Subclasses:

DDSketchWithExactSummaryStatistics

public class WithExactSummaryStatistics<QS extends QuantileSketch<QS>>
extends java.lang.Object
implements QuantileSketch<WithExactSummaryStatistics<QS>>

A wrapper that returns exact count, sum, average, minimum and maximum, and relies on the provided QuantileSketch to keep track of quantiles.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WithExactSummaryStatistics(QS sketch, double count, double sum, double sumCompensation, double simpleSum, double min, double max)
	WithExactSummaryStatistics(java.util.function.Supplier<QS> sketchSupplier)

Method Summary

Modifier and Type	Method and Description
void	accept(double value) Adds a value to the sketch.
void	accept(double value, double count) Adds a value to the sketch with a floating-point count.
protected void	addToCount(double addend)
protected void	addToSum(double addend)
void	clear() Sets all counts in the sketch to zero.
WithExactSummaryStatistics<QS>	copy()
double	getCount()
double	getMaxValue()
double	getMinValue()
double	getSum()
double	getValueAtQuantile(double quantile)
double[]	getValuesAtQuantiles(double[] quantiles)
protected double	max()
void	mergeWith(WithExactSummaryStatistics<QS> other) Merges the other sketch into this one.
protected double	min()
protected double	simpleSum()
protected QS	sketch()
protected double	sum()
protected double	sumCompensation()
protected void	updateMax(double value)
protected void	updateMin(double value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datadoghq.sketch.QuantileSketch

getAverage, isEmpty

Methods inherited from interface java.util.function.DoubleConsumer

andThen

Constructor Detail

WithExactSummaryStatistics

public WithExactSummaryStatistics(java.util.function.Supplier<QS> sketchSupplier)

WithExactSummaryStatistics

protected WithExactSummaryStatistics(QS sketch,
                                     double count,
                                     double sum,
                                     double sumCompensation,
                                     double simpleSum,
                                     double min,
                                     double max)

Method Detail

sketch

protected final QS sketch()

accept

public void accept(double value)

Description copied from interface: QuantileSketch

Adds a value to the sketch.

Specified by:

accept in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Specified by:

accept in interface java.util.function.DoubleConsumer

Parameters:

value - the value to be added

accept

public void accept(double value,
                   double count)

Description copied from interface: QuantileSketch

Adds a value to the sketch with a floating-point count.

If count is an integer, calling accept(value, count) is equivalent to calling accept(value) count times.

Specified by:

accept in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Parameters:

value - the value to be added

count - the weight associated with the value to be added

mergeWith

public void mergeWith(WithExactSummaryStatistics<QS> other)

Description copied from interface: QuantileSketch

Merges the other sketch into this one. After this operation, this sketch encodes the values that were added to both this and the other sketches.

Specified by:

mergeWith in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Parameters:

other - the sketch to be merged into this one

addToCount

protected final void addToCount(double addend)

addToSum

protected final void addToSum(double addend)

updateMin

protected final void updateMin(double value)

updateMax

protected final void updateMax(double value)

copy

public WithExactSummaryStatistics<QS> copy()

Specified by:

copy in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Returns:

a (deep) copy of this sketch

clear

public void clear()

Description copied from interface: QuantileSketch

Sets all counts in the sketch to zero. The sketch behaves as if it were empty after this call, but any allocated memory is not released.

Specified by:

clear in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

getCount

public double getCount()

Specified by:

getCount in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Returns:

the total number of values that have been added to this sketch

getSum

public double getSum()

Specified by:

getSum in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Returns:

the sum of values that have been added to this sketch (specifically, zero if none has been added)

getMinValue

public double getMinValue()

Specified by:

getMinValue in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Returns:

the minimum value that has been added to this sketch

getMaxValue

public double getMaxValue()

Specified by:

getMaxValue in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Returns:

the maximum value that has been added to this sketch

sum

protected final double sum()

sumCompensation

protected final double sumCompensation()

simpleSum

protected final double simpleSum()

min

protected final double min()

max

protected final double max()

getValueAtQuantile

public double getValueAtQuantile(double quantile)

Specified by:

getValueAtQuantile in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Parameters:

quantile - a number between 0 and 1 (both included)

Returns:

the value at the specified quantile

getValuesAtQuantiles

public double[] getValuesAtQuantiles(double[] quantiles)

Specified by:

getValuesAtQuantiles in interface QuantileSketch<WithExactSummaryStatistics<QS extends QuantileSketch<QS>>>

Parameters:

quantiles - number between 0 and 1 (both included)

Returns:

the values at the respective specified quantiles