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 0a41bac2de44e831f30eeeafdb7fbe6bf05f7f14 Author: aherbert <[email protected]> AuthorDate: Tue Nov 22 15:15:24 2022 +0000 Use MathJax for mean and variance documentation --- .../statistics/distribution/BetaDistribution.java | 13 +++-- .../distribution/BinomialDistribution.java | 6 +- .../distribution/ChiSquaredDistribution.java | 4 +- .../distribution/ExponentialDistribution.java | 2 +- .../statistics/distribution/FDistribution.java | 28 +++++---- .../statistics/distribution/GammaDistribution.java | 8 +-- .../distribution/GeometricDistribution.java | 9 ++- .../distribution/GumbelDistribution.java | 12 +++- .../distribution/HypergeometricDistribution.java | 15 +++-- .../distribution/LaplaceDistribution.java | 2 +- .../distribution/LogNormalDistribution.java | 10 ++-- .../distribution/LogisticDistribution.java | 4 +- .../distribution/NakagamiDistribution.java | 16 +++++- .../distribution/NormalDistribution.java | 2 +- .../distribution/ParetoDistribution.java | 66 ++++++++++++---------- .../distribution/PascalDistribution.java | 12 ++-- .../statistics/distribution/TDistribution.java | 24 ++++---- .../distribution/TrapezoidalDistribution.java | 8 +-- .../distribution/TriangularDistribution.java | 6 +- .../distribution/TruncatedNormalDistribution.java | 19 +++++++ .../UniformContinuousDistribution.java | 6 +- .../distribution/UniformDiscreteDistribution.java | 10 ++-- .../distribution/WeibullDistribution.java | 15 +++-- .../statistics/distribution/ZipfDistribution.java | 27 ++++----- 24 files changed, 194 insertions(+), 130 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 6fdf04b..307a00a 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 @@ -185,8 +185,10 @@ public final class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For first shape parameter {@code alpha} and second shape parameter - * {@code beta}, the mean is {@code alpha / (alpha + beta)}. + * <p>For first shape parameter \( \alpha \) and second shape parameter + * \( \beta \), the mean is: + * + * <p>\[ \frac{\alpha}{\alpha + \beta} \] */ @Override public double getMean() { @@ -196,9 +198,10 @@ public final class BetaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <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)]}. + * <p>For first shape parameter \( \alpha \) and second shape parameter + * \( \beta \), the variance is: + * + * <p>\[ \frac{\alpha \beta}{(\alpha + \beta)^2 (\alpha + \beta + 1)} \]. */ @Override public double getVariance() { 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 e12cb68..96f2d5a 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 @@ -168,8 +168,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <p>For {@code n} trials and probability parameter {@code p}, the mean is - * {@code n * p}. + * <p>For number of trials \( n \) and probability of success \( p \), the mean is \( np \). */ @Override public double getMean() { @@ -179,8 +178,7 @@ public final class BinomialDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <p>For {@code n} trials and probability parameter {@code p}, the variance is - * {@code n * p * (1 - p)}. + * <p>For number of trials \( n \) and probability of success \( p \), the variance is \( np (1 - p) \). */ @Override public double getVariance() { 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 cf01e31..0c305cb 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 @@ -118,7 +118,7 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution /** * {@inheritDoc} * - * <p>For {@code k} degrees of freedom, the mean is {@code k}. + * <p>For \( k \) degrees of freedom, the mean is \( k \). */ @Override public double getMean() { @@ -128,7 +128,7 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution /** * {@inheritDoc} * - * @return {@code 2 * k}, where {@code k} is the number of degrees of freedom. + * <p>For \( k \) degrees of freedom, the variance is \( 2k \). */ @Override public double getVariance() { 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 a4ba8b9..945a5d5 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 @@ -147,7 +147,7 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio /** * {@inheritDoc} * - * <p>For mean {@code k}, the variance is {@code k^2}. + * <p>For mean \( \mu \), the variance is \( \mu^2 \). */ @Override public 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 5ca3555..0627bb3 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 @@ -79,7 +79,6 @@ public final class FDistribution extends AbstractContinuousDistribution { } if (denominatorDegreesOfFreedom > MIN_DENOMINATOR_DF_FOR_VARIANCE) { final double denomDFMinusTwo = denominatorDegreesOfFreedom - 2; - variance = (2 * (denominatorDegreesOfFreedom * denominatorDegreesOfFreedom) * (numeratorDegreesOfFreedom + denominatorDegreesOfFreedom - 2)) / (numeratorDegreesOfFreedom * (denomDFMinusTwo * denomDFMinusTwo) * @@ -281,11 +280,12 @@ public final class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <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 NaN}). - * </ul> + * <p>For denominator degrees of freedom parameter \( m \), the mean is: + * + * <p>\[ \operatorname{E}[X] = \begin{cases} + * \frac{m}{m-2} & \text{for } m \gt 2 \\ + * \text{undefined} & \text{otherwise} + * \end{cases} \] * * @return the mean, or {@code NaN} if it is not defined. */ @@ -297,15 +297,13 @@ public final class FDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For numerator degrees of freedom parameter {@code a} and denominator - * degrees of freedom parameter {@code b}, the variance is - * <ul> - * <li> - * if {@code b > 4} then - * {@code [2 * b^2 * (a + b - 2)] / [a * (b - 2)^2 * (b - 4)]}, - * </li> - * <li>else undefined ({@code NaN}). - * </ul> + * <p>For numerator degrees of freedom parameter \( n \) and denominator + * degrees of freedom parameter \( m \), the variance is: + * + * <p>\[ \operatorname{var}[X] = \begin{cases} + * \frac{2m^2 (n+m-2)}{n (m-2)^2 (m-4)} & \text{for } m \gt 4 \\ + * \text{undefined} & \text{otherwise} + * \end{cases} \] * * @return the variance, or {@code NaN} if it is not defined. */ 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 4a13e72..79f0aa4 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 @@ -198,8 +198,8 @@ public final class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For shape parameter {@code alpha} and scale parameter {@code beta}, the - * mean is {@code alpha * beta}. + * <p>For shape parameter \( k \) and scale parameter \( \theta \), the + * mean is \( k \theta \). */ @Override public double getMean() { @@ -209,8 +209,8 @@ public final class GammaDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For shape parameter {@code alpha} and scale parameter {@code beta}, the - * variance is {@code alpha * beta^2}. + * <p>For shape parameter \( k \) and scale parameter \( \theta \), the + * variance is \( k \theta^2 \). */ @Override public double getVariance() { 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 d19b4d8..882fd02 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 @@ -206,7 +206,9 @@ public final class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <p>For probability parameter {@code p}, the mean is {@code (1 - p) / p}. + * <p>For probability parameter \( p \), the mean is: + * + * <p>\[ \frac{1 - p}{p} \] */ @Override public double getMean() { @@ -216,8 +218,9 @@ public final class GeometricDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <p>For probability parameter {@code p}, the variance is - * {@code (1 - p) / (p * p)}. + * <p>For probability parameter \( p \), the variance is: + * + * <p>\[ \frac{1 - p}{p^2} \] */ @Override public double getVariance() { 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 ce84287..58df245 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 @@ -160,9 +160,13 @@ public final class GumbelDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>The mean is {@code mu + gamma * beta}, where {@code gamma} is + * <p>For location parameter \( \mu \) and scale parameter \( \beta \), the mean is: + * + * <p>\[ \mu + \beta \gamma \] + * + * <p>where \( \gamma \) is the * <a href="https://mathworld.wolfram.com/Euler-MascheroniConstantApproximations.html"> - * Euler's constant</a> + * Euler-Mascheroni constant</a>. */ @Override public double getMean() { @@ -172,7 +176,9 @@ public final class GumbelDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>The variance is {@code pi^2 * beta^2 / 6}. + * <p>For scale parameter \( \beta \), the variance is: + * + * <p>\[ \frac{\pi^2}{6} \beta^2 \] */ @Override public double getVariance() { 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 8cbb2c4..0e669b3 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 @@ -248,8 +248,10 @@ public final class HypergeometricDistribution extends AbstractDiscreteDistributi /** * {@inheritDoc} * - * <p>For population size {@code N}, number of successes {@code m}, and sample - * size {@code n}, the mean is {@code n * m / N}. + * <p>For population size \( N \), number of successes \( m \), and sample + * size \( n \), the mean is: + * + * <p>\[ n \frac{m}{N} \] */ @Override public double getMean() { @@ -259,16 +261,17 @@ public final class HypergeometricDistribution extends AbstractDiscreteDistributi /** * {@inheritDoc} * - * <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))}. + * <p>For population size \( N \), number of successes \( m \), and sample + * size \( n \), the variance is: + * + * <p>\[ n \frac{m}{N} \frac{N-m}{N} \frac{N-n}{N-1} \] */ @Override public double getVariance() { final double N = getPopulationSize(); final double m = getNumberOfSuccesses(); final double n = getSampleSize(); - return (n * m * (N - n) * (N - m)) / (N * N * (N - 1)); + return (n * m * (N - m) * (N - n)) / (N * N * (N - 1)); } /** 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 63c7b53..d341e14 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 @@ -153,7 +153,7 @@ public final class LaplaceDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>The variance is {@code 2 * beta^2}. + * <p>For scale parameter \( b \), the variance is \( 2 b^2 \). */ @Override public double getVariance() { 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 b466f58..a3d5dfd 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 @@ -213,8 +213,9 @@ public final class LogNormalDistribution extends AbstractContinuousDistribution * * <p>For \( \mu \) the mean of the normally distributed natural logarithm of * this distribution, \( \sigma > 0 \) the standard deviation of the normally - * distributed natural logarithm of this distribution, the mean is - * \( \exp(\mu + \frac{\sigma^2}{2}) \). + * distributed natural logarithm of this distribution, the mean is: + * + * <p>\[ \exp(\mu + \frac{\sigma^2}{2}) \] */ @Override public double getMean() { @@ -227,8 +228,9 @@ public final class LogNormalDistribution extends AbstractContinuousDistribution * * <p>For \( \mu \) the mean of the normally distributed natural logarithm of * this distribution, \( \sigma > 0 \) the standard deviation of the normally - * distributed natural logarithm of this distribution, the variance is - * \( [\exp(\sigma^2) - 1)] \exp(2 \mu + \sigma^2) \). + * distributed natural logarithm of this distribution, the variance is: + * + * <p>\[ [\exp(\sigma^2) - 1)] \exp(2 \mu + \sigma^2) \] */ @Override public double getVariance() { 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 c03743e..8dce169 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 @@ -177,7 +177,9 @@ public final class LogisticDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For scale parameter {@code s}, the variance is {@code s^2 * pi^2 / 3}. + * <p>For scale parameter \( s \), the variance is: + * + * <p>\[ \frac{s^2 \pi^2}{3} \]. */ @Override public double getVariance() { 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 df3ccbc..c64f3b8 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 @@ -157,13 +157,25 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution { return RegularizedGamma.Q.value(mu, mu * x * x / omega); } - /** {@inheritDoc} */ + /** + * {@inheritDoc} + * + * <p>For shape parameter \( \mu \) and scale parameter \( \Omega \), the mean is: + * + * <p>\[ \frac{\Gamma(m+\frac{1}{2})}{\Gamma(m)}\left(\frac{\Omega}{m}\right)^{1/2} \] + */ @Override public double getMean() { return mean; } - /** {@inheritDoc} */ + /** + * {@inheritDoc} + * + * <p>For shape parameter \( \mu \) and scale parameter \( \Omega \), the variance is: + * + * <p>\[ \Omega\left(1-\frac{1}{m}\left(\frac{\Gamma(m+\frac{1}{2})}{\Gamma(m)}\right)^2\right) \] + */ @Override public double getVariance() { return variance; 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 940d1ee..ccd75f5 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 @@ -171,7 +171,7 @@ public final class NormalDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For standard deviation parameter {@code s}, the variance is {@code s^2}. + * <p>For standard deviation parameter \( \sigma \), the variance is \( \sigma^2 \). */ @Override public double getVariance() { 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 c771d91..48506a7 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 @@ -132,13 +132,13 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} - * <p> - * For scale {@code k}, and shape {@code α} of this distribution, the PDF - * is given by - * <ul> - * <li>{@code 0} if {@code x < k},</li> - * <li>{@code α * k^α / x^(α + 1)} otherwise.</li> - * </ul> + * + * <p>For scale parameter \( k \) and shape parameter \( \alpha \), the PDF is: + * + * <p>\[ f(x; k, \alpha) = \begin{cases} + * 0 & \text{for } x \lt k \\ + * \frac{\alpha k^\alpha}{x^{\alpha + 1}} & \text{for } x \ge k + * \end{cases} \] */ @Override public double density(double x) { @@ -162,12 +162,13 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} - * <p> - * For scale {@code k}, and shape {@code α} of this distribution, the CDF is given by - * <ul> - * <li>{@code 0} if {@code x < k},</li> - * <li>{@code 1 - (k / x)^α} otherwise.</li> - * </ul> + * + * <p>For scale parameter \( k \) and shape parameter \( \alpha \), the CDF is: + * + * <p>\[ F(x; k, \alpha) = \begin{cases} + * 0 & \text{for } x \le k \\ + * 1 - \left( \frac{k}{x} \right)^\alpha & \text{for } x \gt k + * \end{cases} \] */ @Override public double cumulativeProbability(double x) { @@ -181,12 +182,13 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} - * <p> - * For scale {@code k}, and shape {@code α} of this distribution, the survival function is given by - * <ul> - * <li>{@code 1} if {@code x < k},</li> - * <li>{@code (k / x)^α} otherwise.</li> - * </ul> + * + * <p>For scale parameter \( k \) and shape parameter \( \alpha \), the survival function is: + * + * <p>\[ S(x; k, \alpha) = \begin{cases} + * 1 & \text{for } x \le k \\ + * \left( \frac{k}{x} \right)^\alpha & \text{for } x \gt k + * \end{cases} \] */ @Override public double survivalProbability(double x) { @@ -224,12 +226,13 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} - * <p> - * For scale {@code k} and shape {@code α}, the mean is given by - * <ul> - * <li>{@code ∞} if {@code α <= 1},</li> - * <li>{@code α * k / (α - 1)} otherwise.</li> - * </ul> + * + * <p>For scale parameter \( k \) and shape parameter \( \alpha \), the mean is: + * + * <p>\[ \operatorname{E}[X] = \begin{cases} + * \infty & \text{for } \alpha \le 1 \\ + * \frac{k \alpha}{(\alpha-1)} & \text{for } \alpha \gt 1 + * \end{cases} \] */ @Override public double getMean() { @@ -244,12 +247,13 @@ public final class ParetoDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} - * <p> - * For scale {@code k} and shape {@code α}, the variance is given by - * <ul> - * <li>{@code ∞} if {@code 1 < α <= 2},</li> - * <li>{@code k^2 * α / ((α - 1)^2 * (α - 2))} otherwise.</li> - * </ul> + * + * <p>For scale parameter \( k \) and shape parameter \( \alpha \), the variance is: + * + * <p>\[ \operatorname{var}[X] = \begin{cases} + * \infty & \text{for } \alpha \le 2 \\ + * \frac{k^2 \alpha}{(\alpha-1)^2 (\alpha-2)} & \text{for } \alpha \gt 2 + * \end{cases} \] */ @Override public double getVariance() { 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 0d71a2c..3f92763 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 @@ -183,8 +183,10 @@ public final class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <p>For number of successes {@code r} and probability of success {@code p}, - * the mean is {@code r * (1 - p) / p}. + * <p>For number of successes \( r \) and probability of success \( p \), + * the mean is: + * + * <p>\[ \frac{r (1 - p)}{p} \] */ @Override public double getMean() { @@ -196,8 +198,10 @@ public final class PascalDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <p>For number of successes {@code r} and probability of success {@code p}, - * the variance is {@code r * (1 - p) / p^2}. + * <p>For number of successes \( r \) and probability of success \( p \), + * the variance is: + * + * <p>\[ \frac{r (1 - p)}{p^2} \] */ @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 fb89cc7..c5cdaab 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 @@ -280,11 +280,12 @@ public abstract class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For degrees of freedom parameter {@code df}, the mean is - * <ul> - * <li>zero if {@code df > 1}, and</li> - * <li>undefined ({@code NaN}) otherwise.</li> - * </ul> + * <p>For degrees of freedom parameter \( v \), the mean is: + * + * <p>\[ \operatorname{E}[X] = \begin{cases} + * 0 & \text{for } v \gt 1 \\ + * \text{undefined} & \text{otherwise} + * \end{cases} \] * * @return the mean, or {@code NaN} if it is not defined. */ @@ -294,12 +295,13 @@ public abstract class TDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>For degrees of freedom parameter {@code df}, the variance is - * <ul> - * <li>{@code df / (df - 2)} if {@code df > 2},</li> - * <li>positive infinity if {@code 1 < df <= 2}, and</li> - * <li>undefined ({@code NaN}) otherwise.</li> - * </ul> + * <p>For degrees of freedom parameter \( v \), the variance is: + * + * <p>\[ \operatorname{var}[X] = \begin{cases} + * \frac{v}{v - 2} & \text{for } v \gt 2 \\ + * \infty & \text{for } 1 \lt v \le 2 \\ + * \text{undefined} & \text{otherwise} + * \end{cases} \] * * @return the variance, or {@code NaN} if it is not defined. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java index 98dec47..405ce44 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/TrapezoidalDistribution.java @@ -400,8 +400,8 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu /** * {@inheritDoc} * - * <p>For lower limit {@code a}, start of the density constant region {@code b}, - * end of the density constant region {@code c} and upper limit {@code d}, the + * <p>For lower limit \( a \), start of the density constant region \( b \), + * end of the density constant region \( c \) and upper limit \( d \), the * mean is: * * <p>\[ \frac{1}{3(d+c-b-a)}\left(\frac{d^3-c^3}{d-c}-\frac{b^3-a^3}{b-a}\right) \] @@ -412,8 +412,8 @@ public abstract class TrapezoidalDistribution extends AbstractContinuousDistribu /** * {@inheritDoc} * - * <p>For lower limit {@code a}, start of the density constant region {@code b}, - * end of the density constant region {@code c} and upper limit {@code d}, the + * <p>For lower limit \( a \), start of the density constant region \( b \), + * end of the density constant region \( c \) and upper limit \( d \), the * variance is: * * <p>\[ \frac{1}{6(d+c-b-a)}\left(\frac{d^4-c^4}{d-c}-\frac{b^4-a^4}{b-a}\right) - \mu^2 \] 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 4f65543..da711ea 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 @@ -23,7 +23,7 @@ package org.apache.commons.statistics.distribution; * <p>The probability density function of \( X \) is: * * <p>\[ f(x; a, b, c) = \begin{cases} - * \frac{2(x-a)}{(b-a)(c-a)} & \text{for } a \le x \lt c \\ + * \frac{2(x-a)}{(b-a)(c-a)} & \text{for } a \le x \lt c \\ * \frac{2}{b-a} & \text{for } x = c \\ * \frac{2(b-x)}{(b-a)(b-c)} & \text{for } c \lt x \le b \\ * \end{cases} \] @@ -202,7 +202,7 @@ public final class TriangularDistribution extends AbstractContinuousDistribution /** * {@inheritDoc} * - * <p>For lower limit {@code a}, upper limit {@code b}, and mode {@code c}, + * <p>For lower limit \( a \), upper limit \( b \), and mode \( c \), * the mean is \( (a + b + c) / 3 \). */ @Override @@ -213,7 +213,7 @@ public final class TriangularDistribution extends AbstractContinuousDistribution /** * {@inheritDoc} * - * <p>For lower limit {@code a}, upper limit {@code b}, and mode {@code c}, + * <p>For lower limit \( a \), upper limit \( b \), and mode \( c \), * the variance is \( (a^2 + b^2 + c^2 - ab - ac - bc) / 18 \). */ @Override 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 a8e3bec..bf299e6 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 @@ -282,6 +282,15 @@ public final class TruncatedNormalDistribution extends AbstractContinuousDistrib * * <p>Represents the true mean of the truncated normal distribution rather * than the parent normal distribution mean. + * + * <p>For \( \mu \) mean of the parent normal distribution, + * \( \sigma \) standard deviation of the parent normal distribution, and + * \( a \lt b \) the truncation interval, the mean is: + * + * <p>\[ \mu + \frac{\phi(a)-\phi(b)}{\Phi(b) - \Phi(a)}\sigma \] + * + * <p>where \( \phi \) is the probability density function of the standard normal distribution + * and \( \Phi \) is its cumulative distribution function. */ @Override public double getMean() { @@ -297,6 +306,16 @@ public final class TruncatedNormalDistribution extends AbstractContinuousDistrib * * <p>Represents the true variance of the truncated normal distribution rather * than the parent normal distribution variance. + * + * <p>For \( \mu \) mean of the parent normal distribution, + * \( \sigma \) standard deviation of the parent normal distribution, and + * \( a \lt b \) the truncation interval, the variance is: + * + * <p>\[ \sigma^2 \left[1 + \frac{a\phi(a)-b\phi(b)}{\Phi(b) - \Phi(a)} - + * \left( \frac{\phi(a)-\phi(b)}{\Phi(b) - \Phi(a)} \right)^2 \right] \] + * + * <p>where \( \phi \) is the probability density function of the standard normal distribution + * and \( \Phi \) is its cumulative distribution function. */ @Override public double getVariance() { 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 063f541..f3533fb 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 @@ -166,8 +166,7 @@ public final class UniformContinuousDistribution extends AbstractContinuousDistr /** * {@inheritDoc} * - * <p>For lower bound {@code a} and upper bound {@code b}, the mean is - * {@code 0.5 * (a + b)}. + * <p>For lower bound \( a \) and upper bound \( b \), the mean is \( \frac{a + b}{2} \). */ @Override public double getMean() { @@ -178,8 +177,7 @@ public final class UniformContinuousDistribution extends AbstractContinuousDistr /** * {@inheritDoc} * - * <p>For lower bound {@code a} and upper bound {@code b}, the - * variance is {@code (b - a)^2 / 12}. + * <p>For lower bound \( a \) and upper bound \( b \), the variance is \( \frac{(b - a)^2}{12} \). */ @Override public double getVariance() { 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 25c3116..ef427bb 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 @@ -217,8 +217,7 @@ public final class UniformDiscreteDistribution extends AbstractDiscreteDistribut /** * {@inheritDoc} * - * <p>For lower bound {@code lower} and upper bound {@code upper}, the mean is - * {@code 0.5 * (lower + upper)}. + * <p>For lower bound \( a \) and upper bound \( b \), the mean is \( \frac{a + b}{2} \). */ @Override public double getMean() { @@ -229,8 +228,11 @@ public final class UniformDiscreteDistribution extends AbstractDiscreteDistribut /** * {@inheritDoc} * - * <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}. + * <p>For lower bound \( a \) and upper bound \( b \), the variance is: + * + * <p>\[ \frac{n^2 - 1}{12} \] + * + * <p>where \( n = b - a + 1 \). */ @Override public double getVariance() { 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 f7be8c0..a66f18a 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 @@ -234,8 +234,11 @@ public final class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>The mean is {@code scale * Gamma(1 + (1 / shape))}, where {@code Gamma()} - * is the Gamma-function. + * <p>For shape parameter \( k \) and scale parameter \( \lambda \), the mean is: + * + * <p>\[ \lambda \, \Gamma(1+\frac{1}{k}) \] + * + * <p>where \( \Gamma \) is the Gamma-function. */ @Override public double getMean() { @@ -249,8 +252,12 @@ public final class WeibullDistribution extends AbstractContinuousDistribution { /** * {@inheritDoc} * - * <p>The variance is {@code scale^2 * Gamma(1 + (2 / shape)) - mean^2} - * where {@code Gamma()} is the Gamma-function. + * <p>For shape parameter \( k \) and scale parameter \( \lambda \), the variance is: + * + * <p>\[ \lambda^2 \left[ \Gamma\left(1+\frac{2}{k}\right) - + * \left(\Gamma\left(1+\frac{1}{k}\right)\right)^2 \right] \] + * + * <p>where \( \Gamma \) is the Gamma-function. */ @Override public double getVariance() { 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 82bbdde..f6111bd 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 @@ -156,12 +156,13 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <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> - * <li>{@code Hs = generalizedHarmonic(N, s)}.</li> - * </ul> + * <p>For number of elements \( N \) and exponent \( s \), the mean is: + * + * <p>\[ \frac{H_{N,s-1}}{H_{N,s}} \] + * + * <p>where \( H_{N,k} \) is the + * <a href="https://en.wikipedia.org/wiki/Harmonic_number#Generalized_harmonic_numbers"> + * generalized harmonic number</a> of order \( N \) of \( k \). */ @Override public double getMean() { @@ -176,13 +177,13 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution { /** * {@inheritDoc} * - * <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> - * <li>{@code Hs1 = generalizedHarmonic(N, s - 1)},</li> - * <li>{@code Hs = generalizedHarmonic(N, s)}.</li> - * </ul> + * <p>For number of elements \( N \) and exponent \( s \), the variance is: + * + * <p>\[ \frac{H_{N,s-2}}{H_{N,s}} - \frac{H_{N,s-1}^2}{H_{N,s}^2} \] + * + * <p>where \( H_{N,k} \) is the + * <a href="https://en.wikipedia.org/wiki/Harmonic_number#Generalized_harmonic_numbers"> + * generalized harmonic number</a> of order \( N \) of \( k \). */ @Override public double getVariance() {
