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 2021/12/17 21:46:20 UTC
[commons-statistics] 04/05: Update javadoc for mean and variance
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 56b10747d553aeff6a8c7203851df0db4c8ff07d
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Fri Dec 17 20:31:25 2021 +0000
Update javadoc for mean and variance
Remove the statement 'or {@code Double.NaN} if it is not defined'.
This only applies to a few distributions. These distributions have been
updated to state they return NaN if the mean/variance is undefined.
This change prevents all distributions inheriting the javadoc and having
to override the return tag to state the mean/variance is finite.
---
.../commons/statistics/distribution/CauchyDistribution.java | 4 ++--
.../statistics/distribution/ContinuousDistribution.java | 4 ++--
.../commons/statistics/distribution/DiscreteDistribution.java | 4 ++--
.../apache/commons/statistics/distribution/FDistribution.java | 8 ++++++--
.../apache/commons/statistics/distribution/TDistribution.java | 10 +++++++---
5 files changed, 19 insertions(+), 11 deletions(-)
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
index 33603e6..35f11e5 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/CauchyDistribution.java
@@ -156,7 +156,7 @@ public final class CauchyDistribution extends AbstractContinuousDistribution {
*
* <p>The mean is always undefined no matter the parameters.
*
- * @return mean (always Double.NaN)
+ * @return NaN
*/
@Override
public double getMean() {
@@ -168,7 +168,7 @@ public final class CauchyDistribution extends AbstractContinuousDistribution {
*
* <p>The variance is always undefined no matter the parameters.
*
- * @return variance (always Double.NaN)
+ * @return NaN
*/
@Override
public double getVariance() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
index 7391d2b..781fea5 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ContinuousDistribution.java
@@ -138,14 +138,14 @@ public interface ContinuousDistribution {
/**
* Gets the mean of this distribution.
*
- * @return the mean, or {@code Double.NaN} if it is not defined.
+ * @return the mean.
*/
double getMean();
/**
* Gets the variance of this distribution.
*
- * @return the variance, or {@code Double.NaN} if it is not defined.
+ * @return the variance.
*/
double getVariance();
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
index a96ce86..6215ff4 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DiscreteDistribution.java
@@ -155,14 +155,14 @@ public interface DiscreteDistribution {
/**
* Gets the mean of this distribution.
*
- * @return the mean, or {@code Double.NaN} if it is not defined.
+ * @return the mean.
*/
double getMean();
/**
* Gets the variance of this distribution.
*
- * @return the variance, or {@code Double.NaN} if it is not defined.
+ * @return the variance.
*/
double getVariance();
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java
index 1a39bd4..942ca90 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/FDistribution.java
@@ -211,8 +211,10 @@ public final class FDistribution extends AbstractContinuousDistribution {
* <p>For denominator degrees of freedom parameter {@code b}, the mean is
* <ul>
* <li>if {@code b > 2} then {@code b / (b - 2)},</li>
- * <li>else undefined ({@code Double.NaN}).
+ * <li>else undefined ({@code NaN}).
* </ul>
+ *
+ * @return the mean, or {@code NaN} if it is not defined.
*/
@Override
public double getMean() {
@@ -235,8 +237,10 @@ public final class FDistribution extends AbstractContinuousDistribution {
* if {@code b > 4} then
* {@code [2 * b^2 * (a + b - 2)] / [a * (b - 2)^2 * (b - 4)]},
* </li>
- * <li>else undefined ({@code Double.NaN}).
+ * <li>else undefined ({@code NaN}).
* </ul>
+ *
+ * @return the variance, or {@code NaN} if it is not defined.
*/
@Override
public double getVariance() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java
index d810509..299f18e 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TDistribution.java
@@ -208,8 +208,10 @@ public abstract class TDistribution extends AbstractContinuousDistribution {
* <p>For degrees of freedom parameter {@code df}, the mean is
* <ul>
* <li>zero if {@code df > 1}, and</li>
- * <li>undefined ({@code Double.NaN}) otherwise.</li>
+ * <li>undefined ({@code NaN}) otherwise.</li>
* </ul>
+ *
+ * @return the mean, or {@code NaN} if it is not defined.
*/
@Override
public double getMean() {
@@ -222,9 +224,11 @@ public abstract class TDistribution extends AbstractContinuousDistribution {
* <p>For degrees of freedom parameter {@code df}, the variance is
* <ul>
* <li>{@code df / (df - 2)} if {@code df > 2},</li>
- * <li>infinite ({@code Double.POSITIVE_INFINITY}) if {@code 1 < df <= 2}, and</li>
- * <li>undefined ({@code Double.NaN}) otherwise.</li>
+ * <li>positive infinity if {@code 1 < df <= 2}, and</li>
+ * <li>undefined ({@code NaN}) otherwise.</li>
* </ul>
+ *
+ * @return the mean, or {@code NaN} if it is not defined.
*/
@Override
public double getVariance() {