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
,Serializable
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:
-
Field Summary
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, name, NaN, numberOfParameters
-
Constructor Summary
ConstructorDescriptionStandard constructor, Complex results for negative Number arguments.SquareRoot
(boolean strict) Controls behaviour for negative real arguments. -
Method Summary
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 Details
-
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 Details
-
eval
Description copied from class:UnaryFunction
Evaluate the function- Specified by:
eval
in classUnaryFunction
- Parameters:
arg
- the single argument passed in- Returns:
- the result of the function
- Throws:
EvaluationException
-
sqrt
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
-