org.jpmml.evaluator.functions

Class StandardDeviationFunction

java.lang.Object

org.jpmml.evaluator.functions.AbstractFunction

org.jpmml.evaluator.functions.MultiaryFunction

org.jpmml.evaluator.functions.StandardDeviationFunction

All Implemented Interfaces:

Function

public class StandardDeviationFunction
extends MultiaryFunction

A Java UDF for calculating the standard deviation of a collection of values.

Pseudo-declaration of function:

 <DefineFunction name="..." dataType="double">
   <ParameterField name="values" dataType="collection of numbers"/>
   <!-- Optional; defaults to false -->
   <ParameterField name="biasCorrected" dataType="boolean"/>
 </DefineFunction>
 

See Also:

StandardDeviation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.Double	evaluate(java.util.Collection<?> values, boolean biasCorrected)
FieldValue	evaluate(java.util.List<FieldValue> arguments) Evaluates this function with the specified arguments.

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

StandardDeviationFunction

public StandardDeviationFunction()

StandardDeviationFunction

public StandardDeviationFunction(java.lang.String name)

Method Detail

evaluate

public java.lang.Double evaluate(java.util.Collection<?> values,
                                 boolean biasCorrected)

evaluate

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

Description copied from interface: Function

Evaluates this function with the specified arguments.