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-statistics.git
commit 7239736fdab9864666b216f966e6bd9a53ccf78e
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Sat Dec 23 10:27:46 2023 +0000
Correct javadoc in tests
---
.../descriptive/BaseDoubleStatisticTest.java | 36 +++++++++++-----------
.../descriptive/DoubleStatisticsTest.java | 2 +-
2 files changed, 19 insertions(+), 19 deletions(-)
diff --git
a/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/BaseDoubleStatisticTest.java
b/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/BaseDoubleStatisticTest.java
index a349e2f..8de8b44 100644
---
a/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/BaseDoubleStatisticTest.java
+++
b/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/BaseDoubleStatisticTest.java
@@ -51,10 +51,10 @@ import org.junit.jupiter.params.provider.MethodSource;
* <ol>
* <li>{@link java.util.function.DoubleConsumer#accept accept}
* <li>{@link java.util.function.DoubleConsumer#accept accept} and
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine}
+ * {@link StatisticAccumulator#combine(StatisticResult) combine}
* <li>{@link #create(double...)}
* <li>{@link #create(double...)} and
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine}
+ * {@link StatisticAccumulator#combine(StatisticResult) combine}
* </ol>
*
* <p>A test implementation has to provide these method implementations:
@@ -547,7 +547,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Returns {@code true} if the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine}
+ * {@link StatisticAccumulator#combine(StatisticResult) combine}
* method is symmetric. If {@code true} then the combine will be tested
with
* duplicate instances of the statistic, combined in left-to-right and
right-to-left;
* the result must have the same statistic value.
@@ -740,10 +740,10 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
* <ol>
* <li>{@link java.util.function.DoubleConsumer#accept accept}
* <li>{@link java.util.function.DoubleConsumer#accept accept} and
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine}
+ * {@link StatisticAccumulator#combine(StatisticResult) combine}
* <li>{@link #create(double...)}
* <li>{@link #create(double...)} and
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine}
+ * {@link StatisticAccumulator#combine(StatisticResult) combine}
* </ol>
*
* <p>To test the {@code combine} method the data is split into
approximately even groups
@@ -822,7 +822,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Stream the arguments to test the computation of the statistic using the
* {@link java.util.function.DoubleConsumer#accept(double) accept} method
for each
- * array, then the {@link StatisticAccumulator#combine(DoubleStatistic)
combine}
+ * array, then the {@link StatisticAccumulator#combine(StatisticResult)
combine}
* method. The expected value and tolerance are supplied by the
implementing class.
*
* @return the stream
@@ -834,7 +834,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Stream the arguments to test the computation of the statistic using the
* {@link #create(double...)} method for each array, then the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method.
The
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method.
The
* expected value and tolerance are supplied by the implementing class.
*
* @return the stream
@@ -847,7 +847,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
* Stream the arguments to test the computation of the statistic using the
* {@link java.util.function.DoubleConsumer#accept(double) accept} method
for each
* element of a parallel stream, then the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method.
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method.
* The expected value and tolerance are supplied by the implementing class.
*
* <p>Note that this method uses the tolerance from {@link
#getToleranceAcceptAndCombine()}.
@@ -861,7 +861,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Stream the arguments to test the computation of the statistic using the
multiple
* {@code double[]} arrays and the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method.
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method.
*
* @param tol Test tolerance.
* @param tolCustom Tolerance for any custom test data.
@@ -1015,7 +1015,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Test the computation of the statistic using the
* {@link java.util.function.DoubleConsumer#accept(double) accept} method
for each
- * array, then the {@link StatisticAccumulator#combine(DoubleStatistic)
combine}
+ * array, then the {@link StatisticAccumulator#combine(StatisticResult)
combine}
* method.
*/
@ParameterizedTest
@@ -1027,7 +1027,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Test the computation of the statistic using the
* {@link java.util.function.DoubleConsumer#accept(double) accept} method
for each
- * array, then the {@link StatisticAccumulator#combine(DoubleStatistic)
combine}
+ * array, then the {@link StatisticAccumulator#combine(StatisticResult)
combine}
* method.
*/
@ParameterizedTest
@@ -1037,7 +1037,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
}
/**
- * Test the {@link StatisticAccumulator#combine(DoubleStatistic) combine}
method
+ * Test the {@link StatisticAccumulator#combine(StatisticResult) combine}
method
* with an empty instance combined with a non-empty instance.
*/
@ParameterizedTest
@@ -1052,7 +1052,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
}
/**
- * Test the {@link StatisticAccumulator#combine(DoubleStatistic) combine}
method
+ * Test the {@link StatisticAccumulator#combine(StatisticResult) combine}
method
* with a non-empty instance combined with an empty instance.
*/
@ParameterizedTest
@@ -1070,7 +1070,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
* Test the computation of the statistic using a parallel stream of {@code
double}
* values. The accumulator is the
* {@link java.util.function.DoubleConsumer#accept(double) accept} method;
the
- * combiner is the {@link StatisticAccumulator#combine(DoubleStatistic)
combine}
+ * combiner is the {@link StatisticAccumulator#combine(StatisticResult)
combine}
* method.
*
* <p>Note: This method is similar to the
@@ -1095,7 +1095,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
* Test the computation of the statistic using a parallel stream of {@code
double[]}
* arrays. The arrays are mapped to a statistic using the {@link
#create(double...)}
* method, and the stream reduced using the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method.
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method.
*
* <p>Note: This method is similar to the
* {@link #testArrayAndCombine(double[][], double, DoubleTolerance)}
method and uses
@@ -1205,7 +1205,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Test the computation of the statistic using an empty instance and the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method
with
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method
with
* instances containing single values. Adding statistic instances
containing 1 value
* should be the same precision as adding a {@code double} value, although
the two
* results are not required to be exactly equal.
@@ -1240,7 +1240,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Assert the computation of the statistic using the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method.
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method.
*
* @param constructor Function to create the statistic.
* @param values Values.
@@ -1319,7 +1319,7 @@ abstract class BaseDoubleStatisticTest<S extends
DoubleStatistic & StatisticAccu
/**
* Combine the two statistics. This method asserts the contract of the
- * {@link StatisticAccumulator#combine(DoubleStatistic) combine} method.
+ * {@link StatisticAccumulator#combine(StatisticResult) combine} method.
* The left-hand side (LHS) argument must be returned. The right-hand side
(RHS) must
* be unchanged by the operation.
*
diff --git
a/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/DoubleStatisticsTest.java
b/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/DoubleStatisticsTest.java
index 576e435..a73d855 100644
---
a/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/DoubleStatisticsTest.java
+++
b/commons-statistics-descriptive/src/test/java/org/apache/commons/statistics/descriptive/DoubleStatisticsTest.java
@@ -68,7 +68,7 @@ class DoubleStatisticsTest {
private final int id;
/** The sample values. */
private final double[][] values;
- /* The number of values. */
+ /** The number of values. */
private final long size;
/**
