Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.math.DoubleMath

Modifier and Type	Field and Description
pack-priv static final double[]	everySixteenthFactorial
private static final double	LN_2
pack-priv static final int	MAX_FACTORIAL
private static final double	MAX_INT_AS_DOUBLE
private static final double	MAX_LONG_AS_DOUBLE_PLUS_ONE
private static final double	MIN_INT_AS_DOUBLE
private static final double	MIN_LONG_AS_DOUBLE

Access	Constructor and Description
private	DoubleMath()

Method Summary

Modifier and Type	Method and Description
private static double	checkFinite(double argument)
public static double	factorial(int n) Returns `n!`
public static int	fuzzyCompare(double a, double b, double tolerance) Compares `a` and `b` "fuzzily," with a tolerance for nearly-equal values.
public static boolean	fuzzyEquals(double a, double b, double tolerance) Returns `true` if `a` and `b` are within `tolerance` of each other.
public static boolean	isMathematicalInteger(double x) Returns `true` if `x` represents a mathematical integer.
public static boolean	isPowerOfTwo(double x) Returns `true` if `x` is exactly equal to `2^k` for some finite integer `k`.
public static double	log2(double x) Returns the base 2 logarithm of a double value.
public static int	log2(double x, RoundingMode mode) Returns the base 2 logarithm of a double value, rounded with the specified rounding mode to an `int`.
public static double	mean(double... a nonempty series of values values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`.
public static double	mean(int... a nonempty series of values values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`.
public static double	mean(long... a nonempty series of values, which will be converted to `double` values (this may cause loss of precision for longs of magnitude over 2^53 (slightly over 9e15)) values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`.
public static double	mean(Iterable<? extends Number> a nonempty series of values, which will be converted to `double` values (this may cause loss of precision) values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`.
public static double	mean(Iterator<? extends Number> a nonempty series of values, which will be converted to `double` values (this may cause loss of precision) values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`.
pack-priv static double	roundIntermediate(double x, RoundingMode mode)
public static BigInteger	roundToBigInteger(double x, RoundingMode mode) Returns the `BigInteger` value that is equal to `x` rounded with the specified rounding mode, if possible.
public static int	roundToInt(double x, RoundingMode mode) Returns the `int` value that is equal to `x` rounded with the specified rounding mode, if possible.
public static long	roundToLong(double x, RoundingMode mode) Returns the `long` value that is equal to `x` rounded with the specified rounding mode, if possible.

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

everySixteenthFactorial	back to summary
pack-priv static final double[] everySixteenthFactorial Annotations @VisibleForTesting

LN_2	back to summary
private static final double LN_2

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

MAX_INT_AS_DOUBLE	back to summary
private static final double MAX_INT_AS_DOUBLE

MAX_LONG_AS_DOUBLE_PLUS_ONE	back to summary
private static final double MAX_LONG_AS_DOUBLE_PLUS_ONE

MIN_INT_AS_DOUBLE	back to summary
private static final double MIN_INT_AS_DOUBLE

MIN_LONG_AS_DOUBLE	back to summary
private static final double MIN_LONG_AS_DOUBLE

DoubleMath	back to summary
private DoubleMath()

Method Detail

checkFinite	back to summary
private static double checkFinite(double argument) Annotations @GwtIncompatible @CanIgnoreReturnValue

factorial back to summary

factorial	back to summary
public static double factorial(int n) Returns `n!`, that is, the product of the first `n` positive integers, `1` if `n == 0`, or `n!`, or `Double#POSITIVE_INFINITY` if `n! > Double.MAX_VALUE`. The result is within 1 ulp of the true value. Exceptions IllegalArgumentException: if `n < 0`

public static double factorial(int n)

Returns n!, that is, the product of the first n positive integers, 1 if n == 0, or n!, or Double#POSITIVE_INFINITY if n! > Double.MAX_VALUE.

The result is within 1 ulp of the true value.

Exceptions

IllegalArgumentException:: if n < 0

fuzzyCompare back to summary

fuzzyCompare	back to summary
public static int fuzzyCompare(double a, double b, double tolerance) Compares `a` and `b` "fuzzily," with a tolerance for nearly-equal values. This method is equivalent to `fuzzyEquals(a, b, tolerance) ? 0 : Double.compare(a, b)`. In particular, like `Double#compare(double, double)`, it treats all NaN values as equal and greater than all other values (including `Double#POSITIVE_INFINITY`). This is not a total ordering and is not suitable for use in `Comparable#compareTo` implementations. In particular, it is not transitive. Exceptions IllegalArgumentException: if `tolerance` is `< 0` or NaN Since 13.0

public static int fuzzyCompare(double a, double b, double tolerance)

Compares a and b "fuzzily," with a tolerance for nearly-equal values.

This method is equivalent to fuzzyEquals(a, b, tolerance) ? 0 : Double.compare(a, b). In particular, like Double#compare(double, double), it treats all NaN values as equal and greater than all other values (including Double#POSITIVE_INFINITY).

This is not a total ordering and is not suitable for use in Comparable#compareTo implementations. In particular, it is not transitive.

Exceptions

IllegalArgumentException:: if tolerance is < 0 or NaN

Since

13.0

fuzzyEquals back to summary

fuzzyEquals	back to summary
public static boolean fuzzyEquals(double a, double b, double tolerance) Returns `true` if `a` and `b` are within `tolerance` of each other. Technically speaking, this is equivalent to `Math.abs(a - b) <= tolerance \|\| Double.valueOf(a).equals(Double.valueOf(b))`. Notable special cases include: All NaNs are fuzzily equal. If `a == b`, then `a` and `b` are always fuzzily equal. Positive and negative zero are always fuzzily equal. If `tolerance` is zero, and neither `a` nor `b` is NaN, then `a` and `b` are fuzzily equal if and only if `a == b`. With `Double#POSITIVE_INFINITY` tolerance, all non-NaN values are fuzzily equal. With finite tolerance, `Double.POSITIVE_INFINITY` and `Double.NEGATIVE_INFINITY` are fuzzily equal only to themselves. This is reflexive and symmetric, but not transitive, so it is not an equivalence relation and not suitable for use in `Object#equals` implementations. Exceptions IllegalArgumentException: if `tolerance` is `< 0` or NaN Since 13.0

public static boolean fuzzyEquals(double a, double b, double tolerance)

Returns true if a and b are within tolerance of each other.

Technically speaking, this is equivalent to Math.abs(a - b) <= tolerance || Double.valueOf(a).equals(Double.valueOf(b)).

Notable special cases include:

All NaNs are fuzzily equal.
If a == b, then a and b are always fuzzily equal.
Positive and negative zero are always fuzzily equal.
If tolerance is zero, and neither a nor b is NaN, then a and b are fuzzily equal if and only if a == b.
With Double#POSITIVE_INFINITY tolerance, all non-NaN values are fuzzily equal.
With finite tolerance, Double.POSITIVE_INFINITY and Double.NEGATIVE_INFINITY are fuzzily equal only to themselves.

This is reflexive and symmetric, but not transitive, so it is not an equivalence relation and not suitable for use in Object#equals implementations.

Exceptions

IllegalArgumentException:: if tolerance is < 0 or NaN

Since

13.0

isMathematicalInteger back to summary

isMathematicalInteger	back to summary
public static boolean isMathematicalInteger(double x) Returns `true` if `x` represents a mathematical integer. This is equivalent to, but not necessarily implemented as, the expression `!Double.isNaN(x) && !Double.isInfinite(x) && x == Math.rint(x)`. Annotations @GwtIncompatible

public static boolean isMathematicalInteger(double x)

Returns true if x represents a mathematical integer.

This is equivalent to, but not necessarily implemented as, the expression !Double.isNaN(x) && !Double.isInfinite(x) && x == Math.rint(x).

Annotations

@GwtIncompatible

isPowerOfTwo back to summary

isPowerOfTwo	back to summary
public static boolean isPowerOfTwo(double x) Returns `true` if `x` is exactly equal to `2^k` for some finite integer `k`. Annotations @GwtIncompatible

public static boolean isPowerOfTwo(double x)

Returns true if x is exactly equal to 2^k for some finite integer k.

Annotations

@GwtIncompatible

log2 back to summary

log2	back to summary
public static double log2(double x) Returns the base 2 logarithm of a double value. Special cases: If `x` is NaN or less than zero, the result is NaN. If `x` is positive infinity, the result is positive infinity. If `x` is positive or negative zero, the result is negative infinity. The computed result is within 1 ulp of the exact result. If the result of this method will be immediately rounded to an `int`, `log2(double, RoundingMode)` is faster.

public static double log2(double x)

Returns the base 2 logarithm of a double value.

Special cases:

If x is NaN or less than zero, the result is NaN.
If x is positive infinity, the result is positive infinity.
If x is positive or negative zero, the result is negative infinity.

The computed result is within 1 ulp of the exact result.

If the result of this method will be immediately rounded to an int, log2(double, RoundingMode) is faster.

log2 back to summary

log2	back to summary
public static int log2(double x, RoundingMode mode) Returns the base 2 logarithm of a double value, rounded with the specified rounding mode to an `int`. Regardless of the rounding mode, this is faster than `(int) log2(x)`. Annotations @GwtIncompatible @SuppressWarnings:fallthrough Exceptions IllegalArgumentException: if `x <= 0.0`, `x` is NaN, or `x` is infinite

public static int log2(double x, RoundingMode mode)

Returns the base 2 logarithm of a double value, rounded with the specified rounding mode to an int.

Regardless of the rounding mode, this is faster than (int) log2(x).

Annotations

@GwtIncompatible
@SuppressWarnings:fallthrough

Exceptions

IllegalArgumentException:: if x <= 0.0, x is NaN, or x is infinite

mean back to summary

mean	back to summary
public static double mean(double... values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`. If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population. Parameters values:double[] a nonempty series of values Annotations @Deprecated @GwtIncompatible Exceptions IllegalArgumentException: if `values` is empty or contains any non-finite value

public static double mean(double... values)

Deprecated

Use Stats#meanOf instead, noting the less strict handling of non-finite values.

Returns the arithmetic mean of values.

If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population.

Parameters

values:double[]: a nonempty series of values

Annotations

@Deprecated
@GwtIncompatible

Exceptions

IllegalArgumentException:: if values is empty or contains any non-finite value

mean back to summary

mean	back to summary
public static double mean(int... values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`. If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population. Parameters values:int[] a nonempty series of values Annotations @Deprecated Exceptions IllegalArgumentException: if `values` is empty

public static double mean(int... values)

Deprecated

Use Stats#meanOf instead, noting the less strict handling of non-finite values.

Returns the arithmetic mean of values.

If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population.

Parameters

values:int[]: a nonempty series of values

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if values is empty

mean back to summary

mean	back to summary
public static double mean(long... values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`. If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population. Parameters values:long[] a nonempty series of values, which will be converted to `double` values (this may cause loss of precision for longs of magnitude over 2^53 (slightly over 9e15)) Annotations @Deprecated Exceptions IllegalArgumentException: if `values` is empty

public static double mean(long... values)

Deprecated

Use Stats#meanOf instead, noting the less strict handling of non-finite values.

Returns the arithmetic mean of values.

If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population.

Parameters

values:long[]: a nonempty series of values, which will be converted to double values (this may cause loss of precision for longs of magnitude over 2^53 (slightly over 9e15))

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if values is empty

mean back to summary

mean	back to summary
public static double mean(Iterable<? extends Number> values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`. If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population. Parameters values:Iterable<? extends Number> a nonempty series of values, which will be converted to `double` values (this may cause loss of precision) Annotations @Deprecated @GwtIncompatible Exceptions IllegalArgumentException: if `values` is empty or contains any non-finite value

public static double mean(Iterable<? extends Number> values)

Deprecated

Use Stats#meanOf instead, noting the less strict handling of non-finite values.

Returns the arithmetic mean of values.

If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population.

Parameters

values:Iterable<? extends Number>: a nonempty series of values, which will be converted to double values (this may cause loss of precision)

Annotations

@Deprecated
@GwtIncompatible

Exceptions

IllegalArgumentException:: if values is empty or contains any non-finite value

mean back to summary

mean	back to summary
public static double mean(Iterator<? extends Number> values) Deprecated Use `Stats#meanOf` instead, noting the less strict handling of non-finite values. Returns the arithmetic mean of `values`. If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population. Parameters values:Iterator<? extends Number> a nonempty series of values, which will be converted to `double` values (this may cause loss of precision) Annotations @Deprecated @GwtIncompatible Exceptions IllegalArgumentException: if `values` is empty or contains any non-finite value

public static double mean(Iterator<? extends Number> values)

Deprecated

Use Stats#meanOf instead, noting the less strict handling of non-finite values.

Returns the arithmetic mean of values.

If these values are a sample drawn from a population, this is also an unbiased estimator of the arithmetic mean of the population.

Parameters

values:Iterator<? extends Number>: a nonempty series of values, which will be converted to double values (this may cause loss of precision)

Annotations

@Deprecated
@GwtIncompatible

Exceptions

IllegalArgumentException:: if values is empty or contains any non-finite value

roundIntermediate	back to summary
pack-priv static double roundIntermediate(double x, RoundingMode mode) Annotations @GwtIncompatible

roundToBigInteger back to summary

roundToBigInteger	back to summary
public static BigInteger roundToBigInteger(double x, RoundingMode mode) Returns the `BigInteger` value that is equal to `x` rounded with the specified rounding mode, if possible. Annotations @GwtIncompatible Exceptions ArithmeticException: if `x` is infinite or NaN `x` is not a mathematical integer and `mode` is `RoundingMode#UNNECESSARY`

public static BigInteger roundToBigInteger(double x, RoundingMode mode)

Returns the BigInteger value that is equal to x rounded with the specified rounding mode, if possible.

Annotations

@GwtIncompatible

Exceptions

ArithmeticException:

x is infinite or NaN
x is not a mathematical integer and mode is RoundingMode#UNNECESSARY

roundToInt back to summary

roundToInt	back to summary
public static int roundToInt(double x, RoundingMode mode) Returns the `int` value that is equal to `x` rounded with the specified rounding mode, if possible. Annotations @GwtIncompatible Exceptions ArithmeticException: if `x` is infinite or NaN `x`, after being rounded to a mathematical integer using the specified rounding mode, is either less than `Integer.MIN_VALUE` or greater than `Integer.MAX_VALUE` `x` is not a mathematical integer and `mode` is `RoundingMode#UNNECESSARY`

public static int roundToInt(double x, RoundingMode mode)

Returns the int value that is equal to x rounded with the specified rounding mode, if possible.

Annotations

@GwtIncompatible

Exceptions

ArithmeticException:

x is infinite or NaN
x, after being rounded to a mathematical integer using the specified rounding mode, is either less than Integer.MIN_VALUE or greater than Integer.MAX_VALUE
x is not a mathematical integer and mode is RoundingMode#UNNECESSARY

roundToLong back to summary

roundToLong	back to summary
public static long roundToLong(double x, RoundingMode mode) Returns the `long` value that is equal to `x` rounded with the specified rounding mode, if possible. Annotations @GwtIncompatible Exceptions ArithmeticException: if `x` is infinite or NaN `x`, after being rounded to a mathematical integer using the specified rounding mode, is either less than `Long.MIN_VALUE` or greater than `Long.MAX_VALUE` `x` is not a mathematical integer and `mode` is `RoundingMode#UNNECESSARY`

public static long roundToLong(double x, RoundingMode mode)

Returns the long value that is equal to x rounded with the specified rounding mode, if possible.

Annotations

@GwtIncompatible

Exceptions

ArithmeticException:

x is infinite or NaN
x, after being rounded to a mathematical integer using the specified rounding mode, is either less than Long.MIN_VALUE or greater than Long.MAX_VALUE
x is not a mathematical integer and mode is RoundingMode#UNNECESSARY

public final Class DoubleMath

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail