This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git
The following commit(s) were added to refs/heads/master by this push:
new 5d8d9e10 Correct private javadoc errors
5d8d9e10 is described below
commit 5d8d9e10d876d9a913a054154146f36a18490824
Author: Alex Herbert <[email protected]>
AuthorDate: Sun Sep 20 14:59:00 2026 +0100
Correct private javadoc errors
---
.../main/java/org/apache/commons/statistics/descriptive/Int128.java | 2 +-
.../org/apache/commons/statistics/descriptive/NaNTransformers.java | 2 +-
.../java/org/apache/commons/statistics/descriptive/Statistics.java | 4 ++--
.../apache/commons/statistics/distribution/ZipfDistribution.java | 6 +++---
.../java/org/apache/commons/statistics/inference/Hypergeom.java | 4 ++--
.../apache/commons/statistics/inference/UnconditionedExactTest.java | 4 ++--
6 files changed, 11 insertions(+), 11 deletions(-)
diff --git
a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Int128.java
b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Int128.java
index 4de742f0..e3951979 100644
---
a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Int128.java
+++
b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Int128.java
@@ -27,7 +27,7 @@ import org.apache.commons.numbers.core.DD;
*
* <p>Note: This number uses a signed long integer representation of:
*
- * <pre>value = 2<sup>64</sup> * hi64 + lo64</pre>
+ * <pre>value = 2^64 * hi64 + lo64</pre>
*
* <p>If the high value is zero then the low value is the long representation
of the
* number including the sign bit. Otherwise the low value corresponds to a
correction
diff --git
a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java
b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java
index 9efaf15c..d5e74211 100644
---
a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java
+++
b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/NaNTransformers.java
@@ -158,7 +158,7 @@ final class NaNTransformers {
/**
* Copy the specified range of data.
*
- * <p>This is a simplification of {@link Arrays#copyOfRange(double[], int,
int)}
+ * <p>This is a simplification of {@link
java.util.Arrays#copyOfRange(double[], int, int)}
* and does not support range checks or padding of the original input to
* a longer output.
*
diff --git
a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Statistics.java
b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Statistics.java
index 57b3378d..b368e4a0 100644
---
a/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Statistics.java
+++
b/commons-statistics-descriptive/src/main/java/org/apache/commons/statistics/descriptive/Statistics.java
@@ -501,7 +501,7 @@ final class Statistics {
/**
* Copy the specified range of data.
*
- * <p>This is a simplification of {@link Arrays#copyOfRange(int[], int,
int)}
+ * <p>This is a simplification of {@link
java.util.Arrays#copyOfRange(int[], int, int)}
* and does not support range checks or padding of the original input to
* a longer output.
*
@@ -520,7 +520,7 @@ final class Statistics {
/**
* Copy the specified range of data.
*
- * <p>This is a simplification of {@link Arrays#copyOfRange(long[], int,
int)}
+ * <p>This is a simplification of {@link
java.util.Arrays#copyOfRange(long[], int, int)}
* and does not support range checks or padding of the original input to
* a longer output.
*
diff --git
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
index 42ddc654..2e1bfb37 100644
---
a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
+++
b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ZipfDistribution.java
@@ -187,9 +187,9 @@ public final class ZipfDistribution extends
AbstractDiscreteDistribution {
* <p>Note: It should not be possible for the series summation to
exceed the N-th
* harmonic. This has been computed using a difference of zeta terms:
*
- * <pre>
+ * <pre>{@code
* zeta(s, a) - zeta(s, b+1) <= zeta(s, 1) - zeta(s, N+1) where a
>= 1 and b <= N
- * </pre>
+ * }</pre>
*
* <p>The zeta difference will only exceed the normalizing constant
due to
* floating-point error in the zeta function.
@@ -198,7 +198,7 @@ public final class ZipfDistribution extends
AbstractDiscreteDistribution {
* function. This may occur as the power terms approach zero
(sub-normal
* summation) when s or n are both large. Since n is bounded to an
integer the
* value is always suitable for evaluation of k^-s with k in integer
[1, n], i.e.
- * we never see 1 + n == n as n < 2^53. The only errors are expected
when s is
+ * we never see 1 + n == n as {@code n < 2^53}. The only errors are
expected when s is
* very large.
*
* @param x Value
diff --git
a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java
b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java
index 6592cf8c..2ed4a814 100644
---
a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java
+++
b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/Hypergeom.java
@@ -153,7 +153,7 @@ class Hypergeom {
* Compute the cumulative distribution function (CDF) at the specified
value.
*
* @param x Value.
- * @return P(X <= x)
+ * @return {@code P(X <= x)}
*/
double cdf(int x) {
if (x < lowerBound) {
@@ -175,7 +175,7 @@ class Hypergeom {
* cumulative distribution function.
*
* @param x Value.
- * @return P(X > x)
+ * @return {@code P(X > x)}
*/
double sf(int x) {
if (x < lowerBound) {
diff --git
a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java
b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java
index 1e4cbb96..9b455640 100644
---
a/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java
+++
b/commons-statistics-inference/src/main/java/org/apache/commons/statistics/inference/UnconditionedExactTest.java
@@ -1102,9 +1102,9 @@ public final class UnconditionedExactTest {
/**
* Add point 2 to the list of minima if neither neighbour value is lower.
- * <pre>
+ * <pre>{@code
* !(v1 < v2 || v3 < v2)
- * </pre>
+ * }</pre>
*
* @param minima Candidate minima.
* @param v1 First point function value.
