archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 14:54:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8271225: Add floorDivExact() method to java.lang.[Strict]Math

Browse source 
Reviewed-by: darcy
This commit is contained in:
Brian Burkhalter 2021-08-31 14:42:14 +00:00
parent e67125512f
commit e551852801
3 changed files with 205 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

80
src/java.base/share/classes/java/lang/Math.java
View file

@ -1012,6 +1012,9 @@ public final class Math {
* <p>
* If {@code y} is zero, an {@code ArithmeticException} is thrown
* (JLS {@jls 15.17.2}).
* <p>
* The built-in remainder operator "{@code %}" is a suitable counterpart
* both for this method and for the built-in division operator "{@code /}".
*
* @param x the dividend
* @param y the divisor
@ -1039,6 +1042,9 @@ public final class Math {
* <p>
* If {@code y} is zero, an {@code ArithmeticException} is thrown
* (JLS {@jls 15.17.2}).
* <p>
* The built-in remainder operator "{@code %}" is a suitable counterpart
* both for this method and for the built-in division operator "{@code /}".
*
* @param x the dividend
* @param y the divisor
@ -1056,6 +1062,80 @@ public final class Math {
throw new ArithmeticException("long overflow");
}
/**
* Returns the largest (closest to positive infinity)
* {@code int} value that is less than or equal to the algebraic quotient.
* This method is identical to {@link #floorDiv(int,int)} except that it
* throws an {@code ArithmeticException} when the dividend is
* {@linkplain Integer#MIN_VALUE Integer.MIN_VALUE} and the divisor is
* {@code -1} instead of ignoring the integer overflow and returning
* {@code Integer.MIN_VALUE}.
* <p>
* The floor modulus method {@link #floorMod(int,int)} is a suitable
* counterpart both for this method and for the {@link #floorDiv(int,int)}
* method.
* <p>
* For examples, see {@link #floorDiv(int, int)}.
*
* @param x the dividend
* @param y the divisor
* @return the largest (closest to positive infinity)
* {@code int} value that is less than or equal to the algebraic quotient.
* @throws ArithmeticException if the divisor {@code y} is zero, or the
* dividend {@code x} is {@code Integer.MIN_VALUE} and the divisor {@code y}
* is {@code -1}.
* @see #floorDiv(int, int)
* @since 18
*/
public static int floorDivExact(int x, int y) {
int r = x / y;
if ((x & y & r) >= 0) {
// if the signs are different and modulo not zero, round down
if ((x ^ y) < 0 && (r * y != x)) {
r--;
}
return r;
}
throw new ArithmeticException("integer overflow");
}
/**
* Returns the largest (closest to positive infinity)
* {@code long} value that is less than or equal to the algebraic quotient.
* This method is identical to {@link #floorDiv(long,long)} except that it
* throws an {@code ArithmeticException} when the dividend is
* {@linkplain Long#MIN_VALUE Long.MIN_VALUE} and the divisor is
* {@code -1} instead of ignoring the integer overflow and returning
* {@code Long.MIN_VALUE}.
* <p>
* The floor modulus method {@link #floorMod(long,long)} is a suitable
* counterpart both for this method and for the {@link #floorDiv(long,long)}
* method.
* <p>
* For examples, see {@link #floorDiv(int, int)}.
*
* @param x the dividend
* @param y the divisor
* @return the largest (closest to positive infinity)
* {@code long} value that is less than or equal to the algebraic quotient.
* @throws ArithmeticException if the divisor {@code y} is zero, or the
* dividend {@code x} is {@code Long.MIN_VALUE} and the divisor {@code y}
* is {@code -1}.
* @see #floorDiv(long,long)
* @since 18
*/
public static long floorDivExact(long x, long y) {
long r = x / y;
if ((x & y & r) >= 0) {
// if the signs are different and modulo not zero, round down
if ((x ^ y) < 0 && (r * y != x)) {
r--;
}
return r;
}
throw new ArithmeticException("long overflow");
}
/**
* Returns the argument incremented by one, throwing an exception if the
* result overflows an {@code int}.