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

8241374: add Math.absExact

Browse source 
Reviewed-by: smarks, chegar, bpb
This commit is contained in:
Joe Darcy 2020-03-30 13:49:02 -07:00
parent b7439a8ae3
commit 916f00acc1
3 changed files with 269 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,5 +1,5 @@
/*
* Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1994, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -1355,37 +1355,93 @@ public final class Math {
* If the argument is not negative, the argument is returned.
* If the argument is negative, the negation of the argument is returned.
*
* <p>Note that if the argument is equal to the value of
* {@link Integer#MIN_VALUE}, the most negative representable
* {@code int} value, the result is that same value, which is
* negative.
* <p>Note that if the argument is equal to the value of {@link
* Integer#MIN_VALUE}, the most negative representable {@code int}
* value, the result is that same value, which is negative. In
* contrast, the {@link Math#absExact(int)} method throws an
* {@code ArithmeticException} for this value.
*
* @param a the argument whose absolute value is to be determined
* @return the absolute value of the argument.
* @see Math#absExact(int)
*/
@HotSpotIntrinsicCandidate
public static int abs(int a) {
return (a < 0) ? -a : a;
}
/**
* Returns the mathematical absolute value of an {@code int} value
* if it is exactly representable as an {@code int}, throwing
* {@code ArithmeticException} if the result overflows the
* positive {@code int} range.
*
* <p>Since the range of two's complement integers is asymmetric
* with one additional negative value (JLS {@jls 4.2.1}), the
* mathematical absolute value of {@link Integer#MIN_VALUE}
* overflows the positive {@code int} range, so an exception is
* thrown for that argument.
*
* @param a the argument whose absolute value is to be determined
* @return the absolute value of the argument, unless overflow occurs
* @throws ArithmeticException if the argument is {@link Integer#MIN_VALUE}
* @see Math#abs(int)
* @since 15
*/
public static int absExact(int a) {
if (a == Integer.MIN_VALUE)
throw new ArithmeticException(
"Overflow to represent absolute value of Integer.MIN_VALUE");
else
return abs(a);
}
/**
* Returns the absolute value of a {@code long} value.
* If the argument is not negative, the argument is returned.
* If the argument is negative, the negation of the argument is returned.
*
* <p>Note that if the argument is equal to the value of
* {@link Long#MIN_VALUE}, the most negative representable
* {@code long} value, the result is that same value, which
* is negative.
* <p>Note that if the argument is equal to the value of {@link
* Long#MIN_VALUE}, the most negative representable {@code long}
* value, the result is that same value, which is negative. In
* contrast, the {@link Math#absExact(long)} method throws an
* {@code ArithmeticException} for this value.
*
* @param a the argument whose absolute value is to be determined
* @return the absolute value of the argument.
* @see Math#absExact(long)
*/
@HotSpotIntrinsicCandidate
public static long abs(long a) {
return (a < 0) ? -a : a;
}
/**
* Returns the mathematical absolute value of an {@code long} value
* if it is exactly representable as an {@code long}, throwing
* {@code ArithmeticException} if the result overflows the
* positive {@code long} range.
*
* <p>Since the range of two's complement integers is asymmetric
* with one additional negative value (JLS {@jls 4.2.1}), the
* mathematical absolute value of {@link Long#MIN_VALUE} overflows
* the positive {@code long} range, so an exception is thrown for
* that argument.
*
* @param a the argument whose absolute value is to be determined
* @return the absolute value of the argument, unless overflow occurs
* @throws ArithmeticException if the argument is {@link Long#MIN_VALUE}
* @see Math#abs(long)
* @since 15
*/
public static long absExact(long a) {
if (a == Long.MIN_VALUE)
throw new ArithmeticException(
"Overflow to represent absolute value of Long.MIN_VALUE");
else
return abs(a);
}
/**
* Returns the absolute value of a {@code float} value.
* If the argument is not negative, the argument is returned.

66
src/java.base/share/classes/java/lang/StrictMath.java
View file

@ -1124,35 +1124,85 @@ public final class StrictMath {
* If the argument is not negative, the argument is returned.
* If the argument is negative, the negation of the argument is returned.
*
* <p>Note that if the argument is equal to the value of
* {@link Integer#MIN_VALUE}, the most negative representable
* {@code int} value, the result is that same value, which is
* negative.
* <p>Note that if the argument is equal to the value of {@link
* Integer#MIN_VALUE}, the most negative representable {@code int}
* value, the result is that same value, which is negative. In
* contrast, the {@link StrictMath#absExact(int)} method throws an
* {@code ArithmeticException} for this value.
*
* @param a the argument whose absolute value is to be determined.
* @return the absolute value of the argument.
* @see Math#absExact(int)
*/
public static int abs(int a) {
return Math.abs(a);
}
/**
* Returns the mathematical absolute value of an {@code int} value
* if it is exactly representable as an {@code int}, throwing
* {@code ArithmeticException} if the result overflows the
* positive {@code int} range.
*
* <p>Since the range of two's complement integers is asymmetric
* with one additional negative value (JLS {@jls 4.2.1}), the
* mathematical absolute value of {@link Integer#MIN_VALUE}
* overflows the positive {@code int} range, so an exception is
* thrown for that argument.
*
* @param a the argument whose absolute value is to be determined
* @return the absolute value of the argument, unless overflow occurs
* @throws ArithmeticException if the argument is {@link Integer#MIN_VALUE}
* @see Math#abs(int)
* @see Math#absExact(int)
* @since 15
*/
public static int absExact(int a) {
return Math.absExact(a);
}
/**
* Returns the absolute value of a {@code long} value.
* If the argument is not negative, the argument is returned.
* If the argument is negative, the negation of the argument is returned.
*
* <p>Note that if the argument is equal to the value of
* {@link Long#MIN_VALUE}, the most negative representable
* {@code long} value, the result is that same value, which
* is negative.
* <p>Note that if the argument is equal to the value of {@link
* Long#MIN_VALUE}, the most negative representable {@code long}
* value, the result is that same value, which is negative. In
* contrast, the {@link StrictMath#absExact(long)} method throws
* an {@code ArithmeticException} for this value.
*
* @param a the argument whose absolute value is to be determined.
* @return the absolute value of the argument.
* @see Math#absExact(long)
*/
public static long abs(long a) {
return Math.abs(a);
}
/**
* Returns the mathematical absolute value of an {@code long} value
* if it is exactly representable as an {@code long}, throwing
* {@code ArithmeticException} if the result overflows the
* positive {@code long} range.
*
* <p>Since the range of two's complement integers is asymmetric
* with one additional negative value (JLS {@jls 4.2.1}), the
* mathematical absolute value of {@link Long#MIN_VALUE} overflows
* the positive {@code long} range, so an exception is thrown for
* that argument.
*
* @param a the argument whose absolute value is to be determined
* @return the absolute value of the argument, unless overflow occurs
* @throws ArithmeticException if the argument is {@link Long#MIN_VALUE}
* @see Math#abs(long)
* @see Math#absExact(long)
* @since 15
*/
public static long absExact(long a) {
return Math.absExact(a);
}
/**
* Returns the absolute value of a {@code float} value.
* If the argument is not negative, the argument is returned.