BigDecimalMath (ch.obermuhlner.math.big 2.0.0 API)

java.lang.Object
- ch.obermuhlner.math.big.BigDecimalMath

public class BigDecimalMath
extends java.lang.Object

Provides advanced functions operating on BigDecimals.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.math.BigDecimal`	`acos(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc cosine (inverted cosine) of `BigDecimal` x.
`static java.math.BigDecimal`	`acosh(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc hyperbolic cosine (inverse hyperbolic cosine) of `BigDecimal` x.
`static java.math.BigDecimal`	`acot(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the inverse cotangens (arc cotangens) of `BigDecimal` x.
`static java.math.BigDecimal`	`acoth(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc hyperbolic cotangens (inverse hyperbolic cotangens) of `BigDecimal` x.
`static java.math.BigDecimal`	`asin(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc sine (inverted sine) of `BigDecimal` x.
`static java.math.BigDecimal`	`asinh(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc hyperbolic sine (inverse hyperbolic sine) of `BigDecimal` x.
`static java.math.BigDecimal`	`atan(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc tangens (inverted tangens) of `BigDecimal` x.
`static java.math.BigDecimal`	`atan2(java.math.BigDecimal y, java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc tangens (inverted tangens) of `BigDecimal` y / x in the range -pi to pi.
`static java.math.BigDecimal`	`atanh(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the arc hyperbolic tangens (inverse hyperbolic tangens ) of `BigDecimal` x.
`static java.math.BigDecimal`	`bernoulli(int n, java.math.MathContext mathContext)` Calculates the Bernoulli number for the specified index.
`static java.math.BigDecimal`	`cos(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the cosine (cosinus) of `BigDecimal` x.
`static java.math.BigDecimal`	`cosh(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the hyperbolic cosine of `BigDecimal` x.
`static java.math.BigDecimal`	`cot(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the cotangens of `BigDecimal` x.
`static java.math.BigDecimal`	`coth(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the hyperbolic cotangens of `BigDecimal` x.
`static java.math.BigDecimal`	`e(java.math.MathContext mathContext)` Returns the number e.
`static java.math.BigDecimal`	`exp(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the natural exponent of `BigDecimal` x (e^x).
`static int`	`exponent(java.math.BigDecimal value)` Returns the exponent of the specified `BigDecimal` written as mantissa 10^exponent*.
`static java.math.BigDecimal`	`factorial(int n)` Calculates the factorial of the specified `BigDecimal`.
`static java.math.BigDecimal`	`fractionalPart(java.math.BigDecimal value)` Returns the fractional part of the specified `BigDecimal` (right of the decimal point).
`static java.math.BigDecimal`	`integralPart(java.math.BigDecimal value)` Returns the integral part of the specified `BigDecimal` (left of the decimal point).
`static boolean`	`isDoubleValue(java.math.BigDecimal value)` Returns whether the specified `BigDecimal` value can be represented as `double`.
`static boolean`	`isIntValue(java.math.BigDecimal value)` Returns whether the specified `BigDecimal` value can be represented as `int`.
`static boolean`	`isLongValue(java.math.BigDecimal value)` Returns whether the specified `BigDecimal` value can be represented as `long`.
`static java.math.BigDecimal`	`log(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the natural logarithm of `BigDecimal` x.
`static java.math.BigDecimal`	`log10(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the logarithm of `BigDecimal` x to the base 10.
`static java.math.BigDecimal`	`log2(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the logarithm of `BigDecimal` x to the base 2.
`static java.math.BigDecimal`	`mantissa(java.math.BigDecimal value)` Returns the mantissa of the specified `BigDecimal` written as mantissa 10^exponent*.
`static java.math.BigDecimal`	`pi(java.math.MathContext mathContext)` Returns the number pi.
`static java.math.BigDecimal`	`pow(java.math.BigDecimal x, java.math.BigDecimal y, java.math.MathContext mathContext)` Calculates `BigDecimal` x to the power of `BigDecimal` y (x^y).
`static java.math.BigDecimal`	`pow(java.math.BigDecimal x, long y, java.math.MathContext mathContext)` Calculates `BigDecimal` x to the power of `long` y (x^y).
`static java.math.BigDecimal`	`root(java.math.BigDecimal x, java.math.BigDecimal n, java.math.MathContext mathContext)` Calculates the n'th root of `BigDecimal` x.
`static java.math.BigDecimal`	`sin(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the sine (sinus) of `BigDecimal` x.
`static java.math.BigDecimal`	`sinh(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the hyperbolic sine of `BigDecimal` x.
`static java.math.BigDecimal`	`sqrt(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the square root of `BigDecimal` x.
`static java.math.BigDecimal`	`tan(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the tangens of `BigDecimal` x.
`static java.math.BigDecimal`	`tanh(java.math.BigDecimal x, java.math.MathContext mathContext)` Calculates the hyperbolic tangens of `BigDecimal` x.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isIntValue
```
public static boolean isIntValue(java.math.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
  - isLongValue
```
public static boolean isLongValue(java.math.BigDecimal value)
```
    Returns whether the specified BigDecimal value can be represented as long.
    If this returns true you can call BigDecimal.longValueExact() without fear of an ArithmeticException.
    
    Parameters:
    
    value - the BigDecimal to check
    
    Returns:
    
    true if the value can be represented as long value
  - isDoubleValue
```
public static boolean isDoubleValue(java.math.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 java.math.BigDecimal mantissa(java.math.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(java.math.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 java.math.BigDecimal integralPart(java.math.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 java.math.BigDecimal fractionalPart(java.math.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)
  - factorial
```
public static java.math.BigDecimal factorial(int n)
```
    Calculates the factorial of the specified BigDecimal.
    factorial = 1 * 2 * 3 * ... n
    
    Parameters:
    
    n - the BigDecimal
    
    Returns:
    
    the factorial BigDecimal
    
    Throws:
    
    java.lang.ArithmeticException - if x < 0
  - bernoulli
```
public static java.math.BigDecimal bernoulli(int n,
                                             java.math.MathContext mathContext)
```
    Calculates the Bernoulli number for the specified index.
    This function calculates the first Bernoulli numbers and therefore bernoulli(1) returns -0.5
    
    Note that bernoulli(x) for all odd x > 1 returns 0
    
    See: Wikipedia: Bernoulli number
    
    Parameters:
    
    n - the index of the Bernoulli number to be calculated (starting at 0)
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the Bernoulli number for the specified index
    
    Throws:
    
    java.lang.ArithmeticException - if x < 0
  - pow
```
public static java.math.BigDecimal pow(java.math.BigDecimal x,
                                       java.math.BigDecimal y,
                                       java.math.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
  - pow
```
public static java.math.BigDecimal pow(java.math.BigDecimal x,
                                       long y,
                                       java.math.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
  - sqrt
```
public static java.math.BigDecimal sqrt(java.math.BigDecimal x,
                                        java.math.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:
    
    java.lang.ArithmeticException - if x < 0
  - root
```
public static java.math.BigDecimal root(java.math.BigDecimal x,
                                        java.math.BigDecimal n,
                                        java.math.MathContext mathContext)
```
    Calculates the n'th root of BigDecimal x.
    See Wikipedia: Square root
    
    Parameters:
    
    x - the BigDecimal value to calculate the n'th root
    
    n - the BigDecimal defining the root
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated n'th root of x with the precision specified in the mathContext
    
    Throws:
    
    java.lang.ArithmeticException - if x < 0
  - log
```
public static java.math.BigDecimal log(java.math.BigDecimal x,
                                       java.math.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:
    
    java.lang.ArithmeticException - if x <= 0
  - log2
```
public static java.math.BigDecimal log2(java.math.BigDecimal x,
                                        java.math.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:
    
    java.lang.ArithmeticException - if x <= 0
  - log10
```
public static java.math.BigDecimal log10(java.math.BigDecimal x,
                                         java.math.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:
    
    java.lang.ArithmeticException - if x <= 0
  - pi
```
public static java.math.BigDecimal pi(java.math.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
  - e
```
public static java.math.BigDecimal e(java.math.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
  - exp
```
public static java.math.BigDecimal exp(java.math.BigDecimal x,
                                       java.math.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
  - sin
```
public static java.math.BigDecimal sin(java.math.BigDecimal x,
                                       java.math.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
  - asin
```
public static java.math.BigDecimal asin(java.math.BigDecimal x,
                                        java.math.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:
    
    java.lang.ArithmeticException - if x > 1 or x < -1
  - cos
```
public static java.math.BigDecimal cos(java.math.BigDecimal x,
                                       java.math.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
  - acos
```
public static java.math.BigDecimal acos(java.math.BigDecimal x,
                                        java.math.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:
    
    java.lang.ArithmeticException - if x > 1 or x < -1
  - tan
```
public static java.math.BigDecimal tan(java.math.BigDecimal x,
                                       java.math.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
  - atan
```
public static java.math.BigDecimal atan(java.math.BigDecimal x,
                                        java.math.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
  - atan2
```
public static java.math.BigDecimal atan2(java.math.BigDecimal y,
                                         java.math.BigDecimal x,
                                         java.math.MathContext mathContext)
```
    Calculates the arc tangens (inverted tangens) of BigDecimal y / x in the range -pi to pi.
    This is useful to calculate the angle theta from the conversion of rectangular coordinates (x, y) to polar coordinates (r, theta).
    
    See: Wikipedia: Atan2
    
    Parameters:
    
    y - the BigDecimal
    
    x - the BigDecimal
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated arc tangens BigDecimal with the precision specified in the mathContext
    
    Throws:
    
    java.lang.ArithmeticException - if x = 0 and y = 0
  - cot
```
public static java.math.BigDecimal cot(java.math.BigDecimal x,
                                       java.math.MathContext mathContext)
```
    Calculates the cotangens of BigDecimal x.
    See: Wikipedia: Cotangens
    
    Parameters:
    
    x - the BigDecimal to calculate the cotangens for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated cotanges BigDecimal with the precision specified in the mathContext
    
    Throws:
    
    java.lang.ArithmeticException - if x = 0
  - acot
```
public static java.math.BigDecimal acot(java.math.BigDecimal x,
                                        java.math.MathContext mathContext)
```
    Calculates the inverse cotangens (arc cotangens) of BigDecimal x.
    See: Wikipedia: Arccotangens
    
    Parameters:
    
    x - the BigDecimal to calculate the arc cotangens for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated arc cotangens BigDecimal with the precision specified in the mathContext
  - sinh
```
public static java.math.BigDecimal sinh(java.math.BigDecimal x,
                                        java.math.MathContext mathContext)
```
    Calculates the hyperbolic sine of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the hyperbolic sine for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated hyperbolic sine BigDecimal with the precision specified in the mathContext
  - cosh
```
public static java.math.BigDecimal cosh(java.math.BigDecimal x,
                                        java.math.MathContext mathContext)
```
    Calculates the hyperbolic cosine of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the hyperbolic cosine for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated hyperbolic cosine BigDecimal with the precision specified in the mathContext
  - tanh
```
public static java.math.BigDecimal tanh(java.math.BigDecimal x,
                                        java.math.MathContext mathContext)
```
    Calculates the hyperbolic tangens of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the hyperbolic tangens for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated hyperbolic tangens BigDecimal with the precision specified in the mathContext
  - coth
```
public static java.math.BigDecimal coth(java.math.BigDecimal x,
                                        java.math.MathContext mathContext)
```
    Calculates the hyperbolic cotangens of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the hyperbolic cotangens for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated hyperbolic cotangens BigDecimal with the precision specified in the mathContext
  - asinh
```
public static java.math.BigDecimal asinh(java.math.BigDecimal x,
                                         java.math.MathContext mathContext)
```
    Calculates the arc hyperbolic sine (inverse hyperbolic sine) of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the arc hyperbolic sine for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated arc hyperbolic sine BigDecimal with the precision specified in the mathContext
  - acosh
```
public static java.math.BigDecimal acosh(java.math.BigDecimal x,
                                         java.math.MathContext mathContext)
```
    Calculates the arc hyperbolic cosine (inverse hyperbolic cosine) of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the arc hyperbolic cosine for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated arc hyperbolic cosine BigDecimal with the precision specified in the mathContext
  - atanh
```
public static java.math.BigDecimal atanh(java.math.BigDecimal x,
                                         java.math.MathContext mathContext)
```
    Calculates the arc hyperbolic tangens (inverse hyperbolic tangens ) of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the arc hyperbolic tanges for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated arc hyperbolic tangens BigDecimal with the precision specified in the mathContext
  - acoth
```
public static java.math.BigDecimal acoth(java.math.BigDecimal x,
                                         java.math.MathContext mathContext)
```
    Calculates the arc hyperbolic cotangens (inverse hyperbolic cotangens) of BigDecimal x.
    See: Wikipedia: Hyperbolic function
    
    Parameters:
    
    x - the BigDecimal to calculate the arc hyperbolic cotangens for
    
    mathContext - the MathContext used for the result
    
    Returns:
    
    the calculated arc hyperbolic cotangens BigDecimal with the precision specified in the mathContext

Class BigDecimalMath

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isIntValue

isLongValue

isDoubleValue

mantissa

exponent

integralPart

fractionalPart

factorial

bernoulli

pow

pow

sqrt

root

log

log2

log10

pi

e

exp

sin

asin

cos

acos

tan

atan

atan2

cot

acot

sinh

cosh

tanh

coth

asinh

acosh

atanh

acoth