Constructor Detail

• DoublePercentileAggregatorFunction

  public DoublePercentileAggregatorFunction(double percentile)

  Similar to DoublePercentilAggregatorFunction(percentile,true).

  Parameters:

  percentile - Percentile this function will return the value for

• DoublePercentileAggregatorFunction

  public DoublePercentileAggregatorFunction(double percentile,
                                    boolean useCopy)

  Initializes the function with the given percentile and decides whether the function will modify the original list or not.

  Parameters:

  percentile - Percentile this function will return the value for

  useCopy - If set to true, the original list will not be modified and will contain the data in sorted order, if false, this instance will operate on a copy of the list

Method Detail

• evaluate

  public Double evaluate(List<Double> data)

  Traverses the list and computes the percentile. In doing so, it sorts the list first -- and might or might not use the original list or a copy depending on isUseCopy().

  Specified by:

  evaluate in interface Function<List<Double>,Double>

  Parameters:

  data - List to compute the percentile for

  Returns:

  percentile of the given list or null if list is null or empty (zero size).

• getPercentile

  public double getPercentile()

  Getter for percentile.

  Returns:

  Retrieves the percentile this instance will return

• isUseCopy

  public boolean isUseCopy()

  Does this instance modify the passed in list or not?

  Returns:

  If true, this instance will sort the list passed in and then use it to compute the percentile; if false, it will operate on a copy of the list

  See Also:

  DoublePercentileAggregatorFunction(double, boolean)

• toString

  public String toString()

  Overrides:

  toString in class Object