public static class TDigestQuantiles.TDigestQuantilesFn extends Combine.CombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
Combine.CombineFn
of TDigestQuantiles
transforms.Modifier and Type | Method and Description |
---|---|
com.tdunning.math.stats.MergingDigest |
addInput(com.tdunning.math.stats.MergingDigest accum,
java.lang.Double value)
Adds the given input value to the given accumulator, returning the new accumulator value.
|
static TDigestQuantiles.TDigestQuantilesFn |
create(double compression)
Returns
TDigestQuantiles.TDigestQuantilesFn combiner with the given compression factor. |
com.tdunning.math.stats.MergingDigest |
createAccumulator()
Returns a new, mutable accumulator value, representing the accumulation of zero input values.
|
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()
Returns the
TypeVariable of AccumT . |
Coder<com.tdunning.math.stats.MergingDigest> |
getAccumulatorCoder(CoderRegistry registry,
Coder inputCoder)
Returns the
Coder to use for accumulator AccumT values, or null if it is not
able to be inferred. |
Coder<com.tdunning.math.stats.MergingDigest> |
getDefaultOutputCoder(CoderRegistry registry,
Coder inputCoder)
Returns the
Coder to use by default for output OutputT values, or null if it
is not able to be inferred. |
java.lang.String |
getIncompatibleGlobalWindowErrorMessage()
Returns the error message for not supported default values in Combine.globally().
|
java.lang.reflect.TypeVariable<?> |
getInputTVariable()
Returns the
TypeVariable of InputT . |
java.lang.reflect.TypeVariable<?> |
getOutputTVariable()
Returns the
TypeVariable of OutputT . |
com.tdunning.math.stats.MergingDigest |
mergeAccumulators(java.lang.Iterable<com.tdunning.math.stats.MergingDigest> accumulators)
Returns an accumulator representing the accumulation of all the input values accumulated in
the merging accumulators.
|
void |
populateDisplayData(DisplayData.Builder builder)
Register display data for the given transform or component.
|
apply, compact, defaultValue, getInputType, getOutputType
public static TDigestQuantiles.TDigestQuantilesFn create(double compression)
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.
compression
- the bound value for centroid and digest sizes.public com.tdunning.math.stats.MergingDigest createAccumulator()
Combine.CombineFn
createAccumulator
in class Combine.CombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
public com.tdunning.math.stats.MergingDigest addInput(com.tdunning.math.stats.MergingDigest accum, java.lang.Double value)
Combine.CombineFn
addInput
in class Combine.CombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
accum
- may be modified and returned for efficiencyvalue
- should not be mutatedpublic com.tdunning.math.stats.MergingDigest extractOutput(com.tdunning.math.stats.MergingDigest accum)
extractOutput
in class Combine.CombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
accum
- can be modified for efficiencypublic com.tdunning.math.stats.MergingDigest mergeAccumulators(java.lang.Iterable<com.tdunning.math.stats.MergingDigest> accumulators)
Combine.CombineFn
mergeAccumulators
in class Combine.CombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
accumulators
- only the first accumulator may be modified and returned for efficiency;
the other accumulators should not be mutated, because they may be shared with other code
and mutating them could lead to incorrect results or data corruption.public Coder<com.tdunning.math.stats.MergingDigest> getAccumulatorCoder(CoderRegistry registry, Coder inputCoder)
CombineFnBase.GlobalCombineFn
Coder
to use for accumulator AccumT
values, or null if it is not
able to be inferred.
By default, uses the knowledge of the Coder
being used for InputT
values
and the enclosing Pipeline
's CoderRegistry
to try to infer the Coder for
AccumT
values.
This is the Coder used to send data through a communication-intensive shuffle step, so a compact and efficient representation may have significant performance benefits.
getAccumulatorCoder
in interface CombineFnBase.GlobalCombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
public Coder<com.tdunning.math.stats.MergingDigest> getDefaultOutputCoder(CoderRegistry registry, Coder inputCoder)
CombineFnBase.GlobalCombineFn
Coder
to use by default for output OutputT
values, or null if it
is not able to be inferred.
By default, uses the knowledge of the Coder
being used for input InputT
values and the enclosing Pipeline
's CoderRegistry
to try to infer the Coder
for OutputT
values.
getDefaultOutputCoder
in interface CombineFnBase.GlobalCombineFn<java.lang.Double,com.tdunning.math.stats.MergingDigest,com.tdunning.math.stats.MergingDigest>
public void populateDisplayData(DisplayData.Builder builder)
populateDisplayData(DisplayData.Builder)
is invoked by Pipeline runners to collect
display data via DisplayData.from(HasDisplayData)
. Implementations may call super.populateDisplayData(builder)
in order to register display data in the current namespace,
but should otherwise use subcomponent.populateDisplayData(builder)
to use the namespace
of the subcomponent.
By default, does not register any display data. Implementors may override this method to provide their own display data.
populateDisplayData
in interface HasDisplayData
builder
- The builder to populate with display data.HasDisplayData
public java.lang.String getIncompatibleGlobalWindowErrorMessage()
CombineFnBase.GlobalCombineFn
getIncompatibleGlobalWindowErrorMessage
in interface CombineFnBase.GlobalCombineFn<InputT,AccumT,OutputT>
public java.lang.reflect.TypeVariable<?> getInputTVariable()
TypeVariable
of InputT
.public java.lang.reflect.TypeVariable<?> getAccumTVariable()
TypeVariable
of AccumT
.public java.lang.reflect.TypeVariable<?> getOutputTVariable()
TypeVariable
of OutputT
.