Package com.singularsys.jep.bigdecimal.functions

Class BigDecMod

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.jep.functions.Modulus

com.singularsys.jep.bigdecimal.functions.BigDecMod

All Implemented Interfaces:

FixedPrecisionFunctionI, PostfixMathCommandI, RealBinaryFunction, Serializable

public class BigDecMod
extends Modulus
implements FixedPrecisionFunctionI

Modulus function for BigDecimals, Double and other Number types. Uses BigDecimal.remainder(BigDecimal, MathContext) which has different behaviour for negative values than standard modulus.

See Also:

• Serialized Form

Nested Class Summary

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

BinaryFunction.BiFunctionWithException<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
BigDecMod(MathContext mc)
BigDecMod(MathContext mc, int scale)

Method Summary

Modifier and Type	Method	Description
int	getDecimalPlaces()	Gets the number of decimal places used.
MathContext	getMathContext()
Object	mod(Object l, Object r)
void	setDecimalPlaces(int scale)	Sets the number of decimal places to use.
void	setMathContext(MathContext mc)

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

eval, evaluate

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

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

mc

protected MathContext mc

scale

protected int scale

Constructor Details

BigDecMod

public BigDecMod(MathContext mc)

Parameters:

mc -

BigDecMod

public BigDecMod(MathContext mc,
 int scale)

Method Details

mod

public Object mod(Object l,
 Object r)
           throws EvaluationException

Overrides:

mod in class Modulus

Throws:

EvaluationException

getMathContext

public MathContext getMathContext()

setMathContext

public void setMathContext(MathContext mc)

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