Package com.singularsys.jep.functions
Class SquareRoot
- java.lang.Object
-
- com.singularsys.jep.functions.PostfixMathCommand
-
- com.singularsys.jep.functions.UnaryFunction
-
- com.singularsys.jep.functions.SquareRoot
-
- All Implemented Interfaces:
PostfixMathCommandI
,RealUnaryFunction
,java.io.Serializable
public class SquareRoot extends UnaryFunction implements RealUnaryFunction
Square root function. Positive Number arguments returns double results. Negative Number arguments return Complex results by default or Double.NaN if the strict flag is set in constructor. Complex arguments return Complex results.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, name, NaN, numberOfParameters
-
-
Constructor Summary
Constructors Constructor Description SquareRoot()
Standard constructor, Complex results for negative Number arguments.SquareRoot(boolean strict)
Controls behaviour for negative real arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
eval(java.lang.Object arg)
double
evaluate(double val)
java.lang.Object
sqrt(java.lang.Object x)
Calculates the square root of the parameter.-
Methods inherited from class com.singularsys.jep.functions.UnaryFunction
instanceOf, instanceOf, run
-
Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand
asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, checkNumberOfParameters, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString, toString
-
-
-
-
Constructor Detail
-
SquareRoot
public SquareRoot()
Standard constructor, Complex results for negative Number arguments.
-
SquareRoot
public SquareRoot(boolean strict)
Controls behaviour for negative real arguments.- Parameters:
strict
- true then returns NaN for negative real arguments, false to return complex results for negative real arguments.
-
-
Method Detail
-
eval
public java.lang.Object eval(java.lang.Object arg) throws EvaluationException
- Specified by:
eval
in classUnaryFunction
- Throws:
EvaluationException
-
sqrt
public java.lang.Object sqrt(java.lang.Object x) throws EvaluationException
Calculates the square root of the parameter. The parameter must either be of type Double or Complex.- Parameters:
x
- value- Returns:
- The square root of the parameter.
- Throws:
EvaluationException
- if the calculation cannot be performed
-
evaluate
public double evaluate(double val)
- Specified by:
evaluate
in interfaceRealUnaryFunction
-
-