io.warp10.script.aggregator

Class Percentile

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.aggregator.Percentile

All Implemented Interfaces:

WarpScriptAggregatorFunction, WarpScriptBucketizerFunction, WarpScriptMapperFunction, WarpScriptReducerFunction

public class Percentile
extends NamedWarpScriptFunction
implements WarpScriptMapperFunction, WarpScriptBucketizerFunction, WarpScriptReducerFunction

Return the percentile, given its rank and type, for the given GTS datapoints. It implements the percentiles as defined in Hyndman, Rob & Fan, Yanan. (1996). Sample Quantiles in Statistical Packages. The American Statistician.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Percentile.Builder

Constructor Summary

Constructors

Constructor and Description
Percentile(java.lang.String name, double percentile, int type, boolean forbidNulls)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(java.lang.Object[] args)
java.lang.String	toString()

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

Percentile

public Percentile(java.lang.String name,
                  double percentile,
                  int type,
                  boolean forbidNulls)

Method Detail

apply

public java.lang.Object apply(java.lang.Object[] args)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptAggregatorFunction

Throws:

WarpScriptException

toString

public java.lang.String toString()

Overrides:

toString in class NamedWarpScriptFunction