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

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

All Implemented Interfaces:

java.lang.Comparable<BigFloat>
```
public class BigFloat
extends java.lang.Object
implements java.lang.Comparable<BigFloat>
```
A wrapper around BigDecimal which simplifies the consistent usage of the MathContext and provides a simpler API for calculations.
Overview

Every BigFloat instance has a reference to a BigFloat.Context that specifies the MathContext to be used for all calculations and values.

The API for calculations is simplified and more consistent with the typical mathematical usage.
- Factory methods for values:
  - valueOf(BigFloat)
  - valueOf(BigDecimal)
  - valueOf(int)
  - valueOf(long)
  - valueOf(double)
  - valueOf(String)
  - pi()
  - e()
- All standard operators:
  - add(x)
  - subtract(x)
  - multiply(x)
  - remainder(x)
  - pow(y)
  - root(y)
- Calculation methods are overloaded for different value types:
  - add(BigFloat)
  - add(BigDecimal)
  - add(int)
  - add(long)
  - add(double)
  - ...
- Mathematical functions are written as they are traditionally are written:
  - abs(x)
  - log(x)
  - sin(x)
  - min(x1, x2, ...)
  - max(x1, x2, ...)
  - ...
- Support for advanced mathematical functions:
  - sqrt(x)
  - log(x)
  - exp(x)
  - sin(x)
  - cos(x)
  - tan(x)
  - ...
- Methods to access parts of a value:
  - getMantissa()
  - getExponent()
  - getIntegralPart()
  - getFractionalPart()
- Equals and Hashcode methods:
  - equals(Object) that returns whether two BigFloat values are mathematically the same
  - hashCode() consistent with equals(Object)
- Comparison methods:
  - isEqual(BigFloat)
  - isLessThan(BigFloat)
  - isLessThanOrEqual(BigFloat)
  - isGreaterThan(BigFloat)
  - isGreaterThanOrEqual(BigFloat)
Usage

Before doing any calculations you need to create a Context specifying the precision used for all calculations.
```
Context context = BigFloat.context(100); // precision of 100 digits
Context anotherContext = BigFloat.context(new MathContext(10, RoundingMode.HALF_UP); // precision of 10 digits, rounding half up
```
The Context can then be used to create the first value of the calculation:
```
BigFloat value1 = context.valueOf(640320);
```
The BigFloat instance holds a reference to the Context. This context is then passed from calculation to calculation.
```
BigFloat value2 = context.valueOf(640320).pow(3).divide(24);
BigFloat value3 = BigFloat.sin(value2);
```
The BigFloat result can be converted to other numerical types:
```
BigDecimal bigDecimalValue = value3.toBigDecimal();
double doubleValue = value3.toDouble();
long longValue = value3.toLong();
int intValue = value3.toInt();
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BigFloat.Context
Manages the MathContext and provides factory methods for BigFloat values.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BigFloat.Context` Manages the `MathContext` and provides factory methods for `BigFloat` values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static BigFloat`	`abs(BigFloat x)` Returns the `BigFloat` that is the `abs(this)` (absolute value).
`static BigFloat`	`acos(BigFloat x)` Returns the `BigFloat` that is `acos(x)`.
`static BigFloat`	`acosh(BigFloat x)` Returns the `BigFloat` that is `acosh(x)`.
`static BigFloat`	`acot(BigFloat x)` Returns the `BigFloat` that is `acot(x)`.
`static BigFloat`	`acoth(BigFloat x)` Returns the `BigFloat` that is `acoth(x)`.
`BigFloat`	`add(java.math.BigDecimal x)` Returns the `BigFloat` that is `this + x`.
`BigFloat`	`add(BigFloat x)` Returns the `BigFloat` that is `this + x`.
`BigFloat`	`add(double x)` Returns the `BigFloat` that is `this + x`.
`BigFloat`	`add(int x)` Returns the `BigFloat` that is `this + x`.
`BigFloat`	`add(long x)` Returns the `BigFloat` that is `this + x`.
`static BigFloat`	`asin(BigFloat x)` Returns the `BigFloat` that is `asin(x)`.
`static BigFloat`	`asinh(BigFloat x)` Returns the `BigFloat` that is `asinh(x)`.
`static BigFloat`	`atan(BigFloat x)` Returns the `BigFloat` that is `atan(x)`.
`static BigFloat`	`atanh(BigFloat x)` Returns the `BigFloat` that is `atanh(x)`.
`int`	`compareTo(BigFloat other)`
`static BigFloat.Context`	`context(int precision)` Creates a `BigFloat.Context` with the specified precision and `RoundingMode.HALF_UP` rounding.
`static BigFloat.Context`	`context(java.math.MathContext mathContext)` Creates a `BigFloat.Context` with the specified `MathContext`.
`static BigFloat`	`cos(BigFloat x)` Returns the `BigFloat` that is `cos(x)`.
`static BigFloat`	`cosh(BigFloat x)` Returns the `BigFloat` that is `cosh(x)`.
`static BigFloat`	`cot(BigFloat x)` Returns the `BigFloat` that is `cot(x)`.
`static BigFloat`	`coth(BigFloat x)` Returns the `BigFloat` that is `coth(x)`.
`BigFloat`	`divide(java.math.BigDecimal x)` Returns the `BigFloat` that is `this / x`.
`BigFloat`	`divide(BigFloat x)` Returns the `BigFloat` that is `this / x`.
`BigFloat`	`divide(double x)` Returns the `BigFloat` that is `this / x`.
`BigFloat`	`divide(int x)` Returns the `BigFloat` that is `this / x`.
`BigFloat`	`divide(long x)` Returns the `BigFloat` that is `this / x`.
`boolean`	`equals(java.lang.Object obj)`
`static BigFloat`	`exp(BigFloat x)` Returns the `BigFloat` that is `exp(x)`.
`BigFloat.Context`	`getContext()` Returns the `BigFloat.Context` of `this` value.
`BigFloat`	`getExponent()` Returns the exponent of `this` value written as mantissa 10^exponent*.
`BigFloat`	`getFractionalPart()` Returns the fractional part of `this` value (right of the decimal point).
`BigFloat`	`getIntegralPart()` Returns the integral part of `this` value (left of the decimal point).
`BigFloat`	`getMantissa()` Returns the mantissa of `this` value written as mantissa 10^exponent*.
`int`	`hashCode()`
`boolean`	`isDoubleValue()` Returns whether `this` specified `BigDecimal` value can be represented as `double`.
`boolean`	`isEqual(BigFloat other)` Returns whether `this` value is mathematically equal to the `other` value.
`boolean`	`isGreaterThan(BigFloat other)` Returns whether `this` value is mathematically greater than to the `other` value.
`boolean`	`isGreaterThanOrEqual(BigFloat other)` Returns whether `this` value is mathematically greater than or equal to the `other` value.
`boolean`	`isIntValue()` Returns whether `this` value can be represented as `int`.
`boolean`	`isLessThan(BigFloat other)` Returns whether `this` value is mathematically less than to the `other` value.
`boolean`	`isLessThanOrEqual(BigFloat other)` Returns whether `this` value is mathematically less than or equal to the `other` value.
`boolean`	`isNegative()` Returns whether this `BigFloat` is negative.
`boolean`	`isPositive()` Returns whether this `BigFloat` is positive.
`boolean`	`isZero()` Returns whether this `BigFloat` is 0.
`static BigFloat`	`log(BigFloat x)` Returns the `BigFloat` that is `log(x)`.
`static BigFloat`	`log10(BigFloat x)` Returns the `BigFloat` that is `log10(x)`.
`static BigFloat`	`log2(BigFloat x)` Returns the `BigFloat` that is `log2(x)`.
`static BigFloat`	`max(BigFloat value1, BigFloat... values)` Returns the the maximum of n `BigFloat` values.
`static BigFloat`	`max(BigFloat value1, BigFloat value2)` Returns the the maximum of two `BigFloat` values.
`static BigFloat`	`min(BigFloat value1, BigFloat... values)` Returns the the minimum of n `BigFloat` values.
`static BigFloat`	`min(BigFloat value1, BigFloat value2)` Returns the the minimum of two `BigFloat` values.
`BigFloat`	`multiply(java.math.BigDecimal x)` Returns the `BigFloat` that is `this * x`.
`BigFloat`	`multiply(BigFloat x)` Returns the `BigFloat` that is `this * x`.
`BigFloat`	`multiply(double x)` Returns the `BigFloat` that is `this * x`.
`BigFloat`	`multiply(int x)` Returns the `BigFloat` that is `this * x`.
`BigFloat`	`multiply(long x)` Returns the `BigFloat` that is `this * x`.
`static BigFloat`	`negate(BigFloat x)` Returns the `BigFloat` that is `- this`.
`BigFloat`	`pow(java.math.BigDecimal y)` Returns the `BigFloat` that is `this` to the power of `y`.
`BigFloat`	`pow(BigFloat y)` Returns the `BigFloat` that is `this` to the power of `y`.
`static BigFloat`	`pow(BigFloat x, BigFloat y)` Returns the `BigFloat` that is `pow(x, y)`.
`BigFloat`	`pow(double y)` Returns the `BigFloat` that is `this` to the power of `y`.
`BigFloat`	`pow(int y)` Returns the `BigFloat` that is `this` to the power of `y`.
`BigFloat`	`pow(long y)` Returns the `BigFloat` that is `this` to the power of `y`.
`BigFloat`	`remainder(java.math.BigDecimal x)` Returns the `BigFloat` that is the remainder when dividing `this` by `x`.
`BigFloat`	`remainder(BigFloat x)` Returns the `BigFloat` that is the remainder when dividing `this` by `x`.
`BigFloat`	`remainder(double x)` Returns the `BigFloat` that is the remainder when dividing `this` by `x`.
`BigFloat`	`remainder(int x)` Returns the `BigFloat` that is the remainder when dividing `this` by `x`.
`BigFloat`	`remainder(long x)` Returns the `BigFloat` that is the remainder when dividing `this` by `x`.
`BigFloat`	`root(java.math.BigDecimal y)` Returns the `BigFloat` that is the `y`th root of `this`.
`BigFloat`	`root(BigFloat y)` Returns the `BigFloat` that is the `y`th root of `this`.
`static BigFloat`	`root(BigFloat x, BigFloat y)` Returns the `BigFloat` that is `root(x, y)`.
`BigFloat`	`root(double y)` Returns the `BigFloat` that is the `y`th root of `this`.
`BigFloat`	`root(int y)` Returns the `BigFloat` that is the `y`th root of `this`.
`BigFloat`	`root(long y)` Returns the `BigFloat` that is the `y`th root of `this`.
`int`	`signum()` Returns the signum function of this `BigFloat`.
`static BigFloat`	`sin(BigFloat x)` Returns the `BigFloat` that is `sin(x)`.
`static BigFloat`	`sinh(BigFloat x)` Returns the `BigFloat` that is `sinh(x)`.
`static BigFloat`	`sqrt(BigFloat x)` Returns the `BigFloat` that is `sqrt(x)`.
`BigFloat`	`subtract(java.math.BigDecimal x)` Returns the `BigFloat` that is `this - x`.
`BigFloat`	`subtract(BigFloat x)` Returns the `BigFloat` that is `this - x`.
`BigFloat`	`subtract(double x)` Returns the `BigFloat` that is `this - x`.
`BigFloat`	`subtract(int x)` Returns the `BigFloat` that is `this - x`.
`BigFloat`	`subtract(long x)` Returns the `BigFloat` that is `this - x`.
`static BigFloat`	`tan(BigFloat x)` Returns the `BigFloat` that is `tan(x)`.
`static BigFloat`	`tanh(BigFloat x)` Returns the `BigFloat` that is `tanh(x)`.
`java.math.BigDecimal`	`toBigDecimal()` Returns `this` value as a `BigDecimal` value.
`double`	`toDouble()` Returns `this` value as a `double` value.
`int`	`toInt()` Returns `this` value as a `int` value.
`long`	`toLong()` Returns `this` value as a `long` value.
`java.lang.String`	`toString()`

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

- Method Detail
  - add
```
public BigFloat add(BigFloat x)
```
    Returns the BigFloat that is this + x.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the value to add
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.add(BigDecimal, MathContext)
  - add
```
public BigFloat add(java.math.BigDecimal x)
```
    Returns the BigFloat that is this + x.
    
    Parameters:
    
    x - the value to add
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.add(BigDecimal, MathContext)
  - add
```
public BigFloat add(int x)
```
    Returns the BigFloat that is this + x.
    
    Parameters:
    
    x - the value to add
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.add(BigDecimal, MathContext)
  - add
```
public BigFloat add(long x)
```
    Returns the BigFloat that is this + x.
    
    Parameters:
    
    x - the value to add
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.add(BigDecimal, MathContext)
  - add
```
public BigFloat add(double x)
```
    Returns the BigFloat that is this + x.
    
    Parameters:
    
    x - the value to add
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.add(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(BigFloat x)
```
    Returns the BigFloat that is this - x.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(java.math.BigDecimal x)
```
    Returns the BigFloat that is this - x.
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(int x)
```
    Returns the BigFloat that is this - x.
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(long x)
```
    Returns the BigFloat that is this - x.
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(double x)
```
    Returns the BigFloat that is this - x.
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - multiply
```
public BigFloat multiply(BigFloat x)
```
    Returns the BigFloat that is this * x.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the value to multiply
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.multiply(BigDecimal, MathContext)
  - multiply
```
public BigFloat multiply(java.math.BigDecimal x)
```
    Returns the BigFloat that is this * x.
    
    Parameters:
    
    x - the value to multiply
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.multiply(BigDecimal, MathContext)
  - multiply
```
public BigFloat multiply(int x)
```
    Returns the BigFloat that is this * x.
    
    Parameters:
    
    x - the value to multiply
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.multiply(BigDecimal, MathContext)
  - multiply
```
public BigFloat multiply(long x)
```
    Returns the BigFloat that is this * x.
    
    Parameters:
    
    x - the value to multiply
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.multiply(BigDecimal, MathContext)
  - multiply
```
public BigFloat multiply(double x)
```
    Returns the BigFloat that is this * x.
    
    Parameters:
    
    x - the value to multiply
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.multiply(BigDecimal, MathContext)
  - divide
```
public BigFloat divide(BigFloat x)
```
    Returns the BigFloat that is this / x.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.divide(BigDecimal, MathContext)
  - divide
```
public BigFloat divide(java.math.BigDecimal x)
```
    Returns the BigFloat that is this / x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.divide(BigDecimal, MathContext)
  - divide
```
public BigFloat divide(int x)
```
    Returns the BigFloat that is this / x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.divide(BigDecimal, MathContext)
  - divide
```
public BigFloat divide(long x)
```
    Returns the BigFloat that is this / x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.divide(BigDecimal, MathContext)
  - divide
```
public BigFloat divide(double x)
```
    Returns the BigFloat that is this / x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.divide(BigDecimal, MathContext)
  - remainder
```
public BigFloat remainder(BigFloat x)
```
    Returns the BigFloat that is the remainder when dividing this by x.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.remainder(BigDecimal, MathContext)
  - remainder
```
public BigFloat remainder(java.math.BigDecimal x)
```
    Returns the BigFloat that is the remainder when dividing this by x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.remainder(BigDecimal, MathContext)
  - remainder
```
public BigFloat remainder(int x)
```
    Returns the BigFloat that is the remainder when dividing this by x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.remainder(BigDecimal, MathContext)
  - remainder
```
public BigFloat remainder(long x)
```
    Returns the BigFloat that is the remainder when dividing this by x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.remainder(BigDecimal, MathContext)
  - remainder
```
public BigFloat remainder(double x)
```
    Returns the BigFloat that is the remainder when dividing this by x.
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.remainder(BigDecimal, MathContext)
  - pow
```
public BigFloat pow(BigFloat y)
```
    Returns the BigFloat that is this to the power of y.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    y - the value of the power
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - pow
```
public BigFloat pow(java.math.BigDecimal y)
```
    Returns the BigFloat that is this to the power of y.
    
    Parameters:
    
    y - the value of the power
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - pow
```
public BigFloat pow(int y)
```
    Returns the BigFloat that is this to the power of y.
    
    Parameters:
    
    y - the value of the power
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - pow
```
public BigFloat pow(long y)
```
    Returns the BigFloat that is this to the power of y.
    
    Parameters:
    
    y - the value of the power
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - pow
```
public BigFloat pow(double y)
```
    Returns the BigFloat that is this to the power of y.
    
    Parameters:
    
    y - the value of the power
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - root
```
public BigFloat root(BigFloat y)
```
    Returns the BigFloat that is the yth root of this.
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    y - the value of the root
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.root(BigDecimal, BigDecimal, MathContext)
  - root
```
public BigFloat root(java.math.BigDecimal y)
```
    Returns the BigFloat that is the yth root of this.
    
    Parameters:
    
    y - the value of the root
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.root(BigDecimal, BigDecimal, MathContext)
  - root
```
public BigFloat root(int y)
```
    Returns the BigFloat that is the yth root of this.
    
    Parameters:
    
    y - the value of the root
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.root(BigDecimal, BigDecimal, MathContext)
  - root
```
public BigFloat root(long y)
```
    Returns the BigFloat that is the yth root of this.
    
    Parameters:
    
    y - the value of the root
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.root(BigDecimal, BigDecimal, MathContext)
  - root
```
public BigFloat root(double y)
```
    Returns the BigFloat that is the yth root of this.
    
    Parameters:
    
    y - the value of the root
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.root(BigDecimal, BigDecimal, MathContext)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - signum
```
public int signum()
```
    Returns the signum function of this BigFloat.
    
    Returns:
    
    -1, 0, or 1 as the value of this BigDecimal is negative, zero, or positive.
  - isNegative
```
public boolean isNegative()
```
    Returns whether this BigFloat is negative.
    
    Returns:
    
    true if negative, false if 0 or positive
  - isZero
```
public boolean isZero()
```
    Returns whether this BigFloat is 0.
    
    Returns:
    
    true if 0, false if negative or positive
  - isPositive
```
public boolean isPositive()
```
    Returns whether this BigFloat is positive.
    
    Returns:
    
    true if positive, false if 0 or negative
  - compareTo
```
public int compareTo(BigFloat other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<BigFloat>
  - isEqual
```
public boolean isEqual(BigFloat other)
```
    Returns whether this value is mathematically equal to the other value.
    
    Parameters:
    
    other - the other BigFloat to compare with
    
    Returns:
    
    true if both values are mathematically equal (equivalent to this.compareTo(other) == 0
    
    See Also:
    
    compareTo(BigFloat)
  - isLessThan
```
public boolean isLessThan(BigFloat other)
```
    Returns whether this value is mathematically less than to the other value.
    
    Parameters:
    
    other - the other BigFloat to compare with
    
    Returns:
    
    true this value is mathematically less than to the other value (equivalent to this.compareTo(other) < 0
    
    See Also:
    
    compareTo(BigFloat)
  - isGreaterThan
```
public boolean isGreaterThan(BigFloat other)
```
    Returns whether this value is mathematically greater than to the other value.
    
    Parameters:
    
    other - the other BigFloat to compare with
    
    Returns:
    
    true this value is mathematically greater than to the other value (equivalent to this.compareTo(other) > 0
    
    See Also:
    
    compareTo(BigFloat)
  - isLessThanOrEqual
```
public boolean isLessThanOrEqual(BigFloat other)
```
    Returns whether this value is mathematically less than or equal to the other value.
    
    Parameters:
    
    other - the other BigFloat to compare with
    
    Returns:
    
    true this value is mathematically less than or equal to the other value (equivalent to this.compareTo(other) <= 0
    
    See Also:
    
    compareTo(BigFloat), isLessThan(BigFloat), isEqual(BigFloat)
  - isGreaterThanOrEqual
```
public boolean isGreaterThanOrEqual(BigFloat other)
```
    Returns whether this value is mathematically greater than or equal to the other value.
    
    Parameters:
    
    other - the other BigFloat to compare with
    
    Returns:
    
    true this value is mathematically greater than or equal to the other value (equivalent to this.compareTo(other) >= 0
    
    See Also:
    
    compareTo(BigFloat), isGreaterThan(BigFloat), isEqual(BigFloat)
  - isIntValue
```
public boolean isIntValue()
```
    Returns whether this value can be represented as int.
    
    Returns:
    
    true if the value can be represented as int value
    
    See Also:
    
    BigDecimalMath.isIntValue(BigDecimal)
  - isDoubleValue
```
public boolean isDoubleValue()
```
    Returns whether this specified BigDecimal value can be represented as double.
    
    Returns:
    
    true if the value can be represented as double value
    
    See Also:
    
    BigDecimalMath.isDoubleValue(BigDecimal)
  - getMantissa
```
public BigFloat getMantissa()
```
    Returns the mantissa of this value written as mantissa * 10^exponent.
    The mantissa is defined as having exactly 1 digit before the decimal point.
    
    Returns:
    
    the mantissa
    
    See Also:
    
    getExponent(), BigDecimalMath.mantissa(BigDecimal)
  - getExponent
```
public BigFloat getExponent()
```
    Returns the exponent of this value written as mantissa * 10^exponent.
    The mantissa is defined as having exactly 1 digit before the decimal point.
    
    Returns:
    
    the exponent
    
    See Also:
    
    getMantissa(), BigDecimalMath.exponent(BigDecimal)
  - getIntegralPart
```
public BigFloat getIntegralPart()
```
    Returns the integral part of this value (left of the decimal point).
    
    Returns:
    
    the integral part
    
    See Also:
    
    getFractionalPart(), BigDecimalMath.fractionalPart(BigDecimal)
  - getFractionalPart
```
public BigFloat getFractionalPart()
```
    Returns the fractional part of this value (right of the decimal point).
    
    Returns:
    
    the fractional part
    
    See Also:
    
    getIntegralPart(), BigDecimalMath.fractionalPart(BigDecimal)
  - getContext
```
public BigFloat.Context getContext()
```
    Returns the BigFloat.Context of this value.
    
    Returns:
    
    the BigFloat.Context
  - toBigDecimal
```
public java.math.BigDecimal toBigDecimal()
```
    Returns this value as a BigDecimal value.
    
    Returns:
    
    the BigDecimal value
  - toDouble
```
public double toDouble()
```
    Returns this value as a double value.
    
    Returns:
    
    the double value
    
    See Also:
    
    BigDecimal.doubleValue()
  - toLong
```
public long toLong()
```
    Returns this value as a long value.
    
    Returns:
    
    the long value
    
    See Also:
    
    BigDecimal.longValue()
  - toInt
```
public int toInt()
```
    Returns this value as a int value.
    
    Returns:
    
    the int value
    
    See Also:
    
    BigDecimal.intValue()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - context
```
public static BigFloat.Context context(int precision)
```
    Creates a BigFloat.Context with the specified precision and RoundingMode.HALF_UP rounding.
    
    Parameters:
    
    precision - the precision
    
    Returns:
    
    the BigFloat.Context
  - context
```
public static BigFloat.Context context(java.math.MathContext mathContext)
```
    Creates a BigFloat.Context with the specified MathContext.
    
    Parameters:
    
    mathContext - the MathContext
    
    Returns:
    
    the BigFloat.Context
  - negate
```
public static BigFloat negate(BigFloat x)
```
    Returns the BigFloat that is - this.
    
    Parameters:
    
    x - the value to negate
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.negate(MathContext)
  - abs
```
public static BigFloat abs(BigFloat x)
```
    Returns the BigFloat that is the abs(this) (absolute value).
    
    Parameters:
    
    x - the value to make absolute
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.abs(MathContext)
  - max
```
public static BigFloat max(BigFloat value1,
                           BigFloat value2)
```
    Returns the the maximum of two BigFloat values.
    
    Parameters:
    
    value1 - the first BigFloat value to compare
    
    value2 - the second BigFloat value to compare
    
    Returns:
    
    the maximum BigFloat value
  - max
```
public static BigFloat max(BigFloat value1,
                           BigFloat... values)
```
    Returns the the maximum of n BigFloat values.
    
    Parameters:
    
    value1 - the first BigFloat value to compare
    
    values - the other BigFloats value to compare
    
    Returns:
    
    the maximum BigFloat value
  - min
```
public static BigFloat min(BigFloat value1,
                           BigFloat value2)
```
    Returns the the minimum of two BigFloat values.
    
    Parameters:
    
    value1 - the first BigFloat value to compare
    
    value2 - the second BigFloat value to compare
    
    Returns:
    
    the minimum BigFloat value
  - min
```
public static BigFloat min(BigFloat value1,
                           BigFloat... values)
```
    Returns the the minimum of n BigFloat values.
    
    Parameters:
    
    value1 - the first BigFloat value to compare
    
    values - the other BigFloats value to compare
    
    Returns:
    
    the minimum BigFloat value
  - log
```
public static BigFloat log(BigFloat x)
```
    Returns the BigFloat that is log(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.log(BigDecimal, MathContext)
  - log2
```
public static BigFloat log2(BigFloat x)
```
    Returns the BigFloat that is log2(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.log2(BigDecimal, MathContext)
  - log10
```
public static BigFloat log10(BigFloat x)
```
    Returns the BigFloat that is log10(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.log10(BigDecimal, MathContext)
  - exp
```
public static BigFloat exp(BigFloat x)
```
    Returns the BigFloat that is exp(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.exp(BigDecimal, MathContext)
  - sqrt
```
public static BigFloat sqrt(BigFloat x)
```
    Returns the BigFloat that is sqrt(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.sqrt(BigDecimal, MathContext)
  - pow
```
public static BigFloat pow(BigFloat x,
                           BigFloat y)
```
    Returns the BigFloat that is pow(x, y).
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the BigFloat value to take to the power
    
    y - the BigFloat value to serve as exponent
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - root
```
public static BigFloat root(BigFloat x,
                            BigFloat y)
```
    Returns the BigFloat that is root(x, y).
    If the two values do not have the same BigFloat.Context, the result will contain the BigFloat.Context with the larger precision.
    
    Parameters:
    
    x - the BigFloat value to calculate the n'th root
    
    y - the BigFloat defining the root
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - sin
```
public static BigFloat sin(BigFloat x)
```
    Returns the BigFloat that is sin(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.sin(BigDecimal, MathContext)
  - cos
```
public static BigFloat cos(BigFloat x)
```
    Returns the BigFloat that is cos(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.cos(BigDecimal, MathContext)
  - tan
```
public static BigFloat tan(BigFloat x)
```
    Returns the BigFloat that is tan(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.tan(BigDecimal, MathContext)
  - cot
```
public static BigFloat cot(BigFloat x)
```
    Returns the BigFloat that is cot(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.cot(BigDecimal, MathContext)
  - asin
```
public static BigFloat asin(BigFloat x)
```
    Returns the BigFloat that is asin(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.asin(BigDecimal, MathContext)
  - acos
```
public static BigFloat acos(BigFloat x)
```
    Returns the BigFloat that is acos(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.acos(BigDecimal, MathContext)
  - atan
```
public static BigFloat atan(BigFloat x)
```
    Returns the BigFloat that is atan(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.atan(BigDecimal, MathContext)
  - acot
```
public static BigFloat acot(BigFloat x)
```
    Returns the BigFloat that is acot(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.acot(BigDecimal, MathContext)
  - sinh
```
public static BigFloat sinh(BigFloat x)
```
    Returns the BigFloat that is sinh(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.sinh(BigDecimal, MathContext)
  - cosh
```
public static BigFloat cosh(BigFloat x)
```
    Returns the BigFloat that is cosh(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.cosh(BigDecimal, MathContext)
  - tanh
```
public static BigFloat tanh(BigFloat x)
```
    Returns the BigFloat that is tanh(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.tanh(BigDecimal, MathContext)
  - coth
```
public static BigFloat coth(BigFloat x)
```
    Returns the BigFloat that is coth(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.coth(BigDecimal, MathContext)
  - asinh
```
public static BigFloat asinh(BigFloat x)
```
    Returns the BigFloat that is asinh(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.asinh(BigDecimal, MathContext)
  - acosh
```
public static BigFloat acosh(BigFloat x)
```
    Returns the BigFloat that is acosh(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.acosh(BigDecimal, MathContext)
  - atanh
```
public static BigFloat atanh(BigFloat x)
```
    Returns the BigFloat that is atanh(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.atanh(BigDecimal, MathContext)
  - acoth
```
public static BigFloat acoth(BigFloat x)
```
    Returns the BigFloat that is acoth(x).
    
    Parameters:
    
    x - the value
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.acoth(BigDecimal, MathContext)

Class BigFloat

Overview

Usage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

add

add

add

add

add

subtract

subtract

subtract

subtract

subtract

multiply

multiply

multiply

multiply

multiply

divide

divide

divide

divide

divide

remainder

remainder

remainder

remainder

remainder

pow

pow

pow

pow

pow

root

root

root

root

root

hashCode

equals

signum

isNegative

isZero

isPositive

compareTo

isEqual

isLessThan

isGreaterThan

isLessThanOrEqual

isGreaterThanOrEqual

isIntValue

isDoubleValue

getMantissa

getExponent

getIntegralPart

getFractionalPart

getContext

toBigDecimal

toDouble

toLong

toInt

toString

context

context

negate

abs

max

max

min

min

log

log2

log10

exp

sqrt

pow