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:21 UTC
[commons-statistics] 05/05: Consistent javadoc for the lower/upper bounds/mean/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 b525a546d2ebedc059f0cb5aad8d5d1d38103e01
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Fri Dec 17 21:41:08 2021 +0000
Consistent javadoc for the lower/upper bounds/mean/variance
If the bounds are defined for all parameters then put this value in the
return statement.
---
.../statistics/distribution/BetaDistribution.java | 8 ++++----
.../statistics/distribution/BinomialDistribution.java | 4 ++--
.../statistics/distribution/CauchyDistribution.java | 18 ++++++++----------
.../distribution/ChiSquaredDistribution.java | 10 ++++------
.../distribution/ExponentialDistribution.java | 16 +++++-----------
.../commons/statistics/distribution/FDistribution.java | 9 ++++-----
.../statistics/distribution/GammaDistribution.java | 11 ++++-------
.../statistics/distribution/GeometricDistribution.java | 4 ++--
.../statistics/distribution/GumbelDistribution.java | 12 ++++--------
.../statistics/distribution/LaplaceDistribution.java | 12 ++++--------
.../statistics/distribution/LevyDistribution.java | 12 +++++++-----
.../statistics/distribution/LogNormalDistribution.java | 10 ++++------
.../statistics/distribution/LogisticDistribution.java | 12 ++++--------
.../statistics/distribution/NakagamiDistribution.java | 10 ++++------
.../statistics/distribution/NormalDistribution.java | 12 ++++--------
.../statistics/distribution/ParetoDistribution.java | 6 +++---
.../statistics/distribution/PascalDistribution.java | 6 +++---
.../statistics/distribution/PoissonDistribution.java | 11 ++++-------
.../commons/statistics/distribution/TDistribution.java | 8 +++-----
.../distribution/TriangularDistribution.java | 4 ----
.../distribution/TruncatedNormalDistribution.java | 14 ++++++++++++--
.../distribution/UniformContinuousDistribution.java | 4 ----
.../distribution/UniformDiscreteDistribution.java | 4 ----
.../statistics/distribution/WeibullDistribution.java | 10 ++++------
.../statistics/distribution/ZipfDistribution.java | 6 +++---
25 files changed, 96 insertions(+), 137 deletions(-)
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java
index 0c08cbc..cbde35c 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BetaDistribution.java
@@ -202,9 +202,9 @@ public final class BetaDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -214,9 +214,9 @@ public final class BetaDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always 1 no matter the parameters.
+ * <p>The upper bound of the support is always 1.
*
- * @return upper bound of the support (always 1)
+ * @return 1.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java
index 766d8f5..54607b6 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/BinomialDistribution.java
@@ -162,7 +162,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution {
* <p>The lower bound of the support is always 0 except for the probability
* parameter {@code p = 1}.
*
- * @return lower bound of the support (0 or the number of trials)
+ * @return 0 or the number of trials.
*/
@Override
public int getSupportLowerBound() {
@@ -175,7 +175,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution {
* <p>The upper bound of the support is the number of trials except for the
* probability parameter {@code p = 0}.
*
- * @return upper bound of the support (number of trials or 0)
+ * @return number of trials or 0.
*/
@Override
public int getSupportUpperBound() {
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 35f11e5..2abf7f5 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
@@ -154,9 +154,9 @@ public final class CauchyDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The mean is always undefined no matter the parameters.
+ * <p>The mean is always undefined.
*
- * @return NaN
+ * @return NaN.
*/
@Override
public double getMean() {
@@ -166,9 +166,9 @@ public final class CauchyDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The variance is always undefined no matter the parameters.
+ * <p>The variance is always undefined.
*
- * @return NaN
+ * @return NaN.
*/
@Override
public double getVariance() {
@@ -178,10 +178,9 @@ public final class CauchyDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always negative infinity no matter
- * the parameters.
+ * <p>The lower bound of the support is always negative infinity.
*
- * @return lower bound of the support (always Double.NEGATIVE_INFINITY)
+ * @return negative infinity.
*/
@Override
public double getSupportLowerBound() {
@@ -191,10 +190,9 @@ public final class CauchyDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity no matter
- * the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always Double.POSITIVE_INFINITY)
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java
index a768ecd..5e11d74 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ChiSquaredDistribution.java
@@ -138,10 +138,9 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the
- * degrees of freedom.
+ * <p>The lower bound of the support is always 0.
*
- * @return zero.
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -151,10 +150,9 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity no matter the
- * degrees of freedom.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return {@code Double.POSITIVE_INFINITY}.
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
index 1709fce..a4ba8b9 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExponentialDistribution.java
@@ -138,11 +138,7 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio
return 0 - mean * Math.log(p);
}
- /**
- * {@inheritDoc}
- *
- * @return the mean
- */
+ /** {@inheritDoc} */
@Override
public double getMean() {
return mean;
@@ -152,7 +148,6 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio
* {@inheritDoc}
*
* <p>For mean {@code k}, the variance is {@code k^2}.
- * @return the variance
*/
@Override
public double getVariance() {
@@ -162,9 +157,9 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the mean parameter.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -174,10 +169,9 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the mean parameter.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always Double.POSITIVE_INFINITY)
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
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 942ca90..e1b8ca1 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
@@ -260,9 +260,9 @@ public final class FDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -272,10 +272,9 @@ public final class FDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always Double.POSITIVE_INFINITY)
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java
index cfe4ab9..b1c173a 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GammaDistribution.java
@@ -205,8 +205,6 @@ public final class GammaDistribution extends AbstractContinuousDistribution {
*
* <p>For shape parameter {@code alpha} and scale parameter {@code beta}, the
* variance is {@code alpha * beta^2}.
- *
- * @return {@inheritDoc}
*/
@Override
public double getVariance() {
@@ -216,9 +214,9 @@ public final class GammaDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -228,10 +226,9 @@ public final class GammaDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always Double.POSITIVE_INFINITY)
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
index f9ed53b..251ebea 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GeometricDistribution.java
@@ -229,7 +229,7 @@ public final class GeometricDistribution extends AbstractDiscreteDistribution {
*
* <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public int getSupportLowerBound() {
@@ -242,7 +242,7 @@ public final class GeometricDistribution extends AbstractDiscreteDistribution {
* <p>The upper bound of the support is positive infinity except for the
* probability parameter {@code p = 1.0}.
*
- * @return upper bound of the support ({@code Integer.MAX_VALUE} or 0)
+ * @return {@code Integer.MAX_VALUE} or 0.
*/
@Override
public int getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java
index decdc2e..ca7f549 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/GumbelDistribution.java
@@ -182,11 +182,9 @@ public final class GumbelDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always negative infinity
- * no matter the parameters.
+ * <p>The lower bound of the support is always negative infinity.
*
- * @return lower bound of the support (always
- * {@code Double.NEGATIVE_INFINITY})
+ * @return negative infinity.
*/
@Override
public double getSupportLowerBound() {
@@ -196,11 +194,9 @@ public final class GumbelDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java
index 5201355..f115bc4 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LaplaceDistribution.java
@@ -163,11 +163,9 @@ public final class LaplaceDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always negative infinity
- * no matter the parameters.
+ * <p>The lower bound of the support is always negative infinity.
*
- * @return lower bound of the support (always
- * {@code Double.NEGATIVE_INFINITY})
+ * @return negative infinity.
*/
@Override
public double getSupportLowerBound() {
@@ -177,11 +175,9 @@ public final class LaplaceDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java
index 876e506..5d90174 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LevyDistribution.java
@@ -182,6 +182,8 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
* {@inheritDoc}
*
* <p>The mean is equal to positive infinity.
+ *
+ * @return positive infinity.
*/
@Override
public double getMean() {
@@ -192,6 +194,8 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
* {@inheritDoc}
*
* <p>The variance is equal to positive infinity.
+ *
+ * @return positive infinity.
*/
@Override
public double getVariance() {
@@ -203,7 +207,7 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
*
* <p>The lower bound of the support is the {@link #getLocation() location}.
*
- * @return lower bound of the support
+ * @return location.
*/
@Override
public double getSupportLowerBound() {
@@ -213,11 +217,9 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
index 2426e4b..71247d7 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogNormalDistribution.java
@@ -235,9 +235,9 @@ public final class LogNormalDistribution extends AbstractContinuousDistribution
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -247,11 +247,9 @@ public final class LogNormalDistribution extends AbstractContinuousDistribution
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java
index 0495f16..0aca8fb 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/LogisticDistribution.java
@@ -187,11 +187,9 @@ public final class LogisticDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always negative infinity
- * no matter the parameters.
+ * <p>The lower bound of the support is always negative infinity.
*
- * @return lower bound of the support (always
- * {@code Double.NEGATIVE_INFINITY})
+ * @return negative infinity.
*/
@Override
public double getSupportLowerBound() {
@@ -201,11 +199,9 @@ public final class LogisticDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
index 7d3f406..b1209eb 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
@@ -162,9 +162,9 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -174,11 +174,9 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java
index 1d93acb..af8dae7 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NormalDistribution.java
@@ -184,11 +184,9 @@ public final class NormalDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always negative infinity
- * no matter the parameters.
+ * <p>The lower bound of the support is always negative infinity.
*
- * @return lower bound of the support (always
- * {@code Double.NEGATIVE_INFINITY})
+ * @return negative infinity.
*/
@Override
public double getSupportLowerBound() {
@@ -198,11 +196,9 @@ public final class NormalDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java
index f9dcfe7..47a4ee2 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ParetoDistribution.java
@@ -270,7 +270,7 @@ public final class ParetoDistribution extends AbstractContinuousDistribution {
* <p>
* The lower bound of the support is equal to the scale parameter {@code k}.
*
- * @return lower bound of the support
+ * @return scale.
*/
@Override
public double getSupportLowerBound() {
@@ -280,9 +280,9 @@ public final class ParetoDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
* <p>
- * The upper bound of the support is always positive infinity no matter the parameters.
+ * The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
index 136f867..46dd32f 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PascalDistribution.java
@@ -211,9 +211,9 @@ public final class PascalDistribution extends AbstractDiscreteDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public int getSupportLowerBound() {
@@ -226,7 +226,7 @@ public final class PascalDistribution extends AbstractDiscreteDistribution {
* <p>The upper bound of the support is positive infinity except for the
* probability parameter {@code p = 1.0}.
*
- * @return upper bound of the support ({@code Integer.MAX_VALUE} or 0)
+ * @return {@code Integer.MAX_VALUE} or 0.
*/
@Override
public int getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
index 9224ad1..1ad278c 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/PoissonDistribution.java
@@ -127,9 +127,9 @@ public final class PoissonDistribution extends AbstractDiscreteDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the mean parameter.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public int getSupportLowerBound() {
@@ -139,12 +139,9 @@ public final class PoissonDistribution extends AbstractDiscreteDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is positive infinity,
- * regardless of the parameter values. There is no integer infinity,
- * so this method returns {@code Integer.MAX_VALUE}.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always {@code Integer.MAX_VALUE} for
- * positive infinity)
+ * @return {@code Integer.MAX_VALUE}
*/
@Override
public int getSupportUpperBound() {
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 299f18e..c7143d5 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
@@ -298,10 +298,9 @@ public abstract class TDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always negative infinity..
+ * <p>The lower bound of the support is always negative infinity.
*
- * @return lower bound of the support (always
- * {@code Double.NEGATIVE_INFINITY})
+ * @return negative infinity.
*/
@Override
public double getSupportLowerBound() {
@@ -313,8 +312,7 @@ public abstract class TDistribution extends AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java
index 058c4ae..c86af09 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TriangularDistribution.java
@@ -249,8 +249,6 @@ public final class TriangularDistribution extends AbstractContinuousDistribution
*
* <p>The lower bound of the support is equal to the lower limit parameter
* {@code a} of the distribution.
- *
- * @return lower bound of the support
*/
@Override
public double getSupportLowerBound() {
@@ -262,8 +260,6 @@ public final class TriangularDistribution extends AbstractContinuousDistribution
*
* <p>The upper bound of the support is equal to the upper limit parameter
* {@code b} of the distribution.
- *
- * @return upper bound of the support
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java
index d36fac6..fa24538 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TruncatedNormalDistribution.java
@@ -247,13 +247,23 @@ public final class TruncatedNormalDistribution extends AbstractContinuousDistrib
return variance(a, b) * s * s;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The lower bound of the support is equal to the lower bound parameter
+ * of the distribution.
+ */
@Override
public double getSupportLowerBound() {
return lower;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The upper bound of the support is equal to the upper bound parameter
+ * of the distribution.
+ */
@Override
public double getSupportUpperBound() {
return upper;
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java
index 2787070..063f541 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformContinuousDistribution.java
@@ -191,8 +191,6 @@ public final class UniformContinuousDistribution extends AbstractContinuousDistr
*
* <p>The lower bound of the support is equal to the lower bound parameter
* of the distribution.
- *
- * @return lower bound of the support
*/
@Override
public double getSupportLowerBound() {
@@ -204,8 +202,6 @@ public final class UniformContinuousDistribution extends AbstractContinuousDistr
*
* <p>The upper bound of the support is equal to the upper bound parameter
* of the distribution.
- *
- * @return upper bound of the support
*/
@Override
public double getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java
index 1b6c528..25c3116 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/UniformDiscreteDistribution.java
@@ -242,8 +242,6 @@ public final class UniformDiscreteDistribution extends AbstractDiscreteDistribut
*
* <p>The lower bound of the support is equal to the lower bound parameter
* of the distribution.
- *
- * @return lower bound of the support
*/
@Override
public int getSupportLowerBound() {
@@ -255,8 +253,6 @@ public final class UniformDiscreteDistribution extends AbstractDiscreteDistribut
*
* <p>The upper bound of the support is equal to the upper bound parameter
* of the distribution.
- *
- * @return upper bound of the support
*/
@Override
public int getSupportUpperBound() {
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
index eb29633..d0ef1d3 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/WeibullDistribution.java
@@ -268,9 +268,9 @@ public final class WeibullDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 0 no matter the parameters.
+ * <p>The lower bound of the support is always 0.
*
- * @return lower bound of the support (always 0)
+ * @return 0.
*/
@Override
public double getSupportLowerBound() {
@@ -280,11 +280,9 @@ public final class WeibullDistribution extends AbstractContinuousDistribution {
/**
* {@inheritDoc}
*
- * <p>The upper bound of the support is always positive infinity
- * no matter the parameters.
+ * <p>The upper bound of the support is always positive infinity.
*
- * @return upper bound of the support (always
- * {@code Double.POSITIVE_INFINITY})
+ * @return positive infinity.
*/
@Override
public double getSupportUpperBound() {
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 15c7412..c7ceb49 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
@@ -245,9 +245,9 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution {
/**
* {@inheritDoc}
*
- * <p>The lower bound of the support is always 1 no matter the parameters.
+ * <p>The lower bound of the support is always 1.
*
- * @return lower bound of the support (always 1)
+ * @return 1.
*/
@Override
public int getSupportLowerBound() {
@@ -259,7 +259,7 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution {
*
* <p>The upper bound of the support is the number of elements.
*
- * @return upper bound of the support
+ * @return number of elements.
*/
@Override
public int getSupportUpperBound() {