Module org.elasticsearch.server
Package org.elasticsearch.search.aggregations.metrics

Class TDigestState

java.lang.Object
org.elasticsearch.search.aggregations.metrics.TDigestState
All Implemented Interfaces:
Closeable, AutoCloseable, org.apache.lucene.util.Accountable, Releasable
Direct Known Subclasses:
EmptyTDigestState
public class TDigestState extends Object implements Releasable, org.apache.lucene.util.Accountable
Decorates TDigest with custom serialization. The underlying implementation for TDigest is selected through factory method params, providing one optimized for performance (e.g. MergingDigest or HybridDigest) by default, or optionally one that produces highly accurate results regardless of input size but its construction over the sample population takes 2x-10x longer.

  • Constructor Details

  • Method Details

    • createWithoutCircuitBreaking

      @Deprecated public static TDigestState createWithoutCircuitBreaking(double compression)
      Deprecated.
      No-op circuit-breaked factory for TDigestState. Used in _search aggregations. Please use the create(CircuitBreaker, double) method instead on new usages.

    • create

      public static TDigestState create(CircuitBreaker breaker, double compression)
      Default factory for TDigestState. The underlying TDigest implementation is optimized for performance, potentially providing slightly inaccurate results compared to other, substantially slower implementations.
      Parameters:
      compression - the compression factor for the underlying TDigest object
      Returns:
      a TDigestState object that's optimized for performance

    • createWithoutCircuitBreaking

      @Deprecated public static TDigestState createWithoutCircuitBreaking(double compression, TDigestExecutionHint executionHint)
      Deprecated.
      No-op circuit-breaked factory for TDigestState. Used in _search aggregations. Please use the create(CircuitBreaker, double, TDigestExecutionHint) method instead on new usages.

    • create

      public static TDigestState create(CircuitBreaker breaker, double compression, TDigestExecutionHint executionHint)
      Factory for TDigestState. The underlying TDigest implementation is either optimized for performance (default), potentially providing slightly inaccurate results for large populations, or optimized for accuracy but taking 2x-10x more to build.
      Parameters:
      compression - the compression factor for the underlying TDigest object
      executionHint - controls which implementation is used; accepted values are 'high_accuracy' and '' (default)
      Returns:
      a TDigestState object

    • createUsingParamsFrom

      public static TDigestState createUsingParamsFrom(TDigestState state)
      Factory for TDigestState. Uses the same initialization params as the passed TDigestState object. No data loading happens, and the input TDigestState object doesn't get altered in any way.
      Parameters:
      state - the TDigestState object providing the initialization params
      Returns:
      a TDigestState object

    • ramBytesUsed

      public long ramBytesUsed()
      Specified by:
      ramBytesUsed in interface org.apache.lucene.util.Accountable

    • compression

      public final double compression()

    • write

      public static void write(TDigestState state, StreamOutput out) throws IOException
      Throws:
      IOException

    • read

      @Deprecated public static TDigestState read(StreamInput in) throws IOException
      Deprecated.
      No-op circuit-breaked factory for TDigestState. Used in _search aggregations. Please use the read(CircuitBreaker, StreamInput) method instead on new usages.
      Throws:
      IOException

    • read

      public static TDigestState read(CircuitBreaker breaker, StreamInput in) throws IOException
      Throws:
      IOException

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • add

      public void add(TDigestState other)

    • add

      public void add(double x, long w)

    • add

      public void add(double x)

    • compress

      public final void compress()

    • size

      public final long size()

    • cdf

      public final double cdf(double x)

    • quantile

      public final double quantile(double q)

    • centroids

      public final Collection<Centroid> centroids()

    • centroidCount

      public final int centroidCount()

    • getMin

      public final double getMin()

    • getMax

      public final double getMax()

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface Releasable