com.github.jessemull.microflexinteger.util

Class ImmutableMathUtil

java.lang.Object

com.github.jessemull.microflexinteger.util.ImmutableMathUtil

public class ImmutableMathUtil
extends Object

Implementation of big integer and big decimal methods missing from the java math library but required for the MicroFlex math and statistics packages. The immutable math utility currently supports the following additional operations for the BigDecimal and BigInteger classes:

Operation
Square Root
Fractional Exponentiation
Natural Exponentiation
Natural Log

Author:

Jesse L. Mull

Constructor Summary

Constructors

Constructor and Description
ImmutableMathUtil()

Method Summary

Modifier and Type	Method and Description
static BigDecimal	exp(BigDecimal power) Raises e to the power of the input big decimal.
static BigDecimal	exp(BigDecimal input, MathContext context) Returns e raised to the input power using a Taylor expansion with
static BigDecimal	ln(BigDecimal input) Calculates the natural logarithm using a Taylor sequqnce.
static BigDecimal	ln(BigDecimal input, MathContext context) Calculates the natural logarithm using a Taylor sequqnce.
static BigDecimal	pow(BigDecimal base, BigDecimal power) Raises the base to the power and returns the result.
static BigDecimal	pow(BigDecimal base, BigDecimal power, MathContext context) Raises the base to the power and returns the result.
static BigDecimal	sqrt(BigDecimal randicand) Returns the square root of a BigDecimal.
static BigDecimal	sqrt(BigDecimal randicand, MathContext context) Returns the square root of a BigDecimal.
static BigInteger	sqrt(BigInteger randicand) Returns the square root of a big integer

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmutableMathUtil

public ImmutableMathUtil()

Method Detail

sqrt

public static BigInteger sqrt(BigInteger randicand)

Returns the square root of a big integer

Parameters:

BigInteger - randicand the input big integer randicand

Returns:

the result

sqrt

public static BigDecimal sqrt(BigDecimal randicand)

Returns the square root of a BigDecimal.

Parameters:

BigDecimal - randicand the input BigDecimal randicand

Returns:

the result

sqrt

public static BigDecimal sqrt(BigDecimal randicand,
                              MathContext context)

Returns the square root of a BigDecimal.

Parameters:

BigDecimal - randicand the input BigDecimal randicand

MathContextcontext - the math context

Returns:

the result

pow

public static BigDecimal pow(BigDecimal base,
                             BigDecimal power)

Raises the base to the power and returns the result. Calculates the power by finding the natural log using a Taylor sequence and exp using Newton's method of approximating the nth root.

Parameters:

BigDecimal - base the base

BigDecimal - power the power

Returns:

the result

pow

public static BigDecimal pow(BigDecimal base,
                             BigDecimal power,
                             MathContext context)

Raises the base to the power and returns the result. Calculates the power by finding the natural log using a Taylor sequence and exp using Newton's method of approximating the nth root.

Parameters:

BigDecimal - the base

BigDecimal - the power

MathContext - the math context

Returns:

the result

ln

public static BigDecimal ln(BigDecimal input)

Calculates the natural logarithm using a Taylor sequqnce.

Parameters:

BigDecimal - the input big decimal > 0

Returns:

the natural logarithm

ln

public static BigDecimal ln(BigDecimal input,
                            MathContext context)

Calculates the natural logarithm using a Taylor sequqnce.

Parameters:

BigDecimal - the input big decimal > 0

Returns:

the natural logarithm

exp

public static BigDecimal exp(BigDecimal power)

Raises e to the power of the input big decimal.

Parameters:

BigDecimal - the input power

Returns:

the result

exp

public static BigDecimal exp(BigDecimal input,
                             MathContext context)

Returns e raised to the input power using a Taylor expansion with

Parameters:

BigDecimal - the power

MathContext - the math context

Returns:

e raised to the input power