Class BigDecimalMath

java.lang.Object

io.github.syst3ms.skriptparser.util.math.BigDecimalMath

public class BigDecimalMath
extends Object

Provides advanced functions operating on BigDecimals. Taken from @obermuhlner's Github I do not claim ownership of this code, it is the intellectual property of @obermuhlner.

Field Summary

Fields

Modifier and Type	Field	Description
static final MathContext	DEFAULT_CONTEXT
static final RoundingMode	DEFAULT_ROUNDING_MODE

Method Summary

Modifier and Type	Method	Description
static BigDecimal	acos(BigDecimal x, MathContext mathContext)	Calculates the arc cosine (inverted cosine) of BigDecimal x.
static BigDecimal	asin(BigDecimal x, MathContext mathContext)	Calculates the arc sine (inverted sine) of BigDecimal x.
static BigDecimal	atan(BigDecimal x, MathContext mathContext)	Calculates the arc tangens (inverted tangens) of BigDecimal x.
static BigDecimal	cos(BigDecimal x, MathContext mathContext)	Calculates the cosine (cosinus) of BigDecimal x.
static BigDecimal	e(MathContext mathContext)	Returns the number e.
static BigDecimal	exp(BigDecimal x, MathContext mathContext)	Calculates the natural exponent of BigDecimal x (ex).
static int	exponent(BigDecimal value)	Returns the exponent of the specified BigDecimal written as mantissa * 10exponent.
static BigDecimal	factorial(int n)	Calculates the factorial of the specified integer argument.
static BigDecimal	factorial(BigDecimal x, MathContext mathContext)	Calculates the factorial of the specified BigDecimal.
static BigDecimal	fractionalPart(BigDecimal value)	Returns the fractional part of the specified BigDecimal (right of the decimal point).
static BigDecimal	getBigDecimal(Number n)
static BigInteger	getBigInteger(Number n)
static BigDecimal	integralPart(BigDecimal value)	Returns the integral part of the specified BigDecimal (left of the decimal point).
static boolean	isDoubleValue(BigDecimal value)	Returns whether the specified BigDecimal value can be represented as double.
static boolean	isIntValue(BigDecimal value)	Returns whether the specified BigDecimal value can be represented as int.
static BigDecimal	log(BigDecimal x, MathContext mathContext)	Calculates the natural logarithm of BigDecimal x.
static BigDecimal	log10(BigDecimal x, MathContext mathContext)	Calculates the logarithm of BigDecimal x to the base 10.
static BigDecimal	log2(BigDecimal x, MathContext mathContext)	Calculates the logarithm of BigDecimal x to the base 2.
static BigDecimal	mantissa(BigDecimal value)	Returns the mantissa of the specified BigDecimal written as mantissa * 10exponent.
static BigDecimal	pi(MathContext mathContext)	Returns the number pi.
static BigDecimal	pow(BigDecimal x, long y, MathContext mathContext)	Calculates BigDecimal x to the power of long y (xy).
static BigDecimal	pow(BigDecimal x, BigDecimal y, MathContext mathContext)	Calculates BigDecimal x to the power of BigDecimal y (xy).
static BigDecimal	reciprocal(BigDecimal x, MathContext mathContext)	Calculates the reciprocal of the specified BigDecimal.
static BigDecimal	round(BigDecimal value, MathContext mathContext)	Rounds the specified BigDecimal to the precision of the specified MathContext.
static BigDecimal	sin(BigDecimal x, MathContext mathContext)	Calculates the sine (sinus) of BigDecimal x.
static BigDecimal	sqrt(BigDecimal x, MathContext mathContext)	Calculates the square root of BigDecimal x.
static BigDecimal	tan(BigDecimal x, MathContext mathContext)	Calculates the tangens of BigDecimal x.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_ROUNDING_MODE

public static final RoundingMode DEFAULT_ROUNDING_MODE

DEFAULT_CONTEXT

public static final MathContext DEFAULT_CONTEXT

Method Details

isIntValue

public static boolean isIntValue(BigDecimal value)

Returns whether the specified BigDecimal value can be represented as int.

If this returns true you can call BigDecimal.intValueExact() without fear of an ArithmeticException.

Parameters:

value - the BigDecimal to check

Returns:

true if the value can be represented as int value

isDoubleValue

public static boolean isDoubleValue(BigDecimal value)

Returns whether the specified BigDecimal value can be represented as double.

If this returns true you can call BigDecimal.doubleValue() without fear of getting Double.POSITIVE_INFINITY or Double.NEGATIVE_INFINITY as result.

Example: BigDecimalMath.isDoubleValue(new BigDecimal("1E309")) returns false, because new BigDecimal("1E309").doubleValue() returns Infinity.

Note: This method does not check for possible loss of precision.

For example BigDecimalMath.isDoubleValue(new BigDecimal("1.23400000000000000000000000000000001")) will return true, because new BigDecimal("1.23400000000000000000000000000000001").doubleValue() returns a valid double value, although it loses precision and returns 1.234.

BigDecimalMath.isDoubleValue(new BigDecimal("1E-325")) will return true although this value is smaller than Double.MIN_VALUE (and therefore outside the range of values that can be represented as double) because new BigDecimal("1E-325").doubleValue() returns 0 which is a legal value with loss of precision.

Parameters:

value - the BigDecimal to check

Returns:

true if the value can be represented as double value

mantissa

public static BigDecimal mantissa(BigDecimal value)

Returns the mantissa of the specified BigDecimal written as mantissa * 10^exponent.

The mantissa is defined as having exactly 1 digit before the decimal point.

Parameters:

value - the BigDecimal

Returns:

the mantissa

See Also:

• exponent(BigDecimal)

exponent

public static int exponent(BigDecimal value)

Returns the exponent of the specified BigDecimal written as mantissa * 10^exponent.

The mantissa is defined as having exactly 1 digit before the decimal point.

Parameters:

value - the BigDecimal

Returns:

the exponent

See Also:

• mantissa(BigDecimal)

integralPart

public static BigDecimal integralPart(BigDecimal value)

Returns the integral part of the specified BigDecimal (left of the decimal point).

Parameters:

value - the BigDecimal

Returns:

the integral part

See Also:

• fractionalPart(BigDecimal)

fractionalPart

public static BigDecimal fractionalPart(BigDecimal value)

Returns the fractional part of the specified BigDecimal (right of the decimal point).

Parameters:

value - the BigDecimal

Returns:

the fractional part

See Also:

• integralPart(BigDecimal)

round

public static BigDecimal round(BigDecimal value,
 MathContext mathContext)

Rounds the specified BigDecimal to the precision of the specified MathContext.

This method calls BigDecimal.round(MathContext).

Parameters:

value - the BigDecimal to round

mathContext - the MathContext used for the result

Returns:

the rounded BigDecimal value

See Also:

• BigDecimal.round(MathContext)

reciprocal

public static BigDecimal reciprocal(BigDecimal x,
 MathContext mathContext)

Calculates the reciprocal of the specified BigDecimal.

Parameters:

x - the BigDecimal

mathContext - the MathContext used for the result

Returns:

the reciprocal BigDecimal

Throws:

ArithmeticException - if x = 0

ArithmeticException - if the result is inexact but the rounding mode is UNNECESSARY or mc.precision == 0 and the quotient has a non-terminating decimal expansion.

factorial

public static BigDecimal factorial(int n)

Calculates the factorial of the specified integer argument.

factorial = 1 * 2 * 3 * ... n

Parameters:

n - the BigDecimal

Returns:

the factorial BigDecimal

Throws:

ArithmeticException - if x < 0

factorial

public static BigDecimal factorial(BigDecimal x,
 MathContext mathContext)

Calculates the factorial of the specified BigDecimal.

This implementation uses Spouge's approximation to calculate the factorial for non-integer values.

This involves calculating a series of constants that depend on the desired precision. Since this constant calculation is quite expensive (especially for higher precisions), the constants for a specific precision will be cached and subsequent calls to this method with the same precision will be much faster.

It is therefore recommended to do one call to this method with the standard precision of your application during the startup phase and to avoid calling it with many different precisions.

See: Wikipedia: Factorial - Extension of factorial to non-integer values of argument

Parameters:

x - the BigDecimal

mathContext - the MathContext used for the result

Returns:

the factorial BigDecimal

Throws:

ArithmeticException - if x is a negative integer value (-1, -2, -3, ...)

UnsupportedOperationException - if x is a non-integer value and the MathContext has unlimited precision

See Also:

• factorial(int)

pow

public static BigDecimal pow(BigDecimal x,
 BigDecimal y,
 MathContext mathContext)

Calculates BigDecimal x to the power of BigDecimal y (x^y).

Parameters:

x - the BigDecimal value to take to the power

y - the BigDecimal value to serve as exponent

mathContext - the MathContext used for the result

Returns:

the calculated x to the power of y with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

See Also:

• pow(BigDecimal, long, MathContext)

pow

public static BigDecimal pow(BigDecimal x,
 long y,
 MathContext mathContext)

Calculates BigDecimal x to the power of long y (x^y).

The implementation tries to minimize the number of multiplications of x (using squares whenever possible).

See: Wikipedia: Exponentiation - efficient computation

Parameters:

x - the BigDecimal value to take to the power

y - the long value to serve as exponent

mathContext - the MathContext used for the result

Returns:

the calculated x to the power of y with the precision specified in the mathContext

Throws:

ArithmeticException - if y is negative and the result is inexact but the rounding mode is UNNECESSARY or mc.precision == 0 and the quotient has a non-terminating decimal expansion.

ArithmeticException - if the rounding mode is UNNECESSARY and the BigDecimal operation would require rounding.

sqrt

public static BigDecimal sqrt(BigDecimal x,
 MathContext mathContext)

Calculates the square root of BigDecimal x.

See Wikipedia: Square root

Parameters:

x - the BigDecimal value to calculate the square root

mathContext - the MathContext used for the result

Returns:

the calculated square root of x with the precision specified in the mathContext

Throws:

ArithmeticException - if x < 0

UnsupportedOperationException - if the MathContext has unlimited precision

log

public static BigDecimal log(BigDecimal x,
 MathContext mathContext)

Calculates the natural logarithm of BigDecimal x.

See: Wikipedia: Natural logarithm

Parameters:

x - the BigDecimal to calculate the natural logarithm for

mathContext - the MathContext used for the result

Returns:

the calculated natural logarithm BigDecimal with the precision specified in the mathContext

Throws:

ArithmeticException - if x <= 0

UnsupportedOperationException - if the MathContext has unlimited precision

log2

public static BigDecimal log2(BigDecimal x,
 MathContext mathContext)

Calculates the logarithm of BigDecimal x to the base 2.

Parameters:

x - the BigDecimal to calculate the logarithm base 2 for

mathContext - the MathContext used for the result

Returns:

the calculated natural logarithm BigDecimal to the base 2 with the precision specified in the mathContext

Throws:

ArithmeticException - if x <= 0

UnsupportedOperationException - if the MathContext has unlimited precision

log10

public static BigDecimal log10(BigDecimal x,
 MathContext mathContext)

Calculates the logarithm of BigDecimal x to the base 10.

Parameters:

x - the BigDecimal to calculate the logarithm base 10 for

mathContext - the MathContext used for the result

Returns:

the calculated natural logarithm BigDecimal to the base 10 with the precision specified in the mathContext

Throws:

ArithmeticException - if x <= 0

UnsupportedOperationException - if the MathContext has unlimited precision

e

public static BigDecimal e(MathContext mathContext)

Returns the number e.

See Wikipedia: E (mathematical_constant)

Parameters:

mathContext - the MathContext used for the result

Returns:

the number e with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

pi

public static BigDecimal pi(MathContext mathContext)

Returns the number pi.

See Wikipedia: Pi

Parameters:

mathContext - the MathContext used for the result

Returns:

the number pi with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

exp

public static BigDecimal exp(BigDecimal x,
 MathContext mathContext)

Calculates the natural exponent of BigDecimal x (e^x).

See: Wikipedia: Exponent

Parameters:

x - the BigDecimal to calculate the exponent for

mathContext - the MathContext used for the result

Returns:

the calculated exponent BigDecimal with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

sin

public static BigDecimal sin(BigDecimal x,
 MathContext mathContext)

Calculates the sine (sinus) of BigDecimal x.

See: Wikipedia: Sine

Parameters:

x - the BigDecimal to calculate the sine for

mathContext - the MathContext used for the result

Returns:

the calculated sine BigDecimal with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

asin

public static BigDecimal asin(BigDecimal x,
 MathContext mathContext)

Calculates the arc sine (inverted sine) of BigDecimal x.

See: Wikipedia: Arcsine

Parameters:

x - the BigDecimal to calculate the arc sine for

mathContext - the MathContext used for the result

Returns:

the calculated arc sine BigDecimal with the precision specified in the mathContext

Throws:

ArithmeticException - if x > 1 or x < -1

UnsupportedOperationException - if the MathContext has unlimited precision

cos

public static BigDecimal cos(BigDecimal x,
 MathContext mathContext)

Calculates the cosine (cosinus) of BigDecimal x.

See: Wikipedia: Cosine

Parameters:

x - the BigDecimal to calculate the cosine for

mathContext - the MathContext used for the result

Returns:

the calculated cosine BigDecimal with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

acos

public static BigDecimal acos(BigDecimal x,
 MathContext mathContext)

Calculates the arc cosine (inverted cosine) of BigDecimal x.

See: Wikipedia: Arccosine

Parameters:

x - the BigDecimal to calculate the arc cosine for

mathContext - the MathContext used for the result

Returns:

the calculated arc sine BigDecimal with the precision specified in the mathContext

Throws:

ArithmeticException - if x > 1 or x < -1

UnsupportedOperationException - if the MathContext has unlimited precision

tan

public static BigDecimal tan(BigDecimal x,
 MathContext mathContext)

Calculates the tangens of BigDecimal x.

See: Wikipedia: Tangens

Parameters:

x - the BigDecimal to calculate the tangens for

mathContext - the MathContext used for the result

Returns:

the calculated tangens BigDecimal with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

atan

public static BigDecimal atan(BigDecimal x,
 MathContext mathContext)

Calculates the arc tangens (inverted tangens) of BigDecimal x.

See: Wikipedia: Arctangens

Parameters:

x - the BigDecimal to calculate the arc tangens for

mathContext - the MathContext used for the result

Returns:

the calculated arc tangens BigDecimal with the precision specified in the mathContext

Throws:

UnsupportedOperationException - if the MathContext has unlimited precision

getBigDecimal

public static BigDecimal getBigDecimal(Number n)

getBigInteger

public static BigInteger getBigInteger(Number n)