Modifier and Type	Class and Description
private static class	BigIntegerMath.BigIntegerToDoubleRounder

Modifier and Type	Field and Description
private static final double	LN_10
private static final double	LN_2
pack-priv static final int	SQRT2_PRECOMPUTE_THRESHOLD
pack-priv static final BigInteger	SQRT2_PRECOMPUTED_BITS

Access	Constructor and Description
private	BigIntegerMath()

Method Summary

Modifier and Type	Method and Description
public static BigInteger	binomial(int n, int k) Returns `n` choose `k`, also known as the binomial coefficient of `n` and `k`, that is, `n!`
public static BigInteger	ceilingPowerOfTwo(BigInteger x) Returns the smallest power of two greater than or equal to `x`.
public static BigInteger	divide(BigInteger p, BigInteger q, RoundingMode mode) Returns the result of dividing `p` by `q`, rounding using the specified `RoundingMode`.
public static BigInteger	factorial(int n) Returns `n!`
pack-priv static boolean	fitsInLong(BigInteger x)
public static BigInteger	floorPowerOfTwo(BigInteger x) Returns the largest power of two less than or equal to `x`.
public static boolean	isPowerOfTwo(BigInteger x) Returns `true` if `x` represents a power of two.
pack-priv static BigInteger	listProduct(List<BigInteger> nums)
pack-priv static BigInteger	listProduct(List<BigInteger> nums, int start, int end)
public static int	log10(BigInteger x, RoundingMode mode) Returns the base-10 logarithm of `x`, rounded according to the specified rounding mode.
public static int	log2(BigInteger x, RoundingMode mode) Returns the base-2 logarithm of `x`, rounded according to the specified rounding mode.
public static double	roundToDouble(BigInteger x, RoundingMode mode) Returns `x`, rounded to a `double` with the specified rounding mode.
public static BigInteger	sqrt(BigInteger x, RoundingMode mode) Returns the square root of `x`, rounded with the specified rounding mode.
private static BigInteger	sqrtApproxWithDoubles(BigInteger x)
private static BigInteger	sqrtFloor(BigInteger x)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

LN_10	back to summary
private static final double LN_10

LN_2	back to summary
private static final double LN_2

SQRT2_PRECOMPUTE_THRESHOLD	back to summary
pack-priv static final int SQRT2_PRECOMPUTE_THRESHOLD Annotations @VisibleForTesting

SQRT2_PRECOMPUTED_BITS	back to summary
pack-priv static final BigInteger SQRT2_PRECOMPUTED_BITS Annotations @VisibleForTesting

Constructor Detail

BigIntegerMath	back to summary
private BigIntegerMath()

Method Detail

binomial back to summary

binomial	back to summary
public static BigInteger binomial(int n, int k) Returns `n` choose `k`, also known as the binomial coefficient of `n` and `k`, that is, `n! / (k! (n - k)!)`. Warning the result can take as much as O(k log n) space. Exceptions IllegalArgumentException: if `n < 0`, `k < 0`, or `k > n`

public static BigInteger binomial(int n, int k)

Returns n choose k, also known as the binomial coefficient of n and k, that is, n! / (k! (n - k)!).

Warning

the result can take as much as O(k log n) space.

Exceptions

IllegalArgumentException:: if n < 0, k < 0, or k > n

ceilingPowerOfTwo back to summary

ceilingPowerOfTwo	back to summary
public static BigInteger ceilingPowerOfTwo(BigInteger x) Returns the smallest power of two greater than or equal to `x`. This is equivalent to `BigInteger.valueOf(2).pow(log2(x, CEILING))`. Exceptions IllegalArgumentException: if `x <= 0` Since 20.0

public static BigInteger ceilingPowerOfTwo(BigInteger x)

Returns the smallest power of two greater than or equal to x. This is equivalent to BigInteger.valueOf(2).pow(log2(x, CEILING)).

Exceptions

IllegalArgumentException:: if x <= 0

Since

20.0

divide back to summary

divide	back to summary
public static BigInteger divide(BigInteger p, BigInteger q, RoundingMode mode) Returns the result of dividing `p` by `q`, rounding using the specified `RoundingMode`. Annotations @GwtIncompatible Exceptions ArithmeticException: if `q == 0`, or if `mode == UNNECESSARY` and `a` is not an integer multiple of `b`

public static BigInteger divide(BigInteger p, BigInteger q, RoundingMode mode)

Returns the result of dividing p by q, rounding using the specified RoundingMode.

Annotations

@GwtIncompatible

Exceptions

ArithmeticException:: if q == 0, or if mode == UNNECESSARY and a is not an integer multiple of b

factorial back to summary

factorial	back to summary
public static BigInteger factorial(int n) Returns `n!`, that is, the product of the first `n` positive integers, or `1` if `n == 0`. Warning the result takes O(n log n) space, so use cautiously. This uses an efficient binary recursive algorithm to compute the factorial with balanced multiplies. It also removes all the 2s from the intermediate products (shifting them back in at the end). Exceptions IllegalArgumentException: if `n < 0`

public static BigInteger factorial(int n)

Returns n!, that is, the product of the first n positive integers, or 1 if n == 0.

Warning

the result takes O(n log n) space, so use cautiously.

This uses an efficient binary recursive algorithm to compute the factorial with balanced multiplies. It also removes all the 2s from the intermediate products (shifting them back in at the end).

Exceptions

IllegalArgumentException:: if n < 0

fitsInLong	back to summary
pack-priv static boolean fitsInLong(BigInteger x) Annotations @GwtIncompatible

floorPowerOfTwo back to summary

floorPowerOfTwo	back to summary
public static BigInteger floorPowerOfTwo(BigInteger x) Returns the largest power of two less than or equal to `x`. This is equivalent to `BigInteger.valueOf(2).pow(log2(x, FLOOR))`. Exceptions IllegalArgumentException: if `x <= 0` Since 20.0

public static BigInteger floorPowerOfTwo(BigInteger x)

Returns the largest power of two less than or equal to x. This is equivalent to BigInteger.valueOf(2).pow(log2(x, FLOOR)).

Exceptions

IllegalArgumentException:: if x <= 0

Since

20.0

isPowerOfTwo	back to summary
public static boolean isPowerOfTwo(BigInteger x) Returns `true` if `x` represents a power of two.

listProduct	back to summary
pack-priv static BigInteger listProduct(List<BigInteger> nums)

listProduct	back to summary
pack-priv static BigInteger listProduct(List<BigInteger> nums, int start, int end)

log10 back to summary

log10	back to summary
public static int log10(BigInteger x, RoundingMode mode) Returns the base-10 logarithm of `x`, rounded according to the specified rounding mode. Annotations @GwtIncompatible @SuppressWarnings:fallthrough Exceptions IllegalArgumentException: if `x <= 0` ArithmeticException: if `mode` is `RoundingMode#UNNECESSARY` and `x` is not a power of ten

public static int log10(BigInteger x, RoundingMode mode)

Returns the base-10 logarithm of x, rounded according to the specified rounding mode.

Annotations

@GwtIncompatible
@SuppressWarnings:fallthrough

Exceptions

IllegalArgumentException:: if x <= 0
ArithmeticException:: if mode is RoundingMode#UNNECESSARY and x is not a power of ten

log2 back to summary

log2	back to summary
public static int log2(BigInteger x, RoundingMode mode) Returns the base-2 logarithm of `x`, rounded according to the specified rounding mode. Annotations @SuppressWarnings:fallthrough Exceptions IllegalArgumentException: if `x <= 0` ArithmeticException: if `mode` is `RoundingMode#UNNECESSARY` and `x` is not a power of two

public static int log2(BigInteger x, RoundingMode mode)

Returns the base-2 logarithm of x, rounded according to the specified rounding mode.

Annotations

@SuppressWarnings:fallthrough

Exceptions

IllegalArgumentException:: if x <= 0
ArithmeticException:: if mode is RoundingMode#UNNECESSARY and x is not a power of two

roundToDouble back to summary

roundToDouble	back to summary
public static double roundToDouble(BigInteger x, RoundingMode mode) Returns `x`, rounded to a `double` with the specified rounding mode. If `x` is precisely representable as a `double`, its `double` value will be returned; otherwise, the rounding will choose between the two nearest representable values with `mode`. For the case of `RoundingMode#HALF_DOWN`, `HALF_UP`, and `HALF_EVEN`, infinite `double` values are considered infinitely far away. For example, 2^2000 is not representable as a double, but `roundToDouble(BigInteger.valueOf(2).pow(2000), HALF_UP)` will return `Double.MAX_VALUE`, not `Double.POSITIVE_INFINITY`. For the case of `RoundingMode#HALF_EVEN`, this implementation uses the IEEE 754 default rounding mode: if the two nearest representable values are equally near, the one with the least significant bit zero is chosen. (In such cases, both of the nearest representable values are even integers; this method returns the one that is a multiple of a greater power of two.) Annotations @GwtIncompatible Exceptions ArithmeticException: if `mode` is `RoundingMode#UNNECESSARY` and `x` is not precisely representable as a `double` Since 30.0

public static double roundToDouble(BigInteger x, RoundingMode mode)

Returns x, rounded to a double with the specified rounding mode. If x is precisely representable as a double, its double value will be returned; otherwise, the rounding will choose between the two nearest representable values with mode.

For the case of RoundingMode#HALF_DOWN, HALF_UP, and HALF_EVEN, infinite double values are considered infinitely far away. For example, 2^2000 is not representable as a double, but roundToDouble(BigInteger.valueOf(2).pow(2000), HALF_UP) will return Double.MAX_VALUE, not Double.POSITIVE_INFINITY.

For the case of RoundingMode#HALF_EVEN, this implementation uses the IEEE 754 default rounding mode: if the two nearest representable values are equally near, the one with the least significant bit zero is chosen. (In such cases, both of the nearest representable values are even integers; this method returns the one that is a multiple of a greater power of two.)

Annotations

@GwtIncompatible

Exceptions

ArithmeticException:: if mode is RoundingMode#UNNECESSARY and x is not precisely representable as a double

Since

30.0

sqrt back to summary

sqrt	back to summary
public static BigInteger sqrt(BigInteger x, RoundingMode mode) Returns the square root of `x`, rounded with the specified rounding mode. Annotations @GwtIncompatible @SuppressWarnings:fallthrough Exceptions IllegalArgumentException: if `x < 0` ArithmeticException: if `mode` is `RoundingMode#UNNECESSARY` and `sqrt(x)` is not an integer

public static BigInteger sqrt(BigInteger x, RoundingMode mode)

Returns the square root of x, rounded with the specified rounding mode.

Annotations

@GwtIncompatible
@SuppressWarnings:fallthrough

Exceptions

IllegalArgumentException:: if x < 0
ArithmeticException:: if mode is RoundingMode#UNNECESSARY and sqrt(x) is not an integer

sqrtApproxWithDoubles	back to summary
private static BigInteger sqrtApproxWithDoubles(BigInteger x) Annotations @GwtIncompatible

sqrtFloor	back to summary
private static BigInteger sqrtFloor(BigInteger x) Annotations @GwtIncompatible

com.google.common.math back to summary

private Class BigIntegerMath.BigIntegerToDoubleRounder

Class Inheritance

extends ToDoubleRounder<BigInteger>

java.lang.Object
com.google.common.math.ToDoubleRounder
com.google.common.math.BigIntegerMath.BigIntegerToDoubleRounder

Annotations

@GwtIncompatible

Field Summary

Modifier and Type	Field and Description
pack-priv static final BigIntegerMath.BigIntegerToDoubleRounder	INSTANCE

Constructor Summary

Access	Constructor and Description
private	BigIntegerToDoubleRounder()

Method Summary

Modifier and Type	Method and Description
pack-priv BigInteger	minus(BigInteger a, BigInteger b) Implements abstract com.google.common.math.ToDoubleRounder.minus. Returns a - b, guaranteed that both arguments are nonnegative.
pack-priv double	roundToDoubleArbitrarily(BigInteger bigInteger) Implements abstract com.google.common.math.ToDoubleRounder.roundToDoubleArbitrarily. Returns x rounded to either the greatest double less than or equal to the precise value of x, or the least double greater than or equal to the precise value of x.
pack-priv int	sign(BigInteger bigInteger) Implements abstract com.google.common.math.ToDoubleRounder.sign. Returns the sign of x: either -1, 0, or 1.
pack-priv BigInteger	toX(double d, RoundingMode mode) Implements abstract com.google.common.math.ToDoubleRounder.toX. Returns d's value as an X, rounded with the specified mode.

Inherited from com.google.common.math.ToDoubleRounder:: roundToDouble

Field Detail

INSTANCE	back to summary
pack-priv static final BigIntegerMath.BigIntegerToDoubleRounder INSTANCE

Constructor Detail

BigIntegerToDoubleRounder	back to summary
private BigIntegerToDoubleRounder()

Method Detail

minus	back to summary
pack-priv BigInteger minus(BigInteger a, BigInteger b) Implements abstract com.google.common.math.ToDoubleRounder.minus. Doc from com.google.common.math.ToDoubleRounder.minus. Returns a - b, guaranteed that both arguments are nonnegative. Annotations @Override

minus

back to summary

pack-priv BigInteger minus(BigInteger a, BigInteger b)

Implements abstract com.google.common.math.ToDoubleRounder.minus.

Doc from com.google.common.math.ToDoubleRounder.minus.

Returns a - b, guaranteed that both arguments are nonnegative.

Annotations

@Override

roundToDoubleArbitrarily	back to summary
pack-priv double roundToDoubleArbitrarily(BigInteger bigInteger) Implements abstract com.google.common.math.ToDoubleRounder.roundToDoubleArbitrarily. Doc from com.google.common.math.ToDoubleRounder.roundToDoubleArbitrarily. Returns x rounded to either the greatest double less than or equal to the precise value of x, or the least double greater than or equal to the precise value of x. Annotations @Override

roundToDoubleArbitrarily

back to summary

pack-priv double roundToDoubleArbitrarily(BigInteger bigInteger)

Implements abstract com.google.common.math.ToDoubleRounder.roundToDoubleArbitrarily.

Doc from com.google.common.math.ToDoubleRounder.roundToDoubleArbitrarily.

Returns x rounded to either the greatest double less than or equal to the precise value of x, or the least double greater than or equal to the precise value of x.

Annotations

@Override

sign	back to summary
pack-priv int sign(BigInteger bigInteger) Implements abstract com.google.common.math.ToDoubleRounder.sign. Doc from com.google.common.math.ToDoubleRounder.sign. Returns the sign of x: either -1, 0, or 1. Annotations @Override

sign

back to summary

pack-priv int sign(BigInteger bigInteger)

Implements abstract com.google.common.math.ToDoubleRounder.sign.

Doc from com.google.common.math.ToDoubleRounder.sign.

Returns the sign of x: either -1, 0, or 1.

Annotations

@Override

toX	back to summary
pack-priv BigInteger toX(double d, RoundingMode mode) Implements abstract com.google.common.math.ToDoubleRounder.toX. Doc from com.google.common.math.ToDoubleRounder.toX. Returns d's value as an X, rounded with the specified mode. Annotations @Override

toX

back to summary

pack-priv BigInteger toX(double d, RoundingMode mode)

Implements abstract com.google.common.math.ToDoubleRounder.toX.

Doc from com.google.common.math.ToDoubleRounder.toX.

Returns d's value as an X, rounded with the specified mode.

Annotations

@Override

public final Class BigIntegerMath

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BigIntegerMath.BigIntegerToDoubleRounder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail