Package com.singularsys.jep.functions
Class Abs
java.lang.Object
com.singularsys.jep.functions.PostfixMathCommand
com.singularsys.jep.functions.UnaryFunction
com.singularsys.jep.functions.Abs
- All Implemented Interfaces:
PostfixMathCommandI,RealUnaryFunction,Serializable
- Direct Known Subclasses:
BigDecAbs
Absolute value function. For Numbers, it returns the absolute value of same type, so a Double will
return a Double, Integer will return an Integer.
For
Complex it returns the modulus.- Version:
- Jep 4.1 Now Accepts a Number argument, using its doubleValue()
- Author:
- Richard Morris
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.singularsys.jep.functions.UnaryFunction
UnaryFunction.FunctionWithException<T> -
Field Summary
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, description, name, NaN, numberOfParameters -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class com.singularsys.jep.functions.UnaryFunction
instanceOf, instanceOf, instanceOf, instanceOf, runMethods inherited from class com.singularsys.jep.functions.PostfixMathCommand
asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, checkNumberOfParameters, getDescription, getDescription, getDescriptionWithType, getName, getNumberOfParameters, setCurNumberOfParameters, setDescription, setName, toString, toString
-
Constructor Details
-
Abs
public Abs()
-
-
Method Details
-
eval
Description copied from class:UnaryFunctionEvaluate the function- Specified by:
evalin classUnaryFunction- Parameters:
arg- the single argument passed in- Returns:
- the result of the function
- Throws:
EvaluationException- on error
-
abs
Calculates the absolute value of its argument- Parameters:
param- supports Double, Float, Integer, Long, Short, Complex and Number arguments- Returns:
- the absolute value. Gives the same type as its argument except for Number arguments that are converted to Double before conversions and return a Double argument.
- Throws:
EvaluationException- if type not supported
-
evaluate
public double evaluate(double val) Description copied from interface:RealUnaryFunctionEvaluate the function- Specified by:
evaluatein interfaceRealUnaryFunction- Parameters:
val- the argument- Returns:
- the result of applying the function to the argument
-