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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BigFloat>

Enclosing class:

BigFloat
```
private static final class BigFloat.SpecialBigFloat
extends BigFloat
```
this class handle unrepresentable value in floating-point arithmetic

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class BigFloat.SpecialBigFloat.Type
- Nested classes/interfaces inherited from class ch.obermuhlner.math.big.BigFloat
  BigFloat.Context

Field Summary

Fields
Modifier and Type Field Description

private static BigFloat.Context DUMMY_CONTEXT

private BigFloat.SpecialBigFloat.Type type
- Fields inherited from class ch.obermuhlner.math.big.BigFloat
  NaN, NEGATIVE_INFINITY, POSITIVE_INFINITY

Constructor Summary

Constructors
Modifier Constructor Description

private SpecialBigFloat(BigFloat.SpecialBigFloat.Type type)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BigFloat`	`add(BigFloat x)`	Returns the `BigFloat` that is `this + x`.
`int`	`compareTo(BigFloat other)`
`BigFloat`	`divide(BigFloat x)`	Returns the `BigFloat` that is `this / x`.
`boolean`	`equals(java.lang.Object obj)`
`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`	`isIntValue()`	Returns whether `this` value can be represented as `int`.
`boolean`	`isNegative()`	Returns whether this `BigFloat` is negative.
`boolean`	`isPositive()`	Returns whether this `BigFloat` is positive.
`protected boolean`	`isSpecial()`
`boolean`	`isZero()`	Returns whether this `BigFloat` is 0.
`BigFloat`	`multiply(BigFloat x)`	Returns the `BigFloat` that is `this * x`.
`BigFloat`	`pow(BigFloat y)`	Returns the `BigFloat` that is `this` to the power of `y`.
`BigFloat`	`remainder(BigFloat x)`	Returns the `BigFloat` that is the remainder when dividing `this` by `x`.
`BigFloat`	`root(BigFloat y)`	Returns the `BigFloat` that is the `y`th root of `this`.
`int`	`signum()`	Returns the signum function of this `BigFloat`.
`BigFloat`	`subtract(BigFloat x)`	Returns the `BigFloat` that is `this - x`.
`BigFloat`	`subtract(java.math.BigDecimal x)`	Returns the `BigFloat` that is `this - 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()`
`protected BigFloat.SpecialBigFloat.Type`	`type()`	return special type of a value

Methods inherited from class ch.obermuhlner.math.big.BigFloat
abs, acos, acosh, acot, acoth, add, add, add, add, asin, asinh, atan, atanh, context, context, cos, cosh, cot, coth, divide, divide, divide, divide, exp, isBetween, isEqual, isGreaterThan, isGreaterThanOrEqual, isInfinity, isLessThan, isLessThanOrEqual, isNaN, log, log10, log2, max, max, min, min, multiply, multiply, multiply, multiply, negate, pow, pow, pow, pow, pow, remainder, remainder, remainder, remainder, root, root, root, root, root, sin, sinh, sqrt, subtract, subtract, subtract, tan, tanh

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

- Field Detail
  - DUMMY_CONTEXT
```
private static final BigFloat.Context DUMMY_CONTEXT
```
  - type
```
private final BigFloat.SpecialBigFloat.Type type
```
- Constructor Detail
  - SpecialBigFloat
```
private SpecialBigFloat(BigFloat.SpecialBigFloat.Type type)
```
- Method Detail
  - isSpecial
```
protected boolean isSpecial()
```
    Overrides:
    
    isSpecial in class BigFloat
  - type
```
protected BigFloat.SpecialBigFloat.Type type()
```
    Description copied from class: BigFloat
    
    return special type of a value
    
    Overrides:
    
    type in class BigFloat
    
    Returns:
    
    BigFloat.SpecialBigFloat.Type
  - add
```
public BigFloat add(BigFloat x)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    add in class BigFloat
    
    Parameters:
    
    x - the value to add
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.add(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(BigFloat x)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    subtract in class BigFloat
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - subtract
```
public BigFloat subtract(java.math.BigDecimal x)
```
    Description copied from class: BigFloat
    
    Returns the BigFloat that is this - x.
    
    Overrides:
    
    subtract in class BigFloat
    
    Parameters:
    
    x - the value to subtract
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.subtract(BigDecimal, MathContext)
  - multiply
```
public BigFloat multiply(BigFloat x)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    multiply in class BigFloat
    
    Parameters:
    
    x - the value to multiply
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.multiply(BigDecimal, MathContext)
  - divide
```
public BigFloat divide(BigFloat x)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    divide in class BigFloat
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.divide(BigDecimal, MathContext)
  - remainder
```
public BigFloat remainder(BigFloat x)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    remainder in class BigFloat
    
    Parameters:
    
    x - the value to divide with
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimal.remainder(BigDecimal, MathContext)
  - pow
```
public BigFloat pow(BigFloat y)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    pow in class BigFloat
    
    Parameters:
    
    y - the value of the power
    
    Returns:
    
    the resulting BigFloat
    
    See Also:
    
    BigDecimalMath.pow(BigDecimal, BigDecimal, MathContext)
  - root
```
public BigFloat root(BigFloat y)
```
    Description copied from class: BigFloat
    
    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.
    
    Overrides:
    
    root in class BigFloat
    
    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 BigFloat
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class BigFloat
  - signum
```
public int signum()
```
    Description copied from class: BigFloat
    
    Returns the signum function of this BigFloat.
    
    Overrides:
    
    signum in class BigFloat
    
    Returns:
    
    -1, 0, or 1 as the value of this BigDecimal is negative, zero, or positive.
  - isNegative
```
public boolean isNegative()
```
    Description copied from class: BigFloat
    
    Returns whether this BigFloat is negative.
    
    Overrides:
    
    isNegative in class BigFloat
    
    Returns:
    
    true if negative, false if 0 or positive
  - isZero
```
public boolean isZero()
```
    Description copied from class: BigFloat
    
    Returns whether this BigFloat is 0.
    
    Overrides:
    
    isZero in class BigFloat
    
    Returns:
    
    true if 0, false if negative or positive
  - isPositive
```
public boolean isPositive()
```
    Description copied from class: BigFloat
    
    Returns whether this BigFloat is positive.
    
    Overrides:
    
    isPositive in class BigFloat
    
    Returns:
    
    true if positive, false if 0 or negative
  - compareTo
```
public int compareTo(BigFloat other)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<BigFloat>
    
    Overrides:
    
    compareTo in class BigFloat
  - isIntValue
```
public boolean isIntValue()
```
    Description copied from class: BigFloat
    
    Returns whether this value can be represented as int.
    
    Overrides:
    
    isIntValue in class BigFloat
    
    Returns:
    
    true if the value can be represented as int value
    
    See Also:
    
    BigDecimalMath.isIntValue(BigDecimal)
  - isDoubleValue
```
public boolean isDoubleValue()
```
    Description copied from class: BigFloat
    
    Returns whether this specified BigDecimal value can be represented as double.
    
    Overrides:
    
    isDoubleValue in class BigFloat
    
    Returns:
    
    true if the value can be represented as double value
    
    See Also:
    
    BigDecimalMath.isDoubleValue(BigDecimal)
  - getMantissa
```
public BigFloat getMantissa()
```
    Description copied from class: BigFloat
    
    Returns the mantissa of this value written as mantissa * 10^exponent.
    The mantissa is defined as having exactly 1 digit before the decimal point.
    
    Overrides:
    
    getMantissa in class BigFloat
    
    Returns:
    
    the mantissa
    
    See Also:
    
    BigFloat.getExponent(), BigDecimalMath.mantissa(BigDecimal)
  - getExponent
```
public BigFloat getExponent()
```
    Description copied from class: BigFloat
    
    Returns the exponent of this value written as mantissa * 10^exponent.
    The mantissa is defined as having exactly 1 digit before the decimal point.
    
    Overrides:
    
    getExponent in class BigFloat
    
    Returns:
    
    the exponent
    
    See Also:
    
    BigFloat.getMantissa(), BigDecimalMath.exponent(BigDecimal)
  - getIntegralPart
```
public BigFloat getIntegralPart()
```
    Description copied from class: BigFloat
    
    Returns the integral part of this value (left of the decimal point).
    
    Overrides:
    
    getIntegralPart in class BigFloat
    
    Returns:
    
    the integral part
    
    See Also:
    
    BigFloat.getFractionalPart(), BigDecimalMath.fractionalPart(BigDecimal)
  - getFractionalPart
```
public BigFloat getFractionalPart()
```
    Description copied from class: BigFloat
    
    Returns the fractional part of this value (right of the decimal point).
    
    Overrides:
    
    getFractionalPart in class BigFloat
    
    Returns:
    
    the fractional part
    
    See Also:
    
    BigFloat.getIntegralPart(), BigDecimalMath.fractionalPart(BigDecimal)
  - getContext
```
public BigFloat.Context getContext()
```
    Description copied from class: BigFloat
    
    Returns the BigFloat.Context of this value.
    
    Overrides:
    
    getContext in class BigFloat
    
    Returns:
    
    the BigFloat.Context
  - toBigDecimal
```
public java.math.BigDecimal toBigDecimal()
```
    Description copied from class: BigFloat
    
    Returns this value as a BigDecimal value.
    
    Overrides:
    
    toBigDecimal in class BigFloat
    
    Returns:
    
    the BigDecimal value
  - toDouble
```
public double toDouble()
```
    Description copied from class: BigFloat
    
    Returns this value as a double value.
    
    Overrides:
    
    toDouble in class BigFloat
    
    Returns:
    
    the double value
    
    See Also:
    
    BigDecimal.doubleValue()
  - toLong
```
public long toLong()
```
    Description copied from class: BigFloat
    
    Returns this value as a long value.
    
    Overrides:
    
    toLong in class BigFloat
    
    Returns:
    
    the long value
    
    See Also:
    
    BigDecimal.longValue()
  - toInt
```
public int toInt()
```
    Description copied from class: BigFloat
    
    Returns this value as a int value.
    
    Overrides:
    
    toInt in class BigFloat
    
    Returns:
    
    the int value
    
    See Also:
    
    BigDecimal.intValue()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class BigFloat

Modifier and Type	Field	Description
`private static BigFloat.Context`	`DUMMY_CONTEXT`
`private BigFloat.SpecialBigFloat.Type`	`type`

Class BigFloat.SpecialBigFloat

Nested Class Summary

Nested classes/interfaces inherited from class ch.obermuhlner.math.big.BigFloat

Field Summary

Fields inherited from class ch.obermuhlner.math.big.BigFloat

Constructor Summary

Method Summary

Methods inherited from class ch.obermuhlner.math.big.BigFloat

Methods inherited from class java.lang.Object

Field Detail

DUMMY_CONTEXT

type

Constructor Detail

SpecialBigFloat

Method Detail

isSpecial

type

add

subtract

subtract

multiply

divide

remainder

pow

root

hashCode

equals

signum

isNegative

isZero

isPositive

compareTo

isIntValue

isDoubleValue

getMantissa

getExponent

getIntegralPart

getFractionalPart

getContext

toBigDecimal

toDouble

toLong

toInt

toString