org.jpmml.evaluator.functions

Class StandardDeviationFunction

java.lang.Object

org.jpmml.evaluator.functions.AbstractFunction

org.jpmml.evaluator.functions.StandardDeviationFunction

All Implemented Interfaces:

Function

public class StandardDeviationFunction
extends AbstractFunction

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"/>
     <ParameterField name="biasCorrected" dataType="boolean"/> <!-- Optional; defaults to false -->
   </DefineFunction>
 

See Also:

StandardDeviation

Constructor Summary

Constructors

Constructor and Description
StandardDeviationFunction()
StandardDeviationFunction(String name)

Method Summary

Methods

Modifier and Type	Method and Description
FieldValue	evaluate(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

StandardDeviationFunction

public StandardDeviationFunction()

StandardDeviationFunction

public StandardDeviationFunction(String name)

Method Detail

evaluate

public FieldValue evaluate(List<FieldValue> arguments)