Package io.deephaven.api.agg.spec

Class AggSpecTDigest

java.lang.Object

io.deephaven.api.agg.spec.AggSpecBase

io.deephaven.api.agg.spec.AggSpecTDigest

All Implemented Interfaces:

AggSpec

@Immutable
public abstract class AggSpecTDigest
extends AggSpecBase

Specifies an aggregation that outputs a T-Digest (com.tdunning.math.stats.TDigest) with the specified compression().

May be used to implement parallel percentile calculations by splitting inputs and accumulating results into a single downstream TDigest.

May only be used on static or add-only tables.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.api.agg.spec.AggSpec

AggSpec.Visitor

Constructor Summary

Constructors

Constructor	Description
AggSpecTDigest()

Method Summary

Modifier and Type	Method	Description
abstract OptionalDouble	compression()	T-Digest compression factor.
final String	description()	Get a simple description for this AggSpec.
static AggSpecTDigest	of()	Create a new AggSpecTDigest with compression chosen by the server.
static AggSpecTDigest	of(double compression)	Create a new AggSpecTDigest.
final <V extends AggSpec.Visitor> V	walk(V visitor)	Glue method to deliver this AggSpec to a AggSpec.Visitor.

Methods inherited from class io.deephaven.api.agg.spec.AggSpecBase

aggregation, aggregation, aggregation

Methods inherited from class java.lang.Object

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

Constructor Details

AggSpecTDigest

public AggSpecTDigest()

Method Details

of

public static AggSpecTDigest of()

Create a new AggSpecTDigest with compression chosen by the server.

Returns:

the agg spec

of

public static AggSpecTDigest of(double compression)

Create a new AggSpecTDigest.

Parameters:

compression - the compression

Returns:

the agg spec

description

public final String description()

Description copied from interface: AggSpec

Get a simple description for this AggSpec.

Returns:

The description

compression

@Parameter
public abstract OptionalDouble compression()

T-Digest compression factor. Must be greater than or equal to 1. 1000 is extremely large.

When not specified, the server will choose a compression value.

Returns:

The T-Digest compression factor if specified

walk

public final <V extends AggSpec.Visitor> V walk(V visitor)

Description copied from interface: AggSpec

Glue method to deliver this AggSpec to a AggSpec.Visitor.

Parameters:

visitor - The visitor

Returns:

The visitor