org.jpmml.evaluator

Interface Function

All Known Implementing Classes:

AbstractFunction, AggregateFunction, AggregateMathFunction, AggregateStringFunction, ArithmeticFunction, BinaryFunction, ComparisonFunction, DoubleUnaryMathFunction, EqualityFunction, LogicalFunction, MeanFunction, MultiaryFunction, PercentileFunction, RoundingFunction, SplitFunction, StandardDeviationFunction, TernaryFunction, TrigonometricFunction, UnaryBooleanFunction, UnaryFunction, UnaryMathFunction, UnaryStringFunction, ValueFunction, ValueSpaceFunction

public interface Function

A common superinterface for PMML built-in functions and Java user-defined functions.

See Also:

FunctionRegistry

Method Summary

Modifier and Type	Method and Description
FieldValue	evaluate(List<FieldValue> arguments) Evaluates this function with the specified arguments.
String	getName() Gets the default name of this function.

Method Detail

getName

String getName()

Gets the default name of this function.

The default name should be unique in application scope. Currently, the JPMML library does not check or enforce this constraint in any way.

evaluate

FieldValue evaluate(List<FieldValue> arguments)

Evaluates this function with the specified arguments.

Throws:

FunctionException - If the arguments do not match the formal parameters of this function.