io.lettuce.core.cluster.api.async

Interface NodeSelectionTDigestAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

NodeSelectionAsyncCommands<K,V>

public interface NodeSelectionTDigestAsyncCommands<K,V>

Asynchronous executed commands on a node selection for T-Digest sketch.

Since:

7.7

Author:

Yordan Tsintsov

See Also:

Redis T-Digest

Method Summary

Modifier and Type	Method and Description
AsyncExecutions<String>	tdigestAdd(K key, double... values) Adds one or more observations to a t-digest sketch.
AsyncExecutions<String>	tdigestAdd(K key, double value) Adds one observation to a t-digest sketch.
AsyncExecutions<List<Double>>	tdigestByRank(K key, long... ranks) Returns, for each given rank, an estimation of the value with that rank.
AsyncExecutions<List<Double>>	tdigestByRank(K key, long rank) Returns, for the given rank, an estimation of the value with that rank.
AsyncExecutions<List<Double>>	tdigestByRevRank(K key, long... reverseRanks) Returns, for each given reverse rank, an estimation of the value with that reverse rank.
AsyncExecutions<List<Double>>	tdigestByRevRank(K key, long reverseRank) Returns, for the given reverse rank, an estimation of the value with that reverse rank.
AsyncExecutions<List<Double>>	tdigestCDF(K key, double... values) Returns, for each given value, an estimation of the fraction (cumulative distribution) of observations that are smaller than or equal to it.
AsyncExecutions<List<Double>>	tdigestCDF(K key, double value) Returns, for the given value, an estimation of the fraction (cumulative distribution) of observations that are smaller than or equal to it.
AsyncExecutions<String>	tdigestCreate(K key) Creates a new t-digest sketch with the default compression.
AsyncExecutions<String>	tdigestCreate(K key, long compression) Creates a new t-digest sketch with the given compression.
AsyncExecutions<TDigestInfoValue>	tdigestInfo(K key) Returns information and configuration about a t-digest sketch.
AsyncExecutions<Double>	tdigestMax(K key) Returns the maximum observation value from a t-digest sketch.
AsyncExecutions<String>	tdigestMerge(K destination, K... sourceKeys) Merges one or more source sketches into the destination sketch.
AsyncExecutions<String>	tdigestMerge(K destination, K sourceKey) Merges a source sketch into the destination sketch.
AsyncExecutions<String>	tdigestMerge(K destination, K sourceKey, TDigestMergeArgs mergeArgs) Merges a source sketch into the destination sketch applying the given arguments.
AsyncExecutions<String>	tdigestMerge(K destination, TDigestMergeArgs mergeArgs, K... sourceKeys) Merges one or more source sketches into the destination sketch applying the given arguments.
AsyncExecutions<Double>	tdigestMin(K key) Returns the minimum observation value from a t-digest sketch.
AsyncExecutions<List<Double>>	tdigestQuantile(K key, double... quantiles) Returns, for each given quantile, an estimation of the value at that quantile.
AsyncExecutions<List<Double>>	tdigestQuantile(K key, double quantile) Returns, for the given quantile, an estimation of the value at that quantile.
AsyncExecutions<List<Long>>	tdigestRank(K key, double... values) Returns, for each given value, the estimated rank, that is the number of observations that are smaller than the value plus half the number of observations that are equal to the value.
AsyncExecutions<List<Long>>	tdigestRank(K key, double value) Returns, for the given value, the estimated rank, that is the number of observations that are smaller than the value plus half the number of observations that are equal to the value.
AsyncExecutions<String>	tdigestReset(K key) Resets a t-digest sketch, removing all its observations while keeping the sketch and its configuration in place.
AsyncExecutions<List<Long>>	tdigestRevRank(K key, double... values) Returns, for each given value, the estimated reverse rank, that is the number of observations that are larger than the value plus half the number of observations that are equal to the value.
AsyncExecutions<List<Long>>	tdigestRevRank(K key, double value) Returns, for the given value, the estimated reverse rank, that is the number of observations that are larger than the value plus half the number of observations that are equal to the value.
AsyncExecutions<Double>	tdigestTrimmedMean(K key, double lowCutQuantile, double highCutQuantile) Returns an estimation of the mean value from the sketch, excluding observation values outside the low and high cutoff quantiles.

Method Detail

tdigestAdd

AsyncExecutions<String> tdigestAdd(K key,
                                   double value)

Adds one observation to a t-digest sketch. The sketch must have been created beforehand with TDIGEST.CREATE.

Parameters:

key - the key.

value - the value of the observation.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestAdd

AsyncExecutions<String> tdigestAdd(K key,
                                   double... values)

Adds one or more observations to a t-digest sketch. The sketch must have been created beforehand with TDIGEST.CREATE.

Parameters:

key - the key.

values - the values of the observations.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestByRank

AsyncExecutions<List<Double>> tdigestByRank(K key,
                                            long rank)

Returns, for the given rank, an estimation of the value with that rank. Ranks are zero-based, where rank 0 corresponds to the smallest observation (the minimum).

Parameters:

key - the key.

rank - the rank for which the value should be estimated, must not be negative.

Returns:

List<Double> a single-element list holding the estimated value with the given rank. The value is inf if the rank is equal to or exceeds the number of observations and nan if the sketch is empty.

tdigestByRank

AsyncExecutions<List<Double>> tdigestByRank(K key,
                                            long... ranks)

Returns, for each given rank, an estimation of the value with that rank. Ranks are zero-based, where rank 0 corresponds to the smallest observation (the minimum).

Parameters:

key - the key.

ranks - the ranks for which the values should be estimated, must not be negative.

Returns:

List<Double> one entry per input rank holding the estimated value with that rank. An entry is inf if the rank is equal to or exceeds the number of observations. All entries are nan if the sketch is empty.

tdigestByRevRank

AsyncExecutions<List<Double>> tdigestByRevRank(K key,
                                               long reverseRank)

Returns, for the given reverse rank, an estimation of the value with that reverse rank. Reverse ranks are zero-based, where reverse rank 0 corresponds to the largest observation (the maximum).

Parameters:

key - the key.

reverseRank - the reverse rank for which the value should be estimated, must not be negative.

Returns:

List<Double> a single-element list holding the estimated value with the given reverse rank. The value is -inf if the reverse rank is equal to or exceeds the number of observations and nan if the sketch is empty.

tdigestByRevRank

AsyncExecutions<List<Double>> tdigestByRevRank(K key,
                                               long... reverseRanks)

Returns, for each given reverse rank, an estimation of the value with that reverse rank. Reverse ranks are zero-based, where reverse rank 0 corresponds to the largest observation (the maximum).

Parameters:

key - the key.

reverseRanks - the reverse ranks for which the values should be estimated, must not be negative.

Returns:

List<Double> one entry per input reverse rank holding the estimated value with that reverse rank. An entry is -inf if the reverse rank is equal to or exceeds the number of observations. All entries are nan if the sketch is empty.

tdigestCDF

AsyncExecutions<List<Double>> tdigestCDF(K key,
                                         double value)

Returns, for the given value, an estimation of the fraction (cumulative distribution) of observations that are smaller than or equal to it.

Parameters:

key - the key.

value - the value for which the fraction should be estimated.

Returns:

List<Double> a single-element list holding the estimated fraction, in the range [0, 1], of observations smaller than or equal to the given value.

tdigestCDF

AsyncExecutions<List<Double>> tdigestCDF(K key,
                                         double... values)

Returns, for each given value, an estimation of the fraction (cumulative distribution) of observations that are smaller than or equal to it.

Parameters:

key - the key.

values - the values for which the fractions should be estimated.

Returns:

List<Double> one entry per input value holding the estimated fraction, in the range [0, 1], of observations smaller than or equal to that value.

tdigestCreate

AsyncExecutions<String> tdigestCreate(K key)

Creates a new t-digest sketch with the default compression. The default compression is 100.

Parameters:

key - the key.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestCreate

AsyncExecutions<String> tdigestCreate(K key,
                                      long compression)

Creates a new t-digest sketch with the given compression. Higher compression values yield more accurate estimates at the cost of more memory and slower operations.

Parameters:

key - the key.

compression - the compression parameter that controls the accuracy versus memory trade-off.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestInfo

AsyncExecutions<TDigestInfoValue> tdigestInfo(K key)

Returns information and configuration about a t-digest sketch.

Parameters:

key - the key.

Returns:

TDigestInfoValue the information about the sketch.

tdigestMax

AsyncExecutions<Double> tdigestMax(K key)

Returns the maximum observation value from a t-digest sketch.

Parameters:

key - the key.

Returns:

Double the maximum observation value, or nan if the sketch is empty.

tdigestMerge

AsyncExecutions<String> tdigestMerge(K destination,
                                     K sourceKey)

Merges a source sketch into the destination sketch. The destination sketch is created if it does not exist.

Parameters:

destination - the key of the destination sketch that receives the merged data.

sourceKey - the key of the source sketch to merge.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestMerge

AsyncExecutions<String> tdigestMerge(K destination,
                                     K sourceKey,
                                     TDigestMergeArgs mergeArgs)

Merges a source sketch into the destination sketch applying the given arguments. The destination sketch is created if it does not exist.

Parameters:

destination - the key of the destination sketch that receives the merged data.

sourceKey - the key of the source sketch to merge.

mergeArgs - the arguments controlling the compression of the destination sketch and whether the destination sketch is reset before the merge, must not be null.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestMerge

AsyncExecutions<String> tdigestMerge(K destination,
                                     K... sourceKeys)

Merges one or more source sketches into the destination sketch. The destination sketch is created if it does not exist. The source data is merged into the existing destination data and the compression of the destination sketch is retained.

Parameters:

destination - the key of the destination sketch that receives the merged data.

sourceKeys - the keys of the source sketches to merge, must not be empty.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestMerge

AsyncExecutions<String> tdigestMerge(K destination,
                                     TDigestMergeArgs mergeArgs,
                                     K... sourceKeys)

Merges one or more source sketches into the destination sketch applying the given arguments. The destination sketch is created if it does not exist.

Parameters:

destination - the key of the destination sketch that receives the merged data.

mergeArgs - the arguments controlling the compression of the destination sketch and whether the destination sketch is reset before the merge, must not be null.

sourceKeys - the keys of the source sketches to merge, must not be empty.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestMin

AsyncExecutions<Double> tdigestMin(K key)

Returns the minimum observation value from a t-digest sketch.

Parameters:

key - the key.

Returns:

Double the minimum observation value, or nan if the sketch is empty.

tdigestQuantile

AsyncExecutions<List<Double>> tdigestQuantile(K key,
                                              double quantile)

Returns, for the given quantile, an estimation of the value at that quantile.

Parameters:

key - the key.

quantile - the quantile, in the range [0, 1], for which the value should be estimated.

Returns:

List<Double> a single-element list holding the estimated value at the given quantile, or nan if the sketch is empty.

tdigestQuantile

AsyncExecutions<List<Double>> tdigestQuantile(K key,
                                              double... quantiles)

Returns, for each given quantile, an estimation of the value at that quantile.

Parameters:

key - the key.

quantiles - the quantiles, each in the range [0, 1], for which the values should be estimated.

Returns:

List<Double> one entry per input quantile holding the estimated value at that quantile, or nan if the sketch is empty.

tdigestRank

AsyncExecutions<List<Long>> tdigestRank(K key,
                                        double value)

Returns, for the given value, the estimated rank, that is the number of observations that are smaller than the value plus half the number of observations that are equal to the value. Ranks are zero-based.

Parameters:

key - the key.

value - the value for which the rank should be estimated.

Returns:

List<Long> a single-element list holding the estimated rank of the value. The rank is -1 if the value is smaller than the minimum observation, equal to the number of observations if it is larger than the maximum, and -2 if the sketch is empty.

tdigestRank

AsyncExecutions<List<Long>> tdigestRank(K key,
                                        double... values)

Returns, for each given value, the estimated rank, that is the number of observations that are smaller than the value plus half the number of observations that are equal to the value. Ranks are zero-based.

Parameters:

key - the key.

values - the values for which the ranks should be estimated.

Returns:

List<Long> one entry per input value holding its estimated rank. An entry is -1 if the value is smaller than the minimum observation and equal to the number of observations if it is larger than the maximum. All entries are -2 if the sketch is empty.

tdigestReset

AsyncExecutions<String> tdigestReset(K key)

Resets a t-digest sketch, removing all its observations while keeping the sketch and its configuration in place.

Parameters:

key - the key.

Returns:

String simple-string-reply OK if the command was executed correctly.

tdigestRevRank

AsyncExecutions<List<Long>> tdigestRevRank(K key,
                                           double value)

Returns, for the given value, the estimated reverse rank, that is the number of observations that are larger than the value plus half the number of observations that are equal to the value. Reverse ranks are zero-based.

Parameters:

key - the key.

value - the value for which the reverse rank should be estimated.

Returns:

List<Long> a single-element list holding the estimated reverse rank of the value. The reverse rank is -1 if the value is larger than the maximum observation, equal to the number of observations if it is smaller than the minimum, and -2 if the sketch is empty.

tdigestRevRank

AsyncExecutions<List<Long>> tdigestRevRank(K key,
                                           double... values)

Returns, for each given value, the estimated reverse rank, that is the number of observations that are larger than the value plus half the number of observations that are equal to the value. Reverse ranks are zero-based.

Parameters:

key - the key.

values - the values for which the reverse ranks should be estimated.

Returns:

List<Long> one entry per input value holding its estimated reverse rank. An entry is -1 if the value is larger than the maximum observation and equal to the number of observations if it is smaller than the minimum. All entries are -2 if the sketch is empty.

tdigestTrimmedMean

AsyncExecutions<Double> tdigestTrimmedMean(K key,
                                           double lowCutQuantile,
                                           double highCutQuantile)

Returns an estimation of the mean value from the sketch, excluding observation values outside the low and high cutoff quantiles.

Parameters:

key - the key.

lowCutQuantile - the low cutoff quantile, in the range [0, 1]; observations below it are excluded. Must be smaller than highCutQuantile.

highCutQuantile - the high cutoff quantile, in the range [0, 1]; observations above it are excluded. Must be larger than lowCutQuantile.

Returns:

Double the estimated trimmed mean, or nan if the sketch is empty.