com.datadoghq.sketch.gk

Class GKArray

java.lang.Object

com.datadoghq.sketch.gk.GKArray

All Implemented Interfaces:

QuantileSketch<GKArray>, java.util.function.DoubleConsumer

public class GKArray
extends java.lang.Object
implements QuantileSketch<GKArray>

An implementation of the quantile sketch of Greenwald and Khanna.

Constructor Summary

Constructors

Constructor and Description
GKArray(double rankAccuracy)

Method Summary

Modifier and Type	Method and Description
void	accept(double value) Adds a value to the sketch.
void	accept(double value, long count) Adds a value to the sketch as many times as specified by count.
GKArray	copy()
double	getCount()
double	getMaxValue()
double	getMinValue()
double	getRankAccuracy()
double	getValueAtQuantile(double quantile)
double[]	getValuesAtQuantiles(double[] quantiles)
boolean	isEmpty()
void	mergeWith(GKArray other) Merges the other sketch into this one.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.DoubleConsumer

andThen

Constructor Detail

GKArray

public GKArray(double rankAccuracy)

Method Detail

getRankAccuracy

public double getRankAccuracy()

accept

public void accept(double value)

Description copied from interface: QuantileSketch

Adds a value to the sketch.

Specified by:

accept in interface QuantileSketch<GKArray>

Specified by:

accept in interface java.util.function.DoubleConsumer

Parameters:

value - the value to be added

accept

public void accept(double value,
                   long count)

Description copied from interface: QuantileSketch

Adds a value to the sketch as many times as specified by count.

Specified by:

accept in interface QuantileSketch<GKArray>

Parameters:

value - the value to be added

count - the number of times the value is to be added

mergeWith

public void mergeWith(GKArray 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<GKArray>

Parameters:

other - the sketch to be merged into this one

copy

public GKArray copy()

Specified by:

copy in interface QuantileSketch<GKArray>

Returns:

a (deep) copy of this sketch

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface QuantileSketch<GKArray>

Returns:

iff no value has been added to this sketch

getCount

public double getCount()

Specified by:

getCount in interface QuantileSketch<GKArray>

Returns:

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

getMinValue

public double getMinValue()

Specified by:

getMinValue in interface QuantileSketch<GKArray>

Returns:

the minimum value that has been added to this sketch

getMaxValue

public double getMaxValue()

Specified by:

getMaxValue in interface QuantileSketch<GKArray>

Returns:

the maximum value that has been added to this sketch

getValueAtQuantile

public double getValueAtQuantile(double quantile)

Specified by:

getValueAtQuantile in interface QuantileSketch<GKArray>

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<GKArray>

Parameters:

quantiles - number between 0 and 1 (both included)

Returns:

the values at the respective specified quantiles