org.jpmml.evaluator.functions

Class PercentileFunction

java.lang.Object

org.jpmml.evaluator.functions.AbstractFunction

org.jpmml.evaluator.functions.PercentileFunction

All Implemented Interfaces:

Function

public class PercentileFunction
extends AbstractFunction

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"/>
     <ParameterField name="percentile" dataType="integer"/> <-- 0 < percentile <= 100 -->
   </DefineFunction>
 

See Also:

Percentile

Constructor Summary

Constructors

Constructor and Description
PercentileFunction()
PercentileFunction(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
FieldValue	evaluate(java.util.List<FieldValue> arguments)

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

checkArguments, checkArguments, checkVariableArguments, checkVariableArguments, getName, integerToDouble

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(java.lang.String name)

Method Detail

evaluate

public FieldValue evaluate(java.util.List<FieldValue> arguments)