Package com.singularsys.jep.functions

Class Signum

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.jep.functions.Signum

All Implemented Interfaces:

PostfixMathCommandI, RealUnaryFunction, Serializable

Direct Known Subclasses:

BigDecSignum

public class Signum
extends UnaryFunction
implements RealUnaryFunction

The signum function returns -1 if x<0, 1 if x>0, 0 if x==0.

Since:

3.3

See Also:

• Math.signum(double)
• 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
Signum()

Method Summary

Modifier and Type	Method	Description
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

Signum

public Signum()

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

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