Package com.singularsys.jep.bigdecimal.functions

Class BigDecSignum

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.jep.functions.Signum

com.singularsys.jep.bigdecimal.functions.BigDecSignum

All Implemented Interfaces:

FixedPrecisionFunctionI, PostfixMathCommandI, RealUnaryFunction, Serializable

public class BigDecSignum
extends Signum
implements FixedPrecisionFunctionI

The signum function for BigDecimals.

Since:

Jep 3.5

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.functions.UnaryFunction

UnaryFunction.FunctionWithException<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected int	scale

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
BigDecSignum()
BigDecSignum(int scale)

Method Summary

Modifier and Type	Method	Description
Object	eval(Object l)	Evaluate the function
int	getDecimalPlaces()	Gets the number of decimal places used.
void	setDecimalPlaces(int scale)	Sets the number of decimal places to use.

Methods inherited from class com.singularsys.jep.functions.Signum

evaluate

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

Field Details

scale

protected int scale

Constructor Details

BigDecSignum

public BigDecSignum()

BigDecSignum

public BigDecSignum(int scale)

Method Details

eval

public Object eval(Object l)
            throws EvaluationException

Description copied from class: UnaryFunction

Evaluate the function

Overrides:

eval in class Signum

Parameters:

l - the single argument passed in

Returns:

the result of the function

Throws:

EvaluationException - on error

setDecimalPlaces

public void setDecimalPlaces(int scale)

Description copied from interface: FixedPrecisionFunctionI

Sets the number of decimal places to use.

Specified by:

setDecimalPlaces in interface FixedPrecisionFunctionI

Parameters:

scale - either zero, a positive number or -1 for floating-point formats

getDecimalPlaces

public int getDecimalPlaces()

Description copied from interface: FixedPrecisionFunctionI

Gets the number of decimal places used.

Specified by:

getDecimalPlaces in interface FixedPrecisionFunctionI

Returns:

either zero, a positive number or -1 for floating-point formats