Package com.singularsys.jep.bigdecimal.functions

Class BigDecAbs

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.UnaryFunction

com.singularsys.jep.functions.Abs

com.singularsys.jep.bigdecimal.functions.BigDecAbs

All Implemented Interfaces:

FixedPrecisionFunctionI, PostfixMathCommandI, RealUnaryFunction, Serializable

public class BigDecAbs
extends Abs
implements FixedPrecisionFunctionI

Absolute value function for BigDecimals, Double and other Number types. Uses BigDecimal.abs() for BigDecimals and Abs for other types.

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

Modifier and Type	Field	Description
protected MathContext	mc
protected int	scale

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

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
BigDecAbs(MathContext mc)
BigDecAbs(MathContext mc, int scale)

Method Summary

Modifier and Type	Method	Description
Object	abs(Object l)	Calculates the absolute value of its argument
int	getDecimalPlaces()	Gets the number of decimal places used.
MathContext	getMathContext()
void	setDecimalPlaces(int scale)	Sets the number of decimal places to use.
void	setMathContext(MathContext mc)

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

eval, 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

mc

protected MathContext mc

Constructor Details

BigDecAbs

public BigDecAbs(MathContext mc)

BigDecAbs

public BigDecAbs(MathContext mc,
 int scale)

Method Details

abs

public Object abs(Object l)
           throws EvaluationException

Description copied from class: Abs

Calculates the absolute value of its argument

Overrides:

abs in class Abs

Parameters:

l - 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

setMathContext

public void setMathContext(MathContext mc)

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

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

getMathContext

public MathContext getMathContext()