Package org.apache.beam.sdk.extensions.sketching

Class TDigestQuantiles.TDigestQuantilesFn

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.beam.sdk.transforms.CombineFnBase.GlobalCombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>, org.apache.beam.sdk.transforms.display.HasDisplayData
    Enclosing class:
    TDigestQuantiles
    public static class TDigestQuantiles.TDigestQuantilesFn
extends org.apache.beam.sdk.transforms.Combine.CombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>
    Implements the Combine.CombineFn of TDigestQuantiles transforms.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.tdunning.math.stats.MergingDigest addInput​(com.tdunning.math.stats.MergingDigest accum, java.lang.Double value)  
      static TDigestQuantiles.TDigestQuantilesFn create​(double compression)
      Returns TDigestQuantiles.TDigestQuantilesFn combiner with the given compression factor.
      com.tdunning.math.stats.MergingDigest createAccumulator()  
      com.tdunning.math.stats.MergingDigest extractOutput​(com.tdunning.math.stats.MergingDigest accum)
      Output the whole structure so it can be queried, reused or stored easily.
      java.lang.reflect.TypeVariable<?> getAccumTVariable()  
      org.apache.beam.sdk.coders.Coder<com.tdunning.math.stats.MergingDigest> getAccumulatorCoder​(org.apache.beam.sdk.coders.CoderRegistry registry, org.apache.beam.sdk.coders.Coder inputCoder)  
      org.apache.beam.sdk.coders.Coder<com.tdunning.math.stats.MergingDigest> getDefaultOutputCoder​(org.apache.beam.sdk.coders.CoderRegistry registry, org.apache.beam.sdk.coders.Coder inputCoder)  
      java.lang.String getIncompatibleGlobalWindowErrorMessage()  
      java.lang.reflect.TypeVariable<?> getInputTVariable()  
      java.lang.reflect.TypeVariable<?> getOutputTVariable()  
      com.tdunning.math.stats.MergingDigest mergeAccumulators​(java.lang.Iterable<com.tdunning.math.stats.MergingDigest> accumulators)  
      void populateDisplayData​(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)  

      • Methods inherited from class org.apache.beam.sdk.transforms.Combine.CombineFn

        apply, compact, defaultValue, getInputType, getOutputType

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • create

        public static TDigestQuantiles.TDigestQuantilesFn create​(double compression)
        Returns TDigestQuantiles.TDigestQuantilesFn combiner with the given compression factor.

        Keep in mind that a compression factor cf of c guarantees a relative error less than 3/c at mid quantiles.
        The accuracy will always be significantly less than 1% at extreme quantiles.

        Parameters:
        compression - the bound value for centroid and digest sizes.

      • createAccumulator

        public com.tdunning.math.stats.MergingDigest createAccumulator()
        Specified by:
        createAccumulator in class org.apache.beam.sdk.transforms.Combine.CombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>

      • addInput

        public com.tdunning.math.stats.MergingDigest addInput​(com.tdunning.math.stats.MergingDigest accum,
                                                      java.lang.Double value)
        Specified by:
        addInput in class org.apache.beam.sdk.transforms.Combine.CombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>

      • extractOutput

        public com.tdunning.math.stats.MergingDigest extractOutput​(com.tdunning.math.stats.MergingDigest accum)
        Output the whole structure so it can be queried, reused or stored easily.
        Specified by:
        extractOutput in class org.apache.beam.sdk.transforms.Combine.CombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>

      • mergeAccumulators

        public com.tdunning.math.stats.MergingDigest mergeAccumulators​(java.lang.Iterable<com.tdunning.math.stats.MergingDigest> accumulators)
        Specified by:
        mergeAccumulators in class org.apache.beam.sdk.transforms.Combine.CombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>

      • getAccumulatorCoder

        public org.apache.beam.sdk.coders.Coder<com.tdunning.math.stats.MergingDigest> getAccumulatorCoder​(org.apache.beam.sdk.coders.CoderRegistry registry,
                                                                                                   org.apache.beam.sdk.coders.Coder inputCoder)
        Specified by:
        getAccumulatorCoder in interface org.apache.beam.sdk.transforms.CombineFnBase.GlobalCombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>

      • getDefaultOutputCoder

        public org.apache.beam.sdk.coders.Coder<com.tdunning.math.stats.MergingDigest> getDefaultOutputCoder​(org.apache.beam.sdk.coders.CoderRegistry registry,
                                                                                                     org.apache.beam.sdk.coders.Coder inputCoder)
        Specified by:
        getDefaultOutputCoder in interface org.apache.beam.sdk.transforms.CombineFnBase.GlobalCombineFn<java.lang.Double,​com.tdunning.math.stats.MergingDigest,​com.tdunning.math.stats.MergingDigest>

      • populateDisplayData

        public void populateDisplayData​(org.apache.beam.sdk.transforms.display.DisplayData.Builder builder)
        Specified by:
        populateDisplayData in interface org.apache.beam.sdk.transforms.display.HasDisplayData

      • getIncompatibleGlobalWindowErrorMessage

        public java.lang.String getIncompatibleGlobalWindowErrorMessage()
        Specified by:
        getIncompatibleGlobalWindowErrorMessage in interface org.apache.beam.sdk.transforms.CombineFnBase.GlobalCombineFn<InputT extends java.lang.Object,​AccumT extends java.lang.Object,​OutputT extends java.lang.Object>

      • getInputTVariable

        public java.lang.reflect.TypeVariable<?> getInputTVariable()

      • getAccumTVariable

        public java.lang.reflect.TypeVariable<?> getAccumTVariable()

      • getOutputTVariable

        public java.lang.reflect.TypeVariable<?> getOutputTVariable()