org.jpmml.evaluator.functions

Class PercentileFunction

java.lang.Object

org.jpmml.evaluator.functions.AbstractFunction

org.jpmml.evaluator.functions.BinaryFunction

org.jpmml.evaluator.functions.PercentileFunction

All Implemented Interfaces:

Function

public class PercentileFunction
extends BinaryFunction

A Java UDF for calculating the n-th percentile of a collection of values.

Pseudo-declaration of function:

 <DefineFunction name="..." dataType="double">
   <ParameterField name="values" dataType="collection of numbers"/>
   <-- 0 < percentile <= 100 -->
   <ParameterField name="percentile" dataType="integer"/>
 </DefineFunction>
 

See Also:

Percentile

Constructor Summary

Constructors

Constructor and Description
PercentileFunction()
PercentileFunction(String name)

Method Summary

Modifier and Type	Method and Description
Double	evaluate(Collection<?> values, int percentile)
FieldValue	evaluate(FieldValue first, FieldValue second)

Methods inherited from class org.jpmml.evaluator.functions.BinaryFunction

evaluate

Methods inherited from class org.jpmml.evaluator.functions.AbstractFunction

checkFixedArityArguments, checkVariableArityArguments, checkVariableArityArguments, getAliases, getArgument, getName, getOptionalArgument, getRequiredArgument

Methods inherited from class java.lang.Object

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

Constructor Detail

PercentileFunction

public PercentileFunction()

PercentileFunction

public PercentileFunction(String name)

Method Detail

evaluate

public Double evaluate(Collection<?> values,
                       int percentile)

evaluate

public FieldValue evaluate(FieldValue first,
                           FieldValue second)

Specified by:

evaluate in class BinaryFunction