io.warp10.script.functions

Class NumericalUnaryFunction

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.ListRecursiveStackFunction

io.warp10.script.functions.NumericalUnaryFunction

All Implemented Interfaces:

WarpScriptStackFunction

public class NumericalUnaryFunction
extends ListRecursiveStackFunction

Apply a double or long unary operator to one value, a list of values, a nested lists of values, a numerical GTS or nested lists of numerical GTSs. If only the long operator is defined, all numbers are converted to long. If only the double operator is defined, all numbers are converted to double. If both long and double operator are defined, all numbers are converted to long until a Double or BigDecimal is found, then they are all converted to double.

Nested Class Summary

Nested classes/interfaces inherited from class io.warp10.script.ListRecursiveStackFunction

ListRecursiveStackFunction.ElementStackFunction

Field Summary

Fields inherited from class io.warp10.script.ListRecursiveStackFunction

UNHANDLED

Constructor Summary

Constructors

Constructor and Description
NumericalUnaryFunction(java.lang.String name, java.util.function.LongUnaryOperator opL, java.util.function.DoubleUnaryOperator opD)

Method Summary

Modifier and Type	Method and Description
ListRecursiveStackFunction.ElementStackFunction	generateFunction(WarpScriptStack stack) Generates the function to be applied on the element(s) using the parameters on the stack.
java.lang.String	getUnhandledErrorMessage() Return the error message when the given element cannot be handled by this function.

Methods inherited from class io.warp10.script.ListRecursiveStackFunction

apply

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericalUnaryFunction

public NumericalUnaryFunction(java.lang.String name,
                              java.util.function.LongUnaryOperator opL,
                              java.util.function.DoubleUnaryOperator opD)

Method Detail

generateFunction

public ListRecursiveStackFunction.ElementStackFunction generateFunction(WarpScriptStack stack)
                                                                 throws WarpScriptException

Description copied from class: ListRecursiveStackFunction

Generates the function to be applied on the element(s) using the parameters on the stack.

Specified by:

generateFunction in class ListRecursiveStackFunction

Parameters:

stack - The stack to be used for parameters retrieval.

Returns:

An ElementStackFunction which will be applied on each given elements or on the given element.

Throws:

WarpScriptException

getUnhandledErrorMessage

public java.lang.String getUnhandledErrorMessage()

Description copied from class: ListRecursiveStackFunction

Return the error message when the given element cannot be handled by this function.

Specified by:

getUnhandledErrorMessage in class ListRecursiveStackFunction

Returns:

An error message.