Package com.google.common.math
Class IntMath
- java.lang.Object
-
- com.google.common.math.IntMath
-
@GwtCompatible(emulated=true) public final class IntMath extends java.lang.Object
A class for arithmetic on values of typeint. Where possible, methods are defined and named analogously to theirBigIntegercounterparts.The implementations of many methods in this class are based on material from Henry S. Warren, Jr.'s Hacker's Delight, (Addison Wesley, 2002).
Similar functionality for
longand forBigIntegercan be found inLongMathandBigIntegerMathrespectively. For other common operations onintvalues, seeInts.- Since:
- 11.0
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static intbinomial(int n, int k)Returnsnchoosek, also known as the binomial coefficient ofnandk, orInteger.MAX_VALUEif the result does not fit in anint.static intcheckedAdd(int a, int b)Returns the sum ofaandb, provided it does not overflow.static intcheckedMultiply(int a, int b)Returns the product ofaandb, provided it does not overflow.static intcheckedPow(int b, int k)Returns thebto thekth power, provided it does not overflow.static intcheckedSubtract(int a, int b)Returns the difference ofaandb, provided it does not overflow.static intdivide(int p, int q, java.math.RoundingMode mode)Returns the result of dividingpbyq, rounding using the specifiedRoundingMode.static intfactorial(int n)Returnsn!, that is, the product of the firstnpositive integers,1ifn == 0, orInteger.MAX_VALUEif the result does not fit in aint.static intgcd(int a, int b)Returns the greatest common divisor ofa, b.static booleanisPowerOfTwo(int x)Returnstrueifxrepresents a power of two.static intlog10(int x, java.math.RoundingMode mode)Returns the base-10 logarithm ofx, rounded according to the specified rounding mode.static intlog2(int x, java.math.RoundingMode mode)Returns the base-2 logarithm ofx, rounded according to the specified rounding mode.static intmean(int x, int y)Returns the arithmetic mean ofxandy, rounded towards negative infinity.static intmod(int x, int m)Returnsx mod m, a non-negative value less thanm.static intpow(int b, int k)Returnsbto thekth power.static intsqrt(int x, java.math.RoundingMode mode)Returns the square root ofx, rounded with the specified rounding mode.
-
-
-
Method Detail
-
isPowerOfTwo
public static boolean isPowerOfTwo(int x)
Returnstrueifxrepresents a power of two.This differs from
Integer.bitCount(x) == 1, becauseInteger.bitCount(Integer.MIN_VALUE) == 1, butInteger.MIN_VALUEis not a power of two.
-
log2
public static int log2(int x, java.math.RoundingMode mode)Returns the base-2 logarithm ofx, rounded according to the specified rounding mode.- Throws:
java.lang.IllegalArgumentException- ifx <= 0java.lang.ArithmeticException- ifmodeisRoundingMode.UNNECESSARYandxis not a power of two
-
log10
@GwtIncompatible("need BigIntegerMath to adequately test") public static int log10(int x, java.math.RoundingMode mode)
Returns the base-10 logarithm ofx, rounded according to the specified rounding mode.- Throws:
java.lang.IllegalArgumentException- ifx <= 0java.lang.ArithmeticException- ifmodeisRoundingMode.UNNECESSARYandxis not a power of ten
-
pow
@GwtIncompatible("failing tests") public static int pow(int b, int k)
Returnsbto thekth power. Even if the result overflows, it will be equal toBigInteger.valueOf(b).pow(k).intValue(). This implementation runs inO(log k)time.Compare
checkedPow(int, int), which throws anArithmeticExceptionupon overflow.- Throws:
java.lang.IllegalArgumentException- ifk < 0
-
sqrt
@GwtIncompatible("need BigIntegerMath to adequately test") public static int sqrt(int x, java.math.RoundingMode mode)
Returns the square root ofx, rounded with the specified rounding mode.- Throws:
java.lang.IllegalArgumentException- ifx < 0java.lang.ArithmeticException- ifmodeisRoundingMode.UNNECESSARYandsqrt(x)is not an integer
-
divide
public static int divide(int p, int q, java.math.RoundingMode mode)Returns the result of dividingpbyq, rounding using the specifiedRoundingMode.- Throws:
java.lang.ArithmeticException- ifq == 0, or ifmode == UNNECESSARYandais not an integer multiple ofb
-
mod
public static int mod(int x, int m)Returnsx mod m, a non-negative value less thanm. This differs fromx % m, which might be negative.For example:
mod(7, 4) == 3 mod(-7, 4) == 1 mod(-1, 4) == 3 mod(-8, 4) == 0 mod(8, 4) == 0- Throws:
java.lang.ArithmeticException- ifm <= 0- See Also:
- Remainder Operator
-
gcd
public static int gcd(int a, int b)Returns the greatest common divisor ofa, b. Returns0ifa == 0 && b == 0.- Throws:
java.lang.IllegalArgumentException- ifa < 0orb < 0
-
checkedAdd
public static int checkedAdd(int a, int b)Returns the sum ofaandb, provided it does not overflow.- Throws:
java.lang.ArithmeticException- ifa + boverflows in signedintarithmetic
-
checkedSubtract
public static int checkedSubtract(int a, int b)Returns the difference ofaandb, provided it does not overflow.- Throws:
java.lang.ArithmeticException- ifa - boverflows in signedintarithmetic
-
checkedMultiply
public static int checkedMultiply(int a, int b)Returns the product ofaandb, provided it does not overflow.- Throws:
java.lang.ArithmeticException- ifa * boverflows in signedintarithmetic
-
checkedPow
public static int checkedPow(int b, int k)Returns thebto thekth power, provided it does not overflow.pow(int, int)may be faster, but does not check for overflow.- Throws:
java.lang.ArithmeticException- ifbto thekth power overflows in signedintarithmetic
-
factorial
public static int factorial(int n)
Returnsn!, that is, the product of the firstnpositive integers,1ifn == 0, orInteger.MAX_VALUEif the result does not fit in aint.- Throws:
java.lang.IllegalArgumentException- ifn < 0
-
binomial
@GwtIncompatible("need BigIntegerMath to adequately test") public static int binomial(int n, int k)
Returnsnchoosek, also known as the binomial coefficient ofnandk, orInteger.MAX_VALUEif the result does not fit in anint.- Throws:
java.lang.IllegalArgumentException- ifn < 0,k < 0ork > n
-
mean
public static int mean(int x, int y)Returns the arithmetic mean ofxandy, rounded towards negative infinity. This method is overflow resilient.- Since:
- 14.0
-
-