You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2023/04/03 19:49:43 UTC
[commons-numbers] branch master updated: Correct package-private javadoc
This is an automated email from the ASF dual-hosted git repository.
aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-numbers.git
The following commit(s) were added to refs/heads/master by this push:
new b0fa60c7 Correct package-private javadoc
b0fa60c7 is described below
commit b0fa60c7f489be8a8b301adf2761af2a3accb061
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Mon Apr 3 20:49:31 2023 +0100
Correct package-private javadoc
---
.../commons/numbers/combinatorics/BinomialCoefficient.java | 6 +++---
.../numbers/combinatorics/BinomialCoefficientDouble.java | 2 +-
.../commons/numbers/combinatorics/LogBinomialCoefficient.java | 2 +-
.../org/apache/commons/numbers/combinatorics/LogFactorial.java | 2 +-
.../main/java/org/apache/commons/numbers/complex/Complex.java | 2 +-
.../org/apache/commons/numbers/core/ExtendedPrecision.java | 4 ++--
.../commons/numbers/fraction/GeneralizedContinuedFraction.java | 2 +-
.../main/java/org/apache/commons/numbers/gamma/BoostGamma.java | 4 ++--
.../main/java/org/apache/commons/numbers/gamma/BoostTools.java | 10 +++++-----
9 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficient.java b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficient.java
index 807b4270..0d09ce32 100644
--- a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficient.java
+++ b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficient.java
@@ -27,13 +27,13 @@ import org.apache.commons.numbers.core.ArithmeticUtils;
*/
public final class BinomialCoefficient {
/** The maximum m that can be computed without overflow of a long.
- * C(68, 34) > 2^63. */
+ * {@code C(68, 34) > 2^63}. */
private static final int MAX_M = 33;
/** The maximum n that can be computed without intermediate overflow for any m.
- * C(61, 30) * 30 < 2^63. */
+ * {@code C(61, 30) * 30 < 2^63}. */
private static final int SMALL_N = 61;
/** The maximum n that can be computed without overflow of a long for any m.
- * C(66, 33) < 2^63. */
+ * {@code C(66, 33) < 2^63}. */
private static final int LIMIT_N = 66;
/** Private constructor. */
diff --git a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficientDouble.java b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficientDouble.java
index bdcc0597..e1d10b11 100644
--- a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficientDouble.java
+++ b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/BinomialCoefficientDouble.java
@@ -27,7 +27,7 @@ public final class BinomialCoefficientDouble {
/** The maximum factorial that can be represented as a double. */
private static final int MAX_FACTORIAL = 170;
/** The maximum n that can be computed without overflow of a long for any m.
- * C(66, 33) < 2^63. */
+ * {@code C(66, 33) < 2^63}. */
private static final int LIMIT_N_LONG = 66;
/** The maximum m that can be computed without overflow of a double.
* C(1030, 515) ~ 2.85e308. */
diff --git a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogBinomialCoefficient.java b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogBinomialCoefficient.java
index e398f4e7..66192c73 100644
--- a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogBinomialCoefficient.java
+++ b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogBinomialCoefficient.java
@@ -27,7 +27,7 @@ import org.apache.commons.numbers.gamma.LogBeta;
*/
public final class LogBinomialCoefficient {
/** The maximum n that can be computed without overflow of a long for any m.
- * C(66, 33) < 2^63. */
+ * {@code C(66, 33) < 2^63}. */
private static final int LIMIT_N_LONG = 66;
/** The maximum n that can be computed without overflow of a double for an m.
* C(1029, 514) ~ 1.43e308. */
diff --git a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogFactorial.java b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogFactorial.java
index 6182fe75..38e0669e 100644
--- a/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogFactorial.java
+++ b/commons-numbers-combinatorics/src/main/java/org/apache/commons/numbers/combinatorics/LogFactorial.java
@@ -41,7 +41,7 @@ public final class LogFactorial {
*
* @param numValues Number of values of the function to compute.
* @param cache Cached values.
- * @throw IllegalArgumentException if {@code n < 0}.
+ * @throws IllegalArgumentException if {@code n < 0}.
*/
private LogFactorial(int numValues,
double[] cache) {
diff --git a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
index b6f5b32e..6ac570ce 100644
--- a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
+++ b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
@@ -187,7 +187,7 @@ public final class Complex implements Serializable {
private static final double SAFE_EXP = 708;
/**
* The value of Math.exp(SAFE_EXP): e^708.
- * To be used in overflow/underflow safe products of e^m to approximate e^x where x > m.
+ * To be used in overflow/underflow safe products of e^m to approximate e^x where {@code x > m}.
*/
private static final double EXP_M = Math.exp(SAFE_EXP);
diff --git a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ExtendedPrecision.java b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ExtendedPrecision.java
index b60c35b3..e74d88d2 100644
--- a/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ExtendedPrecision.java
+++ b/commons-numbers-core/src/main/java/org/apache/commons/numbers/core/ExtendedPrecision.java
@@ -159,10 +159,10 @@ final class ExtendedPrecision {
/**
* Checks if the number is not normal. This is functionally equivalent to:
- * <pre>
+ * <pre>{@code
* final double abs = Math.abs(a);
* return (abs <= Double.MIN_NORMAL || !(abs <= Double.MAX_VALUE));
- * </pre>
+ * }</pre>
*
* @param a The value.
* @return true if the value is not normal
diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java
index b55be1f1..61cd735a 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/GeneralizedContinuedFraction.java
@@ -451,7 +451,7 @@ public final class GeneralizedContinuedFraction {
/**
* Returns the value, or if close to zero returns a small epsilon of the same sign.
*
- * <p>This method is used in Thompson & Barnett to monitor both the numerator and denominator
+ * <p>This method is used in Thompson & Barnett to monitor both the numerator and denominator
* ratios for approaches to zero.
*
* @param value the value
diff --git a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostGamma.java b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostGamma.java
index 4607bb94..6ae16914 100644
--- a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostGamma.java
+++ b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostGamma.java
@@ -1516,7 +1516,7 @@ final class BoostGamma {
/**
* Upper gamma fraction for integer a.
- * Called when a < 30 and -x > LOG_MIN_VALUE.
+ * Called when {@code a < 30} and {@code -x > LOG_MIN_VALUE}.
*
* @param a Argument a (assumed to be small)
* @param x Argument x
@@ -1542,7 +1542,7 @@ final class BoostGamma {
/**
* Upper gamma fraction for half integer a.
- * Called when a < 30 and -x > LOG_MIN_VALUE.
+ * Called when {@code a < 30} and {@code -x > LOG_MIN_VALUE}.
*
* @param a Argument a (assumed to be small)
* @param x Argument x
diff --git a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostTools.java b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostTools.java
index 506adc9e..3e3bac5a 100644
--- a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostTools.java
+++ b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/BoostTools.java
@@ -41,14 +41,14 @@ final class BoostTools {
* <p>The summation will terminate when any additional terms are too small to
* change the sum. Assuming additional terms are reducing in magnitude this
* occurs when the term is 1 ULP from the sum:
- * <pre>
+ * <pre>{@code
* ulp(sum) >= term
- * </pre>
+ * }</pre>
*
* <p>The epsilon is used to set a configurable threshold using:
- * <pre>
+ * <pre>{@code
* sum * eps >= term
- * </pre>
+ * }</pre>
* <p>The minimum epsilon is the smallest value that will create a value
* {@code >= 1} ULP and {@code < 2} ULP of the sum. For any normal number the ULP
* of all values with the same exponent b is scalb(1.0, b - 52). This can
@@ -225,7 +225,7 @@ final class BoostTools {
* f(x) = c[3] * x^3 + c[2] * x^2 + c[1] * x + c[0]
* </pre>
*
- * @param c Polynomial coefficients (must have length > 0)
+ * @param c Polynomial coefficients (must have {@code length > 0})
* @param x Argument x
* @return polynomial value
*/