Module org.elasticsearch.tdigest
Package org.elasticsearch.tdigest

Interface TDigestReadView

All Known Implementing Classes:
AbstractTDigest, AVLTreeDigest, HybridDigest, MergingDigest, SortingDigest, TDigest
public interface TDigestReadView
Read-only view of a T-Digest. Note that this does not imply that the T-Digest is actually immutable.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    centroidCount()
    Returns the current number of centroids.
    Collection<Centroid>
    centroids()
    A Collection that lets you go through the centroids in ascending order by mean.
    double
    getMax()
    Returns the maximum value seen.
    double
    getMin()
    Returns the minimum value seen.
    long
    size()
    Returns the number of points that have been added to this TDigest.

  • Method Details

    • size

      long size()
      Returns the number of points that have been added to this TDigest.
      Returns:
      The sum of the weights on all centroids.

    • centroids

      Collection<Centroid> centroids()
      A Collection that lets you go through the centroids in ascending order by mean. Centroids returned will not be re-used, but may or may not share storage with this TDigest.
      Returns:
      The centroids in the form of a Collection.

    • centroidCount

      int centroidCount()
      Returns the current number of centroids.

    • getMin

      double getMin()
      Returns the minimum value seen. Returns NaN if this digest is empty.

    • getMax

      double getMax()
      Returns the maximum value seen. Returns NaN if this digest is empty.