Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MATH-1629: Throw "ArithmeticException" instead of "MathArithmeticException".

This commit is contained in:
Gilles Sadowski 2021-09-29 01:42:46 +02:00
parent cb5f001821
commit 39c47671f2
3 changed files with 78 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
commons-math-legacy-core/src/main/java/org/apache/commons/math4/legacy/core/jdkmath/AccurateMath.java
View File

@ -19,8 +19,6 @@ package org.apache.commons.math4.legacy.core.jdkmath;
import java.io.PrintStream;
import org.apache.commons.numbers.core.Precision;
import org.apache.commons.math4.legacy.exception.MathArithmeticException;
import org.apache.commons.math4.legacy.exception.util.LocalizedFormats;
/**
* Portable alternative to {@link Math} and {@link StrictMath}.
@ -86,6 +84,10 @@ public final class AccurateMath {
/** Exponential fractions table length. */
static final int EXP_FRAC_TABLE_LEN = 1025; // 0, 1/1024, ... 1024/1024
/** Error message. */
private static final String ZERO_DENOMINATOR_MSG = "Division by zero";
/** Error message. */
private static final String OVERFLOW_MSG = "Overflow";
/** StrictMath.log(Double.MAX_VALUE): {@value}. */
private static final double LOG_MAX_VALUE = StrictMath.log(Double.MAX_VALUE);
@ -3729,12 +3731,13 @@ public final class AccurateMath {
/** Convert a long to integer, detecting overflows.
* @param n number to convert to int
* @return integer with same value as n if no overflows occur
* @exception MathArithmeticException if n cannot fit into an int
* @exception ArithmeticException if n cannot fit into an int
* @since 3.4
*/
public static int toIntExact(final long n) {
if (n < Integer.MIN_VALUE || n > Integer.MAX_VALUE) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW);
if (n < Integer.MIN_VALUE ||
n > Integer.MAX_VALUE) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return (int) n;
}
@ -3742,12 +3745,12 @@ public final class AccurateMath {
/** Increment a number, detecting overflows.
* @param n number to increment
* @return n+1 if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static int incrementExact(final int n) {
if (n == Integer.MAX_VALUE) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_ADDITION, n, 1);
throw new ArithmeticException(OVERFLOW_MSG);
}
return n + 1;
}
@ -3755,12 +3758,12 @@ public final class AccurateMath {
/** Increment a number, detecting overflows.
* @param n number to increment
* @return n+1 if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static long incrementExact(final long n) {
if (n == Long.MAX_VALUE) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_ADDITION, n, 1);
throw new ArithmeticException(OVERFLOW_MSG);
}
return n + 1;
}
@ -3768,12 +3771,12 @@ public final class AccurateMath {
/** Decrement a number, detecting overflows.
* @param n number to decrement
* @return n-1 if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static int decrementExact(final int n) {
if (n == Integer.MIN_VALUE) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_SUBTRACTION, n, 1);
throw new ArithmeticException(OVERFLOW_MSG);
}
return n - 1;
}
@ -3781,12 +3784,12 @@ public final class AccurateMath {
/** Decrement a number, detecting overflows.
* @param n number to decrement
* @return n-1 if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static long decrementExact(final long n) {
if (n == Long.MIN_VALUE) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_SUBTRACTION, n, 1);
throw new ArithmeticException(OVERFLOW_MSG);
}
return n - 1;
}
@ -3795,7 +3798,7 @@ public final class AccurateMath {
* @param a first number to add
* @param b second number to add
* @return a+b if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static int addExact(final int a, final int b) {
@ -3803,8 +3806,9 @@ public final class AccurateMath {
final int sum = a + b;
// check for overflow
if ((a ^ b) >= 0 && (sum ^ b) < 0) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_ADDITION, a, b);
if ((a ^ b) >= 0 &&
(sum ^ b) < 0) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return sum;
@ -3814,7 +3818,7 @@ public final class AccurateMath {
* @param a first number to add
* @param b second number to add
* @return a+b if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static long addExact(final long a, final long b) {
@ -3822,8 +3826,9 @@ public final class AccurateMath {
final long sum = a + b;
// check for overflow
if ((a ^ b) >= 0 && (sum ^ b) < 0) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_ADDITION, a, b);
if ((a ^ b) >= 0 &&
(sum ^ b) < 0) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return sum;
@ -3833,7 +3838,7 @@ public final class AccurateMath {
* @param a first number
* @param b second number to subtract from a
* @return a-b if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static int subtractExact(final int a, final int b) {
@ -3841,8 +3846,9 @@ public final class AccurateMath {
final int sub = a - b;
// check for overflow
if ((a ^ b) < 0 && (sub ^ b) >= 0) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_SUBTRACTION, a, b);
if ((a ^ b) < 0 &&
(sub ^ b) >= 0) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return sub;
@ -3852,7 +3858,7 @@ public final class AccurateMath {
* @param a first number
* @param b second number to subtract from a
* @return a-b if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static long subtractExact(final long a, final long b) {
@ -3860,8 +3866,9 @@ public final class AccurateMath {
final long sub = a - b;
// check for overflow
if ((a ^ b) < 0 && (sub ^ b) >= 0) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_SUBTRACTION, a, b);
if ((a ^ b) < 0 &&
(sub ^ b) >= 0) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return sub;
@ -3871,14 +3878,19 @@ public final class AccurateMath {
* @param a first number to multiply
* @param b second number to multiply
* @return a*b if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static int multiplyExact(final int a, final int b) {
if (((b > 0) && (a > Integer.MAX_VALUE / b || a < Integer.MIN_VALUE / b)) ||
((b < -1) && (a > Integer.MIN_VALUE / b || a < Integer.MAX_VALUE / b)) ||
((b == -1) && (a == Integer.MIN_VALUE))) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_MULTIPLICATION, a, b);
if (((b > 0) &&
(a > Integer.MAX_VALUE / b ||
a < Integer.MIN_VALUE / b)) ||
((b < -1) &&
(a > Integer.MIN_VALUE / b ||
a < Integer.MAX_VALUE / b)) ||
((b == -1) &&
(a == Integer.MIN_VALUE))) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return a * b;
}
@ -3887,14 +3899,19 @@ public final class AccurateMath {
* @param a first number to multiply
* @param b second number to multiply
* @return a*b if no overflows occur
* @exception MathArithmeticException if an overflow occurs
* @exception ArithmeticException if an overflow occurs
* @since 3.4
*/
public static long multiplyExact(final long a, final long b) {
if (((b > 0L) && (a > Long.MAX_VALUE / b || a < Long.MIN_VALUE / b)) ||
((b < -1L) && (a > Long.MIN_VALUE / b || a < Long.MAX_VALUE / b)) ||
((b == -1L) && (a == Long.MIN_VALUE))) {
throw new MathArithmeticException(LocalizedFormats.OVERFLOW_IN_MULTIPLICATION, a, b);
if (((b > 0L) &&
(a > Long.MAX_VALUE / b ||
a < Long.MIN_VALUE / b)) ||
((b < -1L) &&
(a > Long.MIN_VALUE / b ||
a < Long.MAX_VALUE / b)) ||
((b == -1L) &&
(a == Long.MIN_VALUE))) {
throw new ArithmeticException(OVERFLOW_MSG);
}
return a * b;
}
@ -3908,13 +3925,13 @@ public final class AccurateMath {
* @param a dividend
* @param b divisor
* @return q such that a = q b + r with 0 &lt;= r &lt; b if b &gt; 0 and b &lt; r &lt;= 0 if b &lt; 0
* @exception MathArithmeticException if b == 0
* @exception ArithmeticException if b == 0
* @see #floorMod(int, int)
* @since 3.4
*/
public static int floorDiv(final int a, final int b) {
if (b == 0) {
throw new MathArithmeticException(LocalizedFormats.ZERO_DENOMINATOR);
throw new ArithmeticException(ZERO_DENOMINATOR_MSG);
}
final int m = a % b;
@ -3936,13 +3953,13 @@ public final class AccurateMath {
* @param a dividend
* @param b divisor
* @return q such that a = q b + r with 0 &lt;= r &lt; b if b &gt; 0 and b &lt; r &lt;= 0 if b &lt; 0
* @exception MathArithmeticException if b == 0
* @exception ArithmeticException if b == 0
* @see #floorMod(long, long)
* @since 3.4
*/
public static long floorDiv(final long a, final long b) {
if (b == 0L) {
throw new MathArithmeticException(LocalizedFormats.ZERO_DENOMINATOR);
throw new ArithmeticException(ZERO_DENOMINATOR_MSG);
}
final long m = a % b;
@ -3964,13 +3981,13 @@ public final class AccurateMath {
* @param a dividend
* @param b divisor
* @return r such that a = q b + r with 0 &lt;= r &lt; b if b &gt; 0 and b &lt; r &lt;= 0 if b &lt; 0
* @exception MathArithmeticException if b == 0
* @exception ArithmeticException if b == 0
* @see #floorDiv(int, int)
* @since 3.4
*/
public static int floorMod(final int a, final int b) {
if (b == 0) {
throw new MathArithmeticException(LocalizedFormats.ZERO_DENOMINATOR);
throw new ArithmeticException(ZERO_DENOMINATOR_MSG);
}
final int m = a % b;
@ -3992,13 +4009,13 @@ public final class AccurateMath {
* @param a dividend
* @param b divisor
* @return r such that a = q b + r with 0 &lt;= r &lt; b if b &gt; 0 and b &lt; r &lt;= 0 if b &lt; 0
* @exception MathArithmeticException if b == 0
* @exception ArithmeticException if b == 0
* @see #floorDiv(long, long)
* @since 3.4
*/
public static long floorMod(final long a, final long b) {
if (b == 0L) {
throw new MathArithmeticException(LocalizedFormats.ZERO_DENOMINATOR);
throw new ArithmeticException(ZERO_DENOMINATOR_MSG);
}
final long m = a % b;

5
commons-math-legacy-core/src/test/java/org/apache/commons/math4/legacy/core/jdkmath/AccurateMathStrictComparisonTest.java
View File

@ -24,7 +24,6 @@ import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.commons.math4.legacy.exception.MathArithmeticException;
import org.apache.commons.numbers.core.Precision;
import org.junit.Assert;
import org.junit.Test;
@ -179,8 +178,8 @@ public class AccurateMathStrictComparisonTest {
actual = ite.getCause();
}
if (expected instanceof ArithmeticException) {
Assert.assertEquals(MathArithmeticException.class, actual.getClass());
} else if (!expected.equals(actual)) {
Assert.assertTrue(actual instanceof ArithmeticException);
} else if (!expected.equals(actual)) {
reportFailedResults(mathMethod, params, expected, actual, entries);
}
} catch (IllegalArgumentException e) {

33
commons-math-legacy-core/src/test/java/org/apache/commons/math4/legacy/core/jdkmath/AccurateMathTest.java
View File

@ -37,7 +37,6 @@ import org.apache.commons.numbers.core.Precision;
import org.apache.commons.math4.legacy.core.dfp.Dfp;
import org.apache.commons.math4.legacy.core.dfp.DfpField;
import org.apache.commons.math4.legacy.core.dfp.DfpMath;
import org.apache.commons.math4.legacy.exception.MathArithmeticException;
import org.apache.commons.rng.UniformRandomProvider;
import org.apache.commons.rng.simple.RandomSource;
@ -1585,7 +1584,7 @@ public class AccurateMathTest {
try {
AccurateMath.incrementExact(a);
Assert.fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1611,7 +1610,7 @@ public class AccurateMathTest {
try {
AccurateMath.decrementExact(a);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1639,7 +1638,7 @@ public class AccurateMathTest {
try {
AccurateMath.addExact(a, b);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1668,7 +1667,7 @@ public class AccurateMathTest {
try {
AccurateMath.addExact(a, b);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1697,7 +1696,7 @@ public class AccurateMathTest {
try {
AccurateMath.subtractExact(a, b);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1726,7 +1725,7 @@ public class AccurateMathTest {
try {
AccurateMath.subtractExact(a, b);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1755,7 +1754,7 @@ public class AccurateMathTest {
try {
AccurateMath.multiplyExact(a, b);
fail("an exception should have been thrown " + a + b);
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1784,7 +1783,7 @@ public class AccurateMathTest {
try {
AccurateMath.multiplyExact(a, b);
fail("an exception should have been thrown " + a + b);
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1794,12 +1793,12 @@ public class AccurateMathTest {
}
}
@Test(expected = MathArithmeticException.class)
@Test(expected = ArithmeticException.class)
public void testToIntExactTooLow() {
AccurateMath.toIntExact(-1L + Integer.MIN_VALUE);
}
@Test(expected = MathArithmeticException.class)
@Test(expected = ArithmeticException.class)
public void testToIntExactTooHigh() {
AccurateMath.toIntExact(+1L + Integer.MAX_VALUE);
}
@ -1822,7 +1821,7 @@ public class AccurateMathTest {
try {
AccurateMath.floorDiv(1, 0);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
for (int a = -100; a <= 100; ++a) {
@ -1843,7 +1842,7 @@ public class AccurateMathTest {
try {
AccurateMath.floorMod(1, 0);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
for (int a = -100; a <= 100; ++a) {
@ -1865,7 +1864,7 @@ public class AccurateMathTest {
try {
AccurateMath.floorDiv(a, b);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {
@ -1894,7 +1893,7 @@ public class AccurateMathTest {
try {
AccurateMath.floorDiv(1L, 0L);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
for (long a = -100L; a <= 100L; ++a) {
@ -1915,7 +1914,7 @@ public class AccurateMathTest {
try {
AccurateMath.floorMod(1L, 0L);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
for (long a = -100L; a <= 100L; ++a) {
@ -1937,7 +1936,7 @@ public class AccurateMathTest {
try {
AccurateMath.floorDiv(a, b);
fail("an exception should have been thrown");
} catch (MathArithmeticException mae) {
} catch (ArithmeticException mae) {
// expected
}
} else {