com.kodeblox

Class BigDecimalFunctions

java.lang.Object

com.kodeblox.BigDecimalFunctions

public final class BigDecimalFunctions
extends Object

Mathematical functions needed for BigDecimal

Field Summary

Fields

Modifier and Type	Field and Description
static BigDecimal	PI

Constructor Summary

Constructors

Constructor and Description
BigDecimalFunctions()

Method Summary

Methods

Modifier and Type	Method and Description
static BigDecimal	arccos(BigDecimal value, MathContext mc) Calculates the arccosine of the given value.
static BigDecimal	arcsin(BigDecimal value, MathContext mc) Calculates the arcsine of the given value.
static BigDecimal	arctan(BigDecimal value, MathContext mc) Calculates the arctangent of the given value.
static BigDecimal	cos(BigDecimal angle, MathContext mc) Calculates the cosine of an angle in radians.
static BigDecimal	exp(BigDecimal exponent, MathContext mc) Calculates eexponent.
static BigDecimal	factorial(BigDecimal value, MathContext mc) Calculates the factorial of a value.
static BigDecimal	getFraction(BigDecimal number) Returns the fractional part of number.
static BigDecimal	getWhole(BigDecimal number) Returns the whole part of number.
static BigDecimal	ln(BigDecimal value, MathContext mc) Calculates loge value.
static BigDecimal	pow(BigDecimal base, BigDecimal exponent, MathContext mc) Calculates baseexponent.
static BigDecimal	pow(BigDecimal base, long exponent, MathContext mc) Calculates baseexponent.
static BigDecimal	root(BigDecimal base, long exponent, MathContext mc) Calculates the exponentth root of base.
static BigDecimal	sin(BigDecimal angle, MathContext mc) Calculates the sine of an angle in radians.
static BigDecimal	sqrt(BigDecimal value, MathContext mc) Calculates the square root of value.
static BigDecimal	tan(BigDecimal angle, MathContext mc) Calculates the tangent of an angle in radians.

Methods inherited from class java.lang.Object

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

Field Detail

PI

public static final BigDecimal PI

Constructor Detail

BigDecimalFunctions

public BigDecimalFunctions()

Method Detail

exp

public static BigDecimal exp(BigDecimal exponent,
             MathContext mc)

Calculates eexponent. The result is rounded according to the passed context mc.

Parameters:

exponent - the value to which e is raised.

mc - rounding mode and precision for the result of this operation.

Returns:

eexponent

pow

public static BigDecimal pow(BigDecimal base,
             long exponent,
             MathContext mc)

Calculates baseexponent. The result is rounded according to the passed context mc. This function specifically works on a long exponent.

Parameters:

base - the value which is raised.

exponent - the value to which the base is raised.

mc - rounding mode and precision for the result of this operation.

Returns:

baseexponent

getWhole

public static BigDecimal getWhole(BigDecimal number)

Returns the whole part of number.

Parameters:

number - the number whose whole part is calculated.

Returns:

whole part of number

getFraction

public static BigDecimal getFraction(BigDecimal number)

Returns the fractional part of number.

Parameters:

number - the number whose fractional part is calculated.

Returns:

fractional part of number

ln

public static BigDecimal ln(BigDecimal value,
            MathContext mc)

Calculates loge value. The result is rounded according to the passed context mc.

Parameters:

value - calculates log of this value.

mc - rounding mode and precision for the result of this operation.

Returns:

loge value

Throws:

IllegalArgumentException - if value <= 0.

pow

public static BigDecimal pow(BigDecimal base,
             BigDecimal exponent,
             MathContext mc)

Calculates baseexponent. The result is rounded according to the passed context mc.

Parameters:

base - the value which is raised.

exponent - the value to which the base is raised.

mc - rounding mode and precision for the result of this operation.

Returns:

baseexponent

sqrt

public static BigDecimal sqrt(BigDecimal value,
              MathContext mc)

Calculates the square root of value. The result is rounded according to the passed context mc.

Parameters:

value - the number to be rooted.

mc - rounding mode and precision for the result of this operation.

Returns:

value(1/2)

root

public static BigDecimal root(BigDecimal base,
              long exponent,
              MathContext mc)

Calculates the exponentth root of base. The result is rounded according to the passed context mc.

Parameters:

base - the number to be rooted.

exponent - the order of rooting

mc - rounding mode and precision for the result of this operation.

Returns:

base(1/exponent)

sin

public static BigDecimal sin(BigDecimal angle,
             MathContext mc)

Calculates the sine of an angle in radians. The result is rounded according to the passed context mc.

Parameters:

angle - the angle in radians.

mc - rounding mode and precision for the result of this operation.

Returns:

sin (angle)

cos

public static BigDecimal cos(BigDecimal angle,
             MathContext mc)

Calculates the cosine of an angle in radians. The result is rounded according to the passed context mc.

Parameters:

angle - the angle in radians.

mc - rounding mode and precision for the result of this operation.

Returns:

cos (angle)

tan

public static BigDecimal tan(BigDecimal angle,
             MathContext mc)

Calculates the tangent of an angle in radians. The result is rounded according to the passed context mc.

Parameters:

angle - the angle in radians.

mc - rounding mode and precision for the result of this operation.

Returns:

tan (angle)

Throws:

ArithmaticException - if angle = PI / 2 (or its odd multiple).

factorial

public static BigDecimal factorial(BigDecimal value,
                   MathContext mc)

Calculates the factorial of a value. The result is rounded according to the passed context mc.

Parameters:

value - the number whose factorial is to be found.

mc - rounding mode and precision for the result of this operation.

Returns:

value!

arcsin

public static BigDecimal arcsin(BigDecimal value,
                MathContext mc)

Calculates the arcsine of the given value. The result is rounded according to the passed context mc.

Parameters:

value - the number whose arcsine is to be found.

mc - rounding mode and precision for the result of this operation.

Returns:

sin-1(value)

Throws:

IllegalArgumentException - if value >= 1 and value <= -1.

arccos

public static BigDecimal arccos(BigDecimal value,
                MathContext mc)

Calculates the arccosine of the given value. The result is rounded according to the passed context mc.

Parameters:

value - the number whose arccosine is to be found.

mc - rounding mode and precision for the result of this operation.

Returns:

cos-1(value)

Throws:

IllegalArgumentException - if value >= 1 and value <= -1.

arctan

public static BigDecimal arctan(BigDecimal value,
                MathContext mc)

Calculates the arctangent of the given value. The result is rounded according to the passed context mc.

Parameters:

value - the number whose arctangent is to be found.

mc - rounding mode and precision for the result of this operation.

Returns:

tan-1(value)