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 1927c9138ffe0312706a2c558294b741eb148ed2 Author: Alex Herbert <aherb...@apache.org> AuthorDate: Mon Aug 2 23:27:59 2021 +0100 Add <p> tags for additional javadoc added after inheritDoc --- .../distribution/AbstractContinuousDistribution.java | 7 +++++-- .../distribution/AbstractDiscreteDistribution.java | 2 +- .../statistics/distribution/BetaDistribution.java | 12 ++++++------ .../statistics/distribution/BinomialDistribution.java | 10 +++++----- .../statistics/distribution/CauchyDistribution.java | 12 ++++++------ .../statistics/distribution/ChiSquaredDistribution.java | 8 ++++---- .../statistics/distribution/ExponentialDistribution.java | 12 ++++++------ .../commons/statistics/distribution/FDistribution.java | 12 ++++++------ .../statistics/distribution/GammaDistribution.java | 12 ++++++------ .../statistics/distribution/GeometricDistribution.java | 10 +++++----- .../distribution/HypergeometricDistribution.java | 10 +++++----- .../statistics/distribution/LevyDistribution.java | 2 +- .../statistics/distribution/LogNormalDistribution.java | 16 ++++++++-------- .../statistics/distribution/NormalDistribution.java | 10 +++++----- .../statistics/distribution/ParetoDistribution.java | 4 ++-- .../statistics/distribution/PascalDistribution.java | 10 +++++----- .../statistics/distribution/PoissonDistribution.java | 8 ++++---- .../commons/statistics/distribution/TDistribution.java | 10 +++++----- .../statistics/distribution/TriangularDistribution.java | 14 +++++++------- .../distribution/TruncatedNormalDistribution.java | 4 ++-- .../distribution/UniformContinuousDistribution.java | 10 +++++----- .../distribution/UniformDiscreteDistribution.java | 10 +++++----- .../statistics/distribution/WeibullDistribution.java | 12 ++++++------ .../statistics/distribution/ZipfDistribution.java | 10 +++++----- 24 files changed, 115 insertions(+), 112 deletions(-) diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractContinuousDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractContinuousDistribution.java index ee8fb3d..8157592 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractContinuousDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractContinuousDistribution.java @@ -46,10 +46,13 @@ abstract class AbstractContinuousDistribution /** * {@inheritDoc} * - * The default implementation returns + * <p>The default implementation returns: * <ul> * <li>{@link #getSupportLowerBound()} for {@code p = 0},</li> - * <li>{@link #getSupportUpperBound()} for {@code p = 1}.</li> + * <li>{@link #getSupportUpperBound()} for {@code p = 1}, or</li> + * <li>the result of a search for a root between the lower and upper bound using + * {@link #cumulativeProbability(double) cdf(x) - p}. The bounds may be bracketed for + * efficiency.</li> * </ul> */ @Override diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractDiscreteDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractDiscreteDistribution.java index ff76dc7..7408263 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractDiscreteDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/AbstractDiscreteDistribution.java @@ -30,7 +30,7 @@ abstract class AbstractDiscreteDistribution /** * {@inheritDoc} * - * The default implementation returns + * <p>The default implementation returns: * <ul> * <li>{@link #getSupportLowerBound()} for {@code p = 0},</li> * <li>{@link #getSupportUpperBound()} for {@code p = 1}, or</li> 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 e9bc71b..ac3cecc 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 @@ -121,7 +121,7 @@ public class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For first shape parameter {@code alpha} and second shape parameter + * <p>For first shape parameter {@code alpha} and second shape parameter * {@code beta}, the mean is {@code alpha / (alpha + beta)}. */ @Override @@ -133,7 +133,7 @@ public class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For first shape parameter {@code alpha} and second shape parameter + * <p>For first shape parameter {@code alpha} and second shape parameter * {@code beta}, the variance is * {@code (alpha * beta) / [(alpha + beta)^2 * (alpha + beta + 1)]}. */ @@ -148,7 +148,7 @@ public class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the parameters. + * <p>The lower bound of the support is always 0 no matter the parameters. * * @return lower bound of the support (always 0) */ @@ -160,7 +160,7 @@ public class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always 1 no matter the parameters. + * <p>The upper bound of the support is always 1 no matter the parameters. * * @return upper bound of the support (always 1) */ @@ -172,7 +172,7 @@ public class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ @@ -184,7 +184,7 @@ public class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * Sampling is performed using Cheng's algorithm: + * <p>Sampling is performed using Cheng's algorithm: * <blockquote> * <pre> * R. C. H. Cheng, 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 4da813b..fb78bab 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 @@ -115,7 +115,7 @@ public class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For {@code n} trials and probability parameter {@code p}, the mean is + * <p>For {@code n} trials and probability parameter {@code p}, the mean is * {@code n * p}. */ @Override @@ -126,7 +126,7 @@ public class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For {@code n} trials and probability parameter {@code p}, the variance is + * <p>For {@code n} trials and probability parameter {@code p}, the variance is * {@code n * p * (1 - p)}. */ @Override @@ -138,7 +138,7 @@ public class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 except for the probability + * <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) @@ -151,7 +151,7 @@ public class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The upper bound of the support is the number of trials except for the + * <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) @@ -164,7 +164,7 @@ public class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 1c7de30..9dd0d27 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 @@ -96,7 +96,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * Returns {@code Double.NEGATIVE_INFINITY} when {@code p == 0} + * <p>Returns {@code Double.NEGATIVE_INFINITY} when {@code p == 0} * and {@code Double.POSITIVE_INFINITY} when {@code p == 1}. */ @Override @@ -115,7 +115,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The mean is always undefined no matter the parameters. + * <p>The mean is always undefined no matter the parameters. * * @return mean (always Double.NaN) */ @@ -127,7 +127,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The variance is always undefined no matter the parameters. + * <p>The variance is always undefined no matter the parameters. * * @return variance (always Double.NaN) */ @@ -139,7 +139,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always negative infinity no matter + * <p>The lower bound of the support is always negative infinity no matter * the parameters. * * @return lower bound of the support (always Double.NEGATIVE_INFINITY) @@ -152,7 +152,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity no matter + * <p>The upper bound of the support is always positive infinity no matter * the parameters. * * @return upper bound of the support (always Double.POSITIVE_INFINITY) @@ -165,7 +165,7 @@ public class CauchyDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 c10adf5..15796de 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 @@ -70,7 +70,7 @@ public class ChiSquaredDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For {@code k} degrees of freedom, the mean is {@code k}. + * <p>For {@code k} degrees of freedom, the mean is {@code k}. */ @Override public double getMean() { @@ -90,7 +90,7 @@ public class ChiSquaredDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the + * <p>The lower bound of the support is always 0 no matter the * degrees of freedom. * * @return zero. @@ -103,7 +103,7 @@ public class ChiSquaredDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity no matter the + * <p>The upper bound of the support is always positive infinity no matter the * degrees of freedom. * * @return {@code Double.POSITIVE_INFINITY}. @@ -116,7 +116,7 @@ public class ChiSquaredDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 fd1fbcc..75d0192 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 @@ -66,7 +66,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The implementation of this method is based on: + * <p>The implementation of this method is based on: * <ul> * <li> * <a href="http://mathworld.wolfram.com/ExponentialDistribution.html"> @@ -95,7 +95,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * Returns {@code 0} when {@code p= = 0} and + * <p>Returns {@code 0} when {@code p= = 0} and * {@code Double.POSITIVE_INFINITY} when {@code p == 1}. */ @Override @@ -118,7 +118,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For mean parameter {@code k}, the variance is {@code k^2}. + * <p>For mean parameter {@code k}, the variance is {@code k^2}. */ @Override public double getVariance() { @@ -128,7 +128,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the mean parameter. + * <p>The lower bound of the support is always 0 no matter the mean parameter. * * @return lower bound of the support (always 0) */ @@ -140,7 +140,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity + * <p>The upper bound of the support is always positive infinity * no matter the mean parameter. * * @return upper bound of the support (always Double.POSITIVE_INFINITY) @@ -153,7 +153,7 @@ public class ExponentialDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 1610478..9f42076 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 @@ -121,7 +121,7 @@ public class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The implementation of this method is based on + * <p>The implementation of this method is based on * <ul> * <li> * <a href="http://mathworld.wolfram.com/F-Distribution.html"> @@ -165,7 +165,7 @@ public class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For denominator degrees of freedom parameter {@code b}, the mean is + * <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}). @@ -185,7 +185,7 @@ public class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For numerator degrees of freedom parameter {@code a} and denominator + * <p>For numerator degrees of freedom parameter {@code a} and denominator * degrees of freedom parameter {@code b}, the variance is * <ul> * <li> @@ -213,7 +213,7 @@ public class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the parameters. + * <p>The lower bound of the support is always 0 no matter the parameters. * * @return lower bound of the support (always 0) */ @@ -225,7 +225,7 @@ public class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity + * <p>The upper bound of the support is always positive infinity * no matter the parameters. * * @return upper bound of the support (always Double.POSITIVE_INFINITY) @@ -238,7 +238,7 @@ public class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 eb6761c..88037fe 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 @@ -233,7 +233,7 @@ public class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The implementation of this method is based on: + * <p>The implementation of this method is based on: * <ul> * <li> * <a href="http://mathworld.wolfram.com/Chi-SquaredDistribution.html"> @@ -269,7 +269,7 @@ public class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For shape parameter {@code alpha} and scale parameter {@code beta}, the + * <p>For shape parameter {@code alpha} and scale parameter {@code beta}, the * mean is {@code alpha * beta}. */ @Override @@ -280,7 +280,7 @@ public class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For shape parameter {@code alpha} and scale parameter {@code beta}, the + * <p>For shape parameter {@code alpha} and scale parameter {@code beta}, the * variance is {@code alpha * beta^2}. * * @return {@inheritDoc} @@ -293,7 +293,7 @@ public class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the parameters. + * <p>The lower bound of the support is always 0 no matter the parameters. * * @return lower bound of the support (always 0) */ @@ -305,7 +305,7 @@ public class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity + * <p>The upper bound of the support is always positive infinity * no matter the parameters. * * @return upper bound of the support (always Double.POSITIVE_INFINITY) @@ -318,7 +318,7 @@ public class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 2e6dd3c..2fbf9db 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 @@ -109,7 +109,7 @@ public class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For probability parameter {@code p}, the mean is {@code (1 - p) / p}. + * <p>For probability parameter {@code p}, the mean is {@code (1 - p) / p}. */ @Override public double getMean() { @@ -119,7 +119,7 @@ public class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For probability parameter {@code p}, the variance is + * <p>For probability parameter {@code p}, the variance is * {@code (1 - p) / (p * p)}. */ @Override @@ -130,7 +130,7 @@ public class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0. + * <p>The lower bound of the support is always 0. * * @return lower bound of the support (always 0) */ @@ -142,7 +142,7 @@ public class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The upper bound of the support is infinite (which we approximate as + * <p>The upper bound of the support is infinite (which we approximate as * {@code Integer.MAX_VALUE}). * * @return upper bound of the support (always Integer.MAX_VALUE) @@ -155,7 +155,7 @@ public class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java index 5a870ad..bab3c1f 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/HypergeometricDistribution.java @@ -221,7 +221,7 @@ public class HypergeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For population size {@code N}, number of successes {@code m}, and sample + * <p>For population size {@code N}, number of successes {@code m}, and sample * size {@code n}, the mean is {@code n * m / N}. */ @Override @@ -232,7 +232,7 @@ public class HypergeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For population size {@code N}, number of successes {@code m}, and sample + * <p>For population size {@code N}, number of successes {@code m}, and sample * size {@code n}, the variance is * {@code (n * m * (N - n) * (N - m)) / (N^2 * (N - 1))}. */ @@ -247,7 +247,7 @@ public class HypergeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For population size {@code N}, number of successes {@code m}, and sample + * <p>For population size {@code N}, number of successes {@code m}, and sample * size {@code n}, the lower bound of the support is * {@code max(0, n + m - N)}. * @@ -261,7 +261,7 @@ public class HypergeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For number of successes {@code m} and sample size {@code n}, the upper + * <p>For number of successes {@code m} and sample size {@code n}, the upper * bound of the support is {@code min(m, n)}. * * @return upper bound of the support @@ -274,7 +274,7 @@ public class HypergeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 e6eae34..50565db 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 @@ -90,7 +90,7 @@ public class LevyDistribution extends AbstractContinuousDistribution { /** {@inheritDoc} * - * See documentation of {@link #density(double)} for computation details. + * <p>See documentation of {@link #density(double)} for computation details. */ @Override public double logDensity(double x) { 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 5025592..26f5609 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 @@ -94,7 +94,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For scale {@code m}, and shape {@code s} of this distribution, the PDF + * <p>For scale {@code m}, and shape {@code s} of this distribution, the PDF * is given by * <ul> * <li>{@code 0} if {@code x <= 0},</li> @@ -132,7 +132,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** {@inheritDoc} * - * See documentation of {@link #density(double)} for computation details. + * <p>See documentation of {@link #density(double)} for computation details. */ @Override public double logDensity(double x) { @@ -148,7 +148,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For scale {@code m}, and shape {@code s} of this distribution, the CDF + * <p>For scale {@code m}, and shape {@code s} of this distribution, the CDF * is given by * <ul> * <li>{@code 0} if {@code x <= 0},</li> @@ -188,7 +188,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For scale {@code m} and shape {@code s}, the mean is + * <p>For scale {@code m} and shape {@code s}, the mean is * {@code exp(m + s^2 / 2)}. */ @Override @@ -200,7 +200,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For scale {@code m} and shape {@code s}, the variance is + * <p>For scale {@code m} and shape {@code s}, the variance is * {@code (exp(s^2) - 1) * exp(2 * m + s^2)}. */ @Override @@ -213,7 +213,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the parameters. + * <p>The lower bound of the support is always 0 no matter the parameters. * * @return lower bound of the support (always 0) */ @@ -225,7 +225,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity + * <p>The upper bound of the support is always positive infinity * no matter the parameters. * * @return upper bound of the support (always @@ -239,7 +239,7 @@ public class LogNormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 d2cee06..aa55e63 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 @@ -97,7 +97,7 @@ public class NormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * If {@code x} is more than 40 standard deviations from the mean, 0 or 1 + * <p>If {@code x} is more than 40 standard deviations from the mean, 0 or 1 * is returned, as in these cases the actual value is within * {@code Double.MIN_VALUE} of 0 or 1. */ @@ -139,7 +139,7 @@ public class NormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For standard deviation parameter {@code s}, the variance is {@code s^2}. + * <p>For standard deviation parameter {@code s}, the variance is {@code s^2}. */ @Override public double getVariance() { @@ -150,7 +150,7 @@ public class NormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always negative infinity + * <p>The lower bound of the support is always negative infinity * no matter the parameters. * * @return lower bound of the support (always @@ -164,7 +164,7 @@ public class NormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity + * <p>The upper bound of the support is always positive infinity * no matter the parameters. * * @return upper bound of the support (always @@ -178,7 +178,7 @@ public class NormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 0b52626..9dfc5fe 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 @@ -108,7 +108,7 @@ public class ParetoDistribution extends AbstractContinuousDistribution { /** {@inheritDoc} * - * See documentation of {@link #density(double)} for computation details. + * <p>See documentation of {@link #density(double)} for computation details. */ @Override public double logDensity(double x) { @@ -207,7 +207,7 @@ public class ParetoDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * <p> - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 50b19bb..b75e55e 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 @@ -168,7 +168,7 @@ public class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For number of successes {@code r} and probability of success {@code p}, + * <p>For number of successes {@code r} and probability of success {@code p}, * the mean is {@code r * (1 - p) / p}. */ @Override @@ -181,7 +181,7 @@ public class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For number of successes {@code r} and probability of success {@code p}, + * <p>For number of successes {@code r} and probability of success {@code p}, * the variance is {@code r * (1 - p) / p^2}. */ @Override @@ -194,7 +194,7 @@ public class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the parameters. + * <p>The lower bound of the support is always 0 no matter the parameters. * * @return lower bound of the support (always 0) */ @@ -206,7 +206,7 @@ public class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity no matter the + * <p>The upper bound of the support is always positive infinity no matter the * parameters. Positive infinity is symbolized by {@code Integer.MAX_VALUE}. * * @return upper bound of the support (always {@code Integer.MAX_VALUE} @@ -220,7 +220,7 @@ public class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 f470486..bfcabed 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 @@ -142,7 +142,7 @@ public class PoissonDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The variance is equal to the {@link #getMean() mean}. + * <p>The variance is equal to the {@link #getMean() mean}. */ @Override public double getVariance() { @@ -152,7 +152,7 @@ public class PoissonDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the mean parameter. + * <p>The lower bound of the support is always 0 no matter the mean parameter. * * @return lower bound of the support (always 0) */ @@ -164,7 +164,7 @@ public class PoissonDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The upper bound of the support is positive infinity, + * <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}. * @@ -179,7 +179,7 @@ public class PoissonDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 6373f58..25d0bcc 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 @@ -119,7 +119,7 @@ public class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For degrees of freedom parameter {@code df}, the mean is + * <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> @@ -133,7 +133,7 @@ public class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For degrees of freedom parameter {@code df}, the variance is + * <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> @@ -148,7 +148,7 @@ public class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * 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}) @@ -161,7 +161,7 @@ public class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity. + * <p>The upper bound of the support is always positive infinity. * * @return upper bound of the support (always * {@code Double.POSITIVE_INFINITY}) @@ -174,7 +174,7 @@ public class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 4500f01..f833933 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 @@ -82,7 +82,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For lower limit {@code a}, upper limit {@code b} and mode {@code c}, the + * <p>For lower limit {@code a}, upper limit {@code b} and mode {@code c}, the * PDF is given by * <ul> * <li>{@code 2 * (x - a) / [(b - a) * (c - a)]} if {@code a <= x < c},</li> @@ -113,7 +113,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For lower limit {@code a}, upper limit {@code b} and mode {@code c}, the + * <p>For lower limit {@code a}, upper limit {@code b} and mode {@code c}, the * CDF is given by * <ul> * <li>{@code 0} if {@code x < a},</li> @@ -164,7 +164,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For lower limit {@code a}, upper limit {@code b}, and mode {@code c}, + * <p>For lower limit {@code a}, upper limit {@code b}, and mode {@code c}, * the mean is {@code (a + b + c) / 3}. */ @Override @@ -175,7 +175,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * For lower limit {@code a}, upper limit {@code b}, and mode {@code c}, + * <p>For lower limit {@code a}, upper limit {@code b}, and mode {@code c}, * the variance is {@code (a^2 + b^2 + c^2 - a * b - a * c - b * c) / 18}. */ @Override @@ -186,7 +186,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is equal to the lower limit parameter + * <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 @@ -199,7 +199,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is equal to the upper limit parameter + * <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 @@ -212,7 +212,7 @@ public class TriangularDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 a38b75f..08de808 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 @@ -170,7 +170,7 @@ public class TruncatedNormalDistribution extends AbstractContinuousDistribution /** * {@inheritDoc} * - * Represents the true mean of the truncated normal distribution rather + * <p>Represents the true mean of the truncated normal distribution rather * than the parent normal distribution mean. */ @Override @@ -181,7 +181,7 @@ public class TruncatedNormalDistribution extends AbstractContinuousDistribution /** * {@inheritDoc} * - * Represents the true variance of the truncated normal distribution rather + * <p>Represents the true variance of the truncated normal distribution rather * than the parent normal distribution variance. */ @Override 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 98ff5bc..64c0569 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 @@ -101,7 +101,7 @@ public class UniformContinuousDistribution extends AbstractContinuousDistributio /** * {@inheritDoc} * - * For lower bound {@code lower} and upper bound {@code upper}, the mean is + * <p>For lower bound {@code lower} and upper bound {@code upper}, the mean is * {@code 0.5 * (lower + upper)}. */ @Override @@ -112,7 +112,7 @@ public class UniformContinuousDistribution extends AbstractContinuousDistributio /** * {@inheritDoc} * - * For lower bound {@code lower} and upper bound {@code upper}, the + * <p>For lower bound {@code lower} and upper bound {@code upper}, the * variance is {@code (upper - lower)^2 / 12}. */ @Override @@ -123,7 +123,7 @@ public class UniformContinuousDistribution extends AbstractContinuousDistributio /** * {@inheritDoc} * - * The lower bound of the support is equal to the lower bound parameter + * <p>The lower bound of the support is equal to the lower bound parameter * of the distribution. * * @return lower bound of the support @@ -136,7 +136,7 @@ public class UniformContinuousDistribution extends AbstractContinuousDistributio /** * {@inheritDoc} * - * The upper bound of the support is equal to the upper bound parameter + * <p>The upper bound of the support is equal to the upper bound parameter * of the distribution. * * @return upper bound of the support @@ -149,7 +149,7 @@ public class UniformContinuousDistribution extends AbstractContinuousDistributio /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 eb69885..0ed628c 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 @@ -90,7 +90,7 @@ public class UniformDiscreteDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For lower bound {@code lower} and upper bound {@code upper}, the mean is + * <p>For lower bound {@code lower} and upper bound {@code upper}, the mean is * {@code 0.5 * (lower + upper)}. */ @Override @@ -102,7 +102,7 @@ public class UniformDiscreteDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For lower bound {@code lower} and upper bound {@code upper}, and + * <p>For lower bound {@code lower} and upper bound {@code upper}, and * {@code n = upper - lower + 1}, the variance is {@code (n^2 - 1) / 12}. */ @Override @@ -113,7 +113,7 @@ public class UniformDiscreteDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The lower bound of the support is equal to the lower bound parameter + * <p>The lower bound of the support is equal to the lower bound parameter * of the distribution. * * @return lower bound of the support @@ -126,7 +126,7 @@ public class UniformDiscreteDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The upper bound of the support is equal to the upper bound parameter + * <p>The upper bound of the support is equal to the upper bound parameter * of the distribution. * * @return upper bound of the support @@ -139,7 +139,7 @@ public class UniformDiscreteDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 a488c85..9fb61cd 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 @@ -148,7 +148,7 @@ public class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * Returns {@code 0} when {@code p == 0} and + * <p>Returns {@code 0} when {@code p == 0} and * {@code Double.POSITIVE_INFINITY} when {@code p == 1}. */ @Override @@ -167,7 +167,7 @@ public class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The mean is {@code scale * Gamma(1 + (1 / shape))}, where {@code Gamma()} + * <p>The mean is {@code scale * Gamma(1 + (1 / shape))}, where {@code Gamma()} * is the Gamma-function. */ @Override @@ -181,7 +181,7 @@ public class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The variance is {@code scale^2 * Gamma(1 + (2 / shape)) - mean^2} + * <p>The variance is {@code scale^2 * Gamma(1 + (2 / shape)) - mean^2} * where {@code Gamma()} is the Gamma-function. */ @Override @@ -197,7 +197,7 @@ public class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 0 no matter the parameters. + * <p>The lower bound of the support is always 0 no matter the parameters. * * @return lower bound of the support (always 0) */ @@ -209,7 +209,7 @@ public class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The upper bound of the support is always positive infinity + * <p>The upper bound of the support is always positive infinity * no matter the parameters. * * @return upper bound of the support (always @@ -223,7 +223,7 @@ public class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */ 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 7b6234a..da5291d 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 @@ -121,7 +121,7 @@ public class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For number of elements {@code N} and exponent {@code s}, the mean is + * <p>For number of elements {@code N} and exponent {@code s}, the mean is * {@code Hs1 / Hs}, where * <ul> * <li>{@code Hs1 = generalizedHarmonic(N, s - 1)},</li> @@ -142,7 +142,7 @@ public class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * For number of elements {@code N} and exponent {@code s}, the mean is + * <p>For number of elements {@code N} and exponent {@code s}, the mean is * {@code (Hs2 / Hs) - (Hs1^2 / Hs^2)}, where * <ul> * <li>{@code Hs2 = generalizedHarmonic(N, s - 2)},</li> @@ -182,7 +182,7 @@ public class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The lower bound of the support is always 1 no matter the parameters. + * <p>The lower bound of the support is always 1 no matter the parameters. * * @return lower bound of the support (always 1) */ @@ -194,7 +194,7 @@ public class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The upper bound of the support is the number of elements. + * <p>The upper bound of the support is the number of elements. * * @return upper bound of the support */ @@ -206,7 +206,7 @@ public class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * The support of this distribution is connected. + * <p>The support of this distribution is connected. * * @return {@code true} */