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`

public class Abs extends UnaryFunction implements RealUnaryFunction
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:
  - Serialized Form

- ## 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
  Constructor
  Description
  `Abs()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `abs(Object param)`
  Calculates the absolute value of its argument
  `Object`
  `eval(Object arg)`
  Evaluate the function
  `double`
  `evaluate(double val)`
  Evaluate the function

  ### Methods inherited from class com.singularsys.jep.functions.UnaryFunction

  `instanceOf, instanceOf, instanceOf, instanceOf, run`

  ### Methods 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`

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### Abs

    public Abs()

- ## Method Details

  - ### eval

    public Object eval(Object arg) throws EvaluationException
    Description copied from class: `UnaryFunction`
    Evaluate the function
    Specified by:
      `eval` in class `UnaryFunction`
    Parameters:
      `arg` - the single argument passed in
    Returns:
      the result of the function
    Throws:
      `EvaluationException` - on error

  - ### abs

    public Object abs(Object param) throws EvaluationException
    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: `RealUnaryFunction`
    Evaluate the function
    Specified by:
      `evaluate` in interface `RealUnaryFunction`
    Parameters:
      `val` - the argument
    Returns:
      the result of applying the function to the argument