Package com.google.common.math
Class LongMath
- java.lang.Object
-
- com.google.common.math.LongMath
-
@GwtCompatible(emulated=true) public final class LongMath extends java.lang.Object
A class for arithmetic on values of typelong
. Where possible, methods are defined and named analogously to theirBigInteger
counterparts.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
int
and forBigInteger
can be found inIntMath
andBigIntegerMath
respectively. For other common operations onlong
values, seeLongs
.- Since:
- 11.0
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static long
binomial(int n, int k)
Returnsn
choosek
, also known as the binomial coefficient ofn
andk
, orLong.MAX_VALUE
if the result does not fit in along
.static long
checkedAdd(long a, long b)
Returns the sum ofa
andb
, provided it does not overflow.static long
checkedMultiply(long a, long b)
Returns the product ofa
andb
, provided it does not overflow.static long
checkedPow(long b, int k)
Returns theb
to thek
th power, provided it does not overflow.static long
checkedSubtract(long a, long b)
Returns the difference ofa
andb
, provided it does not overflow.static long
divide(long p, long q, java.math.RoundingMode mode)
Returns the result of dividingp
byq
, rounding using the specifiedRoundingMode
.static long
factorial(int n)
Returnsn!
, that is, the product of the firstn
positive integers,1
ifn == 0
, orLong.MAX_VALUE
if the result does not fit in along
.static long
gcd(long a, long b)
Returns the greatest common divisor ofa, b
.static boolean
isPowerOfTwo(long x)
Returnstrue
ifx
represents a power of two.static int
log10(long x, java.math.RoundingMode mode)
Returns the base-10 logarithm ofx
, rounded according to the specified rounding mode.static int
log2(long x, java.math.RoundingMode mode)
Returns the base-2 logarithm ofx
, rounded according to the specified rounding mode.static long
mean(long x, long y)
Returns the arithmetic mean ofx
andy
, rounded toward negative infinity.static int
mod(long x, int m)
Returnsx mod m
, a non-negative value less thanm
.static long
mod(long x, long m)
Returnsx mod m
, a non-negative value less thanm
.static long
pow(long b, int k)
Returnsb
to thek
th power.static long
sqrt(long x, java.math.RoundingMode mode)
Returns the square root ofx
, rounded with the specified rounding mode.
-
-
-
Method Detail
-
isPowerOfTwo
public static boolean isPowerOfTwo(long x)
Returnstrue
ifx
represents a power of two.This differs from
Long.bitCount(x) == 1
, becauseLong.bitCount(Long.MIN_VALUE) == 1
, butLong.MIN_VALUE
is not a power of two.
-
log2
public static int log2(long x, java.math.RoundingMode mode)
Returns the base-2 logarithm ofx
, rounded according to the specified rounding mode.- Throws:
java.lang.IllegalArgumentException
- ifx <= 0
java.lang.ArithmeticException
- ifmode
isRoundingMode.UNNECESSARY
andx
is not a power of two
-
log10
@GwtIncompatible("TODO") public static int log10(long x, java.math.RoundingMode mode)
Returns the base-10 logarithm ofx
, rounded according to the specified rounding mode.- Throws:
java.lang.IllegalArgumentException
- ifx <= 0
java.lang.ArithmeticException
- ifmode
isRoundingMode.UNNECESSARY
andx
is not a power of ten
-
pow
@GwtIncompatible("TODO") public static long pow(long b, int k)
Returnsb
to thek
th power. Even if the result overflows, it will be equal toBigInteger.valueOf(b).pow(k).longValue()
. This implementation runs inO(log k)
time.- Throws:
java.lang.IllegalArgumentException
- ifk < 0
-
sqrt
@GwtIncompatible("TODO") public static long sqrt(long x, java.math.RoundingMode mode)
Returns the square root ofx
, rounded with the specified rounding mode.- Throws:
java.lang.IllegalArgumentException
- ifx < 0
java.lang.ArithmeticException
- ifmode
isRoundingMode.UNNECESSARY
andsqrt(x)
is not an integer
-
divide
@GwtIncompatible("TODO") public static long divide(long p, long q, java.math.RoundingMode mode)
Returns the result of dividingp
byq
, rounding using the specifiedRoundingMode
.- Throws:
java.lang.ArithmeticException
- ifq == 0
, or ifmode == UNNECESSARY
anda
is not an integer multiple ofb
-
mod
@GwtIncompatible("TODO") public static int mod(long 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
-
mod
@GwtIncompatible("TODO") public static long mod(long x, long 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 long gcd(long a, long b)
Returns the greatest common divisor ofa, b
. Returns0
ifa == 0 && b == 0
.- Throws:
java.lang.IllegalArgumentException
- ifa < 0
orb < 0
-
checkedAdd
@GwtIncompatible("TODO") public static long checkedAdd(long a, long b)
Returns the sum ofa
andb
, provided it does not overflow.- Throws:
java.lang.ArithmeticException
- ifa + b
overflows in signedlong
arithmetic
-
checkedSubtract
@GwtIncompatible("TODO") public static long checkedSubtract(long a, long b)
Returns the difference ofa
andb
, provided it does not overflow.- Throws:
java.lang.ArithmeticException
- ifa - b
overflows in signedlong
arithmetic
-
checkedMultiply
@GwtIncompatible("TODO") public static long checkedMultiply(long a, long b)
Returns the product ofa
andb
, provided it does not overflow.- Throws:
java.lang.ArithmeticException
- ifa * b
overflows in signedlong
arithmetic
-
checkedPow
@GwtIncompatible("TODO") public static long checkedPow(long b, int k)
Returns theb
to thek
th power, provided it does not overflow.- Throws:
java.lang.ArithmeticException
- ifb
to thek
th power overflows in signedlong
arithmetic
-
factorial
@GwtIncompatible("TODO") public static long factorial(int n)
Returnsn!
, that is, the product of the firstn
positive integers,1
ifn == 0
, orLong.MAX_VALUE
if the result does not fit in along
.- Throws:
java.lang.IllegalArgumentException
- ifn < 0
-
binomial
public static long binomial(int n, int k)
Returnsn
choosek
, also known as the binomial coefficient ofn
andk
, orLong.MAX_VALUE
if the result does not fit in along
.- Throws:
java.lang.IllegalArgumentException
- ifn < 0
,k < 0
, ork > n
-
mean
public static long mean(long x, long y)
Returns the arithmetic mean ofx
andy
, rounded toward negative infinity. This method is resilient to overflow.- Since:
- 14.0
-
-