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 4ac4925d52821f2dc703ee7e781a5295dd4cbb83 Author: Alex Herbert <[email protected]> AuthorDate: Fri Dec 17 19:26:14 2021 +0000 Create consistent web links in distribution class javadoc. Update web links to https where applicable. --- .../distribution/AbstractContinuousDistribution.java | 2 +- .../distribution/AbstractDiscreteDistribution.java | 2 +- .../statistics/distribution/BetaDistribution.java | 8 +++++--- .../statistics/distribution/BinomialDistribution.java | 5 ++++- .../statistics/distribution/CauchyDistribution.java | 5 ++++- .../statistics/distribution/ChiSquaredDistribution.java | 5 ++++- .../statistics/distribution/ExponentialDistribution.java | 16 +++++----------- .../statistics/distribution/ExtendedPrecision.java | 2 +- .../commons/statistics/distribution/FDistribution.java | 6 +++--- .../statistics/distribution/GammaDistribution.java | 9 ++++++--- .../statistics/distribution/GeometricDistribution.java | 5 ++++- .../statistics/distribution/GumbelDistribution.java | 7 +++++-- .../distribution/HypergeometricDistribution.java | 5 ++++- .../statistics/distribution/LaplaceDistribution.java | 5 +++-- .../statistics/distribution/LevyDistribution.java | 6 ++++-- .../statistics/distribution/LogNormalDistribution.java | 5 ++++- .../statistics/distribution/LogisticDistribution.java | 5 ++++- .../statistics/distribution/NakagamiDistribution.java | 4 +++- .../statistics/distribution/NormalDistribution.java | 5 ++++- .../statistics/distribution/ParetoDistribution.java | 5 ++++- .../statistics/distribution/PascalDistribution.java | 11 +++++++---- .../statistics/distribution/PoissonDistribution.java | 5 ++++- .../statistics/distribution/RegularizedBetaUtils.java | 2 +- .../commons/statistics/distribution/TDistribution.java | 5 ++++- .../statistics/distribution/TriangularDistribution.java | 4 ++-- .../distribution/UniformContinuousDistribution.java | 7 ++++++- .../distribution/UniformDiscreteDistribution.java | 8 ++++++-- .../statistics/distribution/WeibullDistribution.java | 4 ++-- .../statistics/distribution/ZipfDistribution.java | 6 ++++-- 29 files changed, 109 insertions(+), 55 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 11f8f0c..d6670fd 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 @@ -29,7 +29,7 @@ import org.apache.commons.rng.sampling.distribution.InverseTransformContinuousSa * * <p>This base class provides a default factory method for creating * a {@link ContinuousDistribution.Sampler sampler instance} that uses the - * <a href="http://en.wikipedia.org/wiki/Inverse_transform_sampling"> + * <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling"> * inversion method</a> for generating random samples that follow the * distribution. * 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 4bb5cbc..e519bbc 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 @@ -27,7 +27,7 @@ import org.apache.commons.rng.sampling.distribution.InverseTransformDiscreteSamp * * <p>This base class provides a default factory method for creating * a {@link DiscreteDistribution.Sampler sampler instance} that uses the - * <a href="http://en.wikipedia.org/wiki/Inverse_transform_sampling"> + * <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling"> * inversion method</a> for generating random samples that follow the * distribution. * 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 742c929..0c08cbc 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 @@ -22,7 +22,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.ChengBetaSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Beta_distribution">Beta distribution</a>. + * Implementation of the beta distribution. * * <p>The probability density function of \( X \) is: * @@ -36,8 +36,10 @@ import org.apache.commons.rng.sampling.distribution.ChengBetaSampler; * * <p>where \( \Gamma \) is the gamma function. * - * <p> - * \( \alpha \) and \( \beta \) are <em>shape</em> parameters. + * <p>\( \alpha \) and \( \beta \) are <em>shape</em> parameters. + * + * @see <a href="https://en.wikipedia.org/wiki/Beta_distribution">Beta distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/BetaDistribution.html">Beta distribution (MathWorld)</a> */ public final class BetaDistribution extends AbstractContinuousDistribution { /** First shape parameter. */ 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 19698e2..766d8f5 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 @@ -19,7 +19,7 @@ package org.apache.commons.statistics.distribution; import org.apache.commons.numbers.gamma.RegularizedBeta; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Binomial_distribution">binomial distribution</a>. + * Implementation of the binomial distribution. * * <p>The probability mass function of \( X \) is: * @@ -32,6 +32,9 @@ import org.apache.commons.numbers.gamma.RegularizedBeta; * <p>\[ \binom{n}{k} = \frac{n!}{k! \, (n-k)!} \] * * <p>is the binomial coefficient. + * + * @see <a href="https://en.wikipedia.org/wiki/Binomial_distribution">Binomial distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/BinomialDistribution.html">Binomial distribution (MathWorld)</a> */ public final class BinomialDistribution extends AbstractDiscreteDistribution { /** The number of trials. */ 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 9ec0506..33603e6 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 @@ -20,7 +20,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.StableSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Cauchy_distribution">Cauchy distribution</a>. + * Implementation of the Cauchy distribution. * * <p>The probability density function of \( X \) is: * @@ -29,6 +29,9 @@ import org.apache.commons.rng.sampling.distribution.StableSampler; * <p>for \( x_0 \) the location, * \( \gamma > 0 \) the scale, and * \( x \in (-\infty, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Cauchy_distribution">Cauchy distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/CauchyDistribution.html">Cauchy distribution (MathWorld)</a> */ public final class CauchyDistribution extends AbstractContinuousDistribution { /** The location of this distribution. */ 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 1261522..a768ecd 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 @@ -19,7 +19,7 @@ package org.apache.commons.statistics.distribution; import org.apache.commons.rng.UniformRandomProvider; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Chi-squared_distribution">chi-squared distribution</a>. + * Implementation of the chi-squared distribution. * * <p>The probability density function of \( X \) is: * @@ -28,6 +28,9 @@ import org.apache.commons.rng.UniformRandomProvider; * <p>for \( k > 0 \) the degrees of freedom, * \( \Gamma(k/2) \) is the gamma function, and * \( x \in [0, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Chi-squared_distribution">Chi-squared distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/Chi-SquaredDistribution.html">Chi-squared distribution (MathWorld)</a> */ public final class ChiSquaredDistribution extends AbstractContinuousDistribution { /** Internal Gamma distribution. */ 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 123dba6..1709fce 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 @@ -20,7 +20,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.ZigguratSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Exponential_distribution">exponential distribution</a>. + * Implementation of the exponential distribution. * * <p>The probability density function of \( X \) is: * @@ -32,6 +32,9 @@ import org.apache.commons.rng.sampling.distribution.ZigguratSampler; * <p>This implementation uses the scale parameter \( \mu \) which is the mean of the distribution. * A common alternative parameterization uses the rate parameter \( \lambda \) which is the reciprocal * of the mean. + * + * @see <a href="https://en.wikipedia.org/wiki/Exponential_distribution">Exponential distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/ExponentialDistribution.html">Exponential distribution (MathWorld)</a> */ public final class ExponentialDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ @@ -85,16 +88,7 @@ public final class ExponentialDistribution extends AbstractContinuousDistributio return -x / mean - logMean; } - /** - * {@inheritDoc} - * - * <p>The implementation of this method is based on: - * <ul> - * <li> - * <a href="http://mathworld.wolfram.com/ExponentialDistribution.html"> - * Exponential Distribution</a>, equation (1).</li> - * </ul> - */ + /** {@inheritDoc} */ @Override public double cumulativeProbability(double x) { if (x <= SUPPORT_LO) { diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExtendedPrecision.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExtendedPrecision.java index c12e7d0..4fdbec2 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExtendedPrecision.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/ExtendedPrecision.java @@ -227,7 +227,7 @@ final class ExtendedPrecision { * @param ly Low part of second factor. * @param xy Product of the factors. * @return <code>lx * ly - (((xy - hx * hy) - lx * hy) - hx * ly)</code> - * @see <a href="http://www-2.cs.cmu.edu/afs/cs/project/quake/public/papers/robust-arithmetic.ps"> + * @see <a href="https://www-2.cs.cmu.edu/afs/cs/project/quake/public/papers/robust-arithmetic.ps"> * Shewchuk (1997) Theorum 18</a> */ private static double productLow(double hx, double lx, double hy, double ly, double xy) { 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 19b5df3..1a39bd4 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 @@ -30,8 +30,8 @@ import org.apache.commons.numbers.gamma.RegularizedBeta; * <p>for \( d_1, d_2 > 0 \) the degrees of freedom, \( \operatorname{B}(d_1 / 2, d_2 / 2) \) is the beta function, * and \( x \in [0, \infty) \). * - * @see <a href="http://en.wikipedia.org/wiki/F-distribution">F-distribution (Wikipedia)</a> - * @see <a href="http://mathworld.wolfram.com/F-Distribution.html">F-distribution (MathWorld)</a> + * @see <a href="https://en.wikipedia.org/wiki/F-distribution">F-distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/F-Distribution.html">F-distribution (MathWorld)</a> */ public final class FDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ @@ -164,7 +164,7 @@ public final class FDistribution extends AbstractContinuousDistribution { * <p>The implementation of this method is based on * <ul> * <li> - * <a href="http://mathworld.wolfram.com/F-Distribution.html"> + * <a href="https://mathworld.wolfram.com/F-Distribution.html"> * F-Distribution</a>, equation (4). * </li> * </ul> 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 12f94cd..cfe4ab9 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 @@ -22,14 +22,17 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.AhrensDieterMarsagliaTsangGammaSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Gamma_distribution">gamma distribution</a>. + * Implementation of the gamma distribution. * * <p>The probability density function of \( X \) is: * - * <p>\[ f(x;k,\theta) = \frac{x^{k-1}e^{-x/\theta}}{\theta^k\Gamma(k)} \] + * <p>\[ f(x;k,\theta) = \frac{x^{k-1}e^{-x/\theta}}{\theta^k\Gamma(k)} \] * * <p>for \( k > 0 \) the shape, \( \theta > 0 \) the scale, \( \Gamma(k) \) is the gamma function * and \( x \in (0, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Gamma_distribution">Gamma distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/GammaDistribution.html">Gamma distribution (MathWorld)</a> */ public final class GammaDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ @@ -157,7 +160,7 @@ public final class GammaDistribution extends AbstractContinuousDistribution { * <p>The implementation of this method is based on: * <ul> * <li> - * <a href="http://mathworld.wolfram.com/Chi-SquaredDistribution.html"> + * <a href="https://mathworld.wolfram.com/Chi-SquaredDistribution.html"> * Chi-Squared Distribution</a>, equation (9). * </li> * <li>Casella, G., & Berger, R. (1990). <i>Statistical Inference</i>. 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 b7bc116..f9ed53b 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 @@ -21,7 +21,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.GeometricSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Geometric_distribution">geometric distribution</a>. + * Implementation of the geometric distribution. * * <p>The probability mass function of \( X \) is: * @@ -32,6 +32,9 @@ import org.apache.commons.rng.sampling.distribution.GeometricSampler; * * <p>This parameterization is used to model the number of failures until * the first success. + * + * @see <a href="https://en.wikipedia.org/wiki/Geometric_distribution">Geometric distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/GeometricDistribution.html">Geometric distribution (MathWorld)</a> */ public final class GeometricDistribution extends AbstractDiscreteDistribution { /** 1/2. */ 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 b44e6e4..decdc2e 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 @@ -17,7 +17,7 @@ package org.apache.commons.statistics.distribution; /** - * This class implements the <a href="http://en.wikipedia.org/wiki/Gumbel_distribution">Gumbel distribution</a>. + * Implementation of the Gumbel distribution. * * <p>The probability density function of \( X \) is: * @@ -28,6 +28,9 @@ package org.apache.commons.statistics.distribution; * <p>for \( \mu \) the location, * \( \beta > 0 \) the scale, and * \( x \in (-\infty, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Gumbel_distribution">Gumbel distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/GumbelDistribution.html">Gumbel distribution (MathWorld)</a> */ public final class GumbelDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ @@ -158,7 +161,7 @@ public final class GumbelDistribution extends AbstractContinuousDistribution { * {@inheritDoc} * * <p>The mean is {@code mu + gamma * beta}, where {@code gamma} is - * <a href="http://mathworld.wolfram.com/Euler-MascheroniConstantApproximations.html"> + * <a href="https://mathworld.wolfram.com/Euler-MascheroniConstantApproximations.html"> * Euler's constant</a> */ @Override 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 f551a1f..1a5c954 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 @@ -18,7 +18,7 @@ package org.apache.commons.statistics.distribution; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Hypergeometric_distribution">hypergeometric distribution</a>. + * Implementation of the hypergeometric distribution. * * <p>The probability mass function of \( X \) is: * @@ -32,6 +32,9 @@ package org.apache.commons.statistics.distribution; * <p>\[ \binom{a}{b} = \frac{a!}{b! \, (a-b)!} \] * * <p>is the binomial coefficient. + * + * @see <a href="https://en.wikipedia.org/wiki/Hypergeometric_distribution">Hypergeometric distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/HypergeometricDistribution.html">Hypergeometric distribution (MathWorld)</a> */ public final class HypergeometricDistribution extends AbstractDiscreteDistribution { /** The number of successes in the population. */ 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 675a90e..5201355 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 @@ -17,7 +17,7 @@ package org.apache.commons.statistics.distribution; /** - * This class implements the Laplace distribution. + * Implementation of the Laplace distribution. * * <p>The probability density function of \( X \) is: * @@ -27,7 +27,8 @@ package org.apache.commons.statistics.distribution; * \( b > 0 \) the scale, and * \( x \in (-\infty, \infty) \). * - * @see <a href="http://en.wikipedia.org/wiki/Laplace_distribution">Laplace distribution (Wikipedia)</a> + * @see <a href="https://en.wikipedia.org/wiki/Laplace_distribution">Laplace distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/LaplaceDistribution.html">Laplace distribution (MathWorld)</a> */ public final class LaplaceDistribution extends AbstractContinuousDistribution { /** The location parameter. */ 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 83644c6..876e506 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 @@ -24,8 +24,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.LevySampler; /** - * This class implements the <a href="http://en.wikipedia.org/wiki/L%C3%A9vy_distribution"> - * Lévy distribution</a>. + * Implementation of the Lévy distribution. * * <p>The probability density function of \( X \) is: * @@ -34,6 +33,9 @@ import org.apache.commons.rng.sampling.distribution.LevySampler; * <p>for \( \mu \) the location, * \( c > 0 \) the scale, and * \( x \in [\mu, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/L%C3%A9vy_distribution">Lévy distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/LevyDistribution.html">Lévy distribution (MathWorld)</a> */ public final class LevyDistribution extends AbstractContinuousDistribution { /** 1 / 2(erfc^-1 (0.5))^2. Computed using Matlab's VPA to 30 digits. */ 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 fb285d1..2426e4b 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 @@ -24,7 +24,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.ZigguratSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Log-normal_distribution">log-normal distribution</a>. + * Implementation of the log-normal distribution. * * <p>\( X \) is log-normally distributed if its natural logarithm \( \ln(x) \) * is normally distributed. The probability density function of \( X \) is: @@ -35,6 +35,9 @@ import org.apache.commons.rng.sampling.distribution.ZigguratSampler; * \( \sigma > 0 \) the standard deviation of the normally distributed natural logarithm of this * distribution, and * \( x \in (0, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Log-normal_distribution">Log-normal distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/LogNormalDistribution.html">Log-normal distribution (MathWorld)</a> */ public final class LogNormalDistribution extends AbstractContinuousDistribution { /** 0.5 * ln(2 * pi). Computed to 25-digits precision. */ 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 57332fe..0495f16 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 @@ -17,7 +17,7 @@ package org.apache.commons.statistics.distribution; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Logistic_distribution">logistic distribution</a>. + * Implementation of the logistic distribution. * * <p>The probability density function of \( X \) is: * @@ -26,6 +26,9 @@ package org.apache.commons.statistics.distribution; * <p>for \( \mu \) the location, * \( s > 0 \) the scale, and * \( x \in (-\infty, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Logistic_distribution">Logistic distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/LogisticDistribution.html">Logistic distribution (MathWorld)</a> */ public final class LogisticDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ 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 f8c64a5..7d3f406 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 @@ -21,7 +21,7 @@ import org.apache.commons.numbers.gamma.LogGamma; import org.apache.commons.numbers.gamma.RegularizedGamma; /** - * This class implements the <a href="http://en.wikipedia.org/wiki/Nakagami_distribution">Nakagami distribution</a>. + * Implementation of the Nakagami distribution. * * <p>The probability density function of \( X \) is: * @@ -30,6 +30,8 @@ import org.apache.commons.numbers.gamma.RegularizedGamma; * <p>for \( \mu > 0 \) the shape, * \( \Omega > 0 \) the scale, and * \( x \in (0, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Nakagami_distribution">Nakagami distribution (Wikipedia)</a> */ public final class NakagamiDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ 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 133d1fa..1d93acb 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 @@ -25,7 +25,7 @@ import org.apache.commons.rng.sampling.distribution.GaussianSampler; import org.apache.commons.rng.sampling.distribution.ZigguratSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Normal_distribution">normal (Gaussian) distribution</a>. + * Implementation of the normal (Gaussian) distribution. * * <p>The probability density function of \( X \) is: * @@ -34,6 +34,9 @@ import org.apache.commons.rng.sampling.distribution.ZigguratSampler; * <p>for \( \mu \) the mean, * \( \sigma > 0 \) the standard deviation, and * \( x \in (-\infty, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Normal_distribution">Normal distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/NormalDistribution.html">Normal distribution (MathWorld)</a> */ public final class NormalDistribution extends AbstractContinuousDistribution { /** 0.5 * ln(2 * pi). Computed to 25-digits precision. */ 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 bc58ec7..f9dcfe7 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 @@ -22,7 +22,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.InverseTransformParetoSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Pareto_distribution">Pareto (Type I) distribution</a>. + * Implementation of the Pareto (Type I) distribution. * * <p>The probability density function of \( X \) is: * @@ -34,6 +34,9 @@ import org.apache.commons.rng.sampling.distribution.InverseTransformParetoSample * * <p>\( k \) is a <em>scale</em> parameter: this is the minimum possible value of \( X \). * <br>\( \alpha \) is a <em>shape</em> parameter: this is the Pareto index. + * + * @see <a href="https://en.wikipedia.org/wiki/Pareto_distribution">Pareto distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/ParetoDistribution.html">Pareto distribution (MathWorld)</a> */ public final class ParetoDistribution extends AbstractContinuousDistribution { /** The minimum value for the shape parameter when computing when computing the variance. */ 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 40e31e5..136f867 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 @@ -21,18 +21,18 @@ import org.apache.commons.numbers.combinatorics.LogBinomialCoefficient; import org.apache.commons.numbers.gamma.RegularizedBeta; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Negative_binomial_distribution">Pascal distribution.</a> + * Implementation of the Pascal distribution. * - * <p>The Pascal distribution is a special case of the Negative Binomial distribution + * <p>The Pascal distribution is a special case of the negative binomial distribution * where the number of successes parameter is an integer. * * <p>There are various ways to express the probability mass and distribution * functions for the Pascal distribution. The present implementation represents * the distribution of the number of failures before \( r \) successes occur. * This is the convention adopted in e.g. - * <a href="http://mathworld.wolfram.com/NegativeBinomialDistribution.html">MathWorld</a>, + * <a href="https://mathworld.wolfram.com/NegativeBinomialDistribution.html">MathWorld</a>, * but <em>not</em> in - * <a href="http://en.wikipedia.org/wiki/Negative_binomial_distribution">Wikipedia</a>. + * <a href="https://en.wikipedia.org/wiki/Negative_binomial_distribution">Wikipedia</a>. * * <p>The probability mass function of \( X \) is: * @@ -55,6 +55,9 @@ import org.apache.commons.numbers.gamma.RegularizedBeta; * <p>\[ P(X \leq k) = I(p, r, k + 1) \] * * <p>where \( I \) is the regularized incomplete beta function. + * + * @see <a href="https://en.wikipedia.org/wiki/Negative_binomial_distribution">Negative binomial distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/NegativeBinomialDistribution.html">Negative binomial distribution (MathWorld)</a> */ public final class PascalDistribution extends AbstractDiscreteDistribution { /** The number of successes. */ 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 85a2b1a..9224ad1 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 @@ -24,7 +24,7 @@ import org.apache.commons.rng.sampling.distribution.SharedStateContinuousSampler import org.apache.commons.rng.sampling.distribution.ZigguratSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Poisson_distribution">Poisson distribution</a>. + * Implementation of the Poisson distribution. * * <p>The probability mass function of \( X \) is: * @@ -32,6 +32,9 @@ import org.apache.commons.rng.sampling.distribution.ZigguratSampler; * * <p>for \( \lambda \in (0, \infty) \) the mean and * \( k \in \{0, 1, 2, \dots\} \) the number of events. + * + * @see <a href="https://en.wikipedia.org/wiki/Poisson_distribution">Poisson distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/PoissonDistribution.html">Poisson distribution (MathWorld)</a> */ public final class PoissonDistribution extends AbstractDiscreteDistribution { /** 0.5 * ln(2 * pi). Computed to 25-digits precision. */ diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/RegularizedBetaUtils.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/RegularizedBetaUtils.java index 646f77d..c049563 100644 --- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/RegularizedBetaUtils.java +++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/RegularizedBetaUtils.java @@ -19,7 +19,7 @@ package org.apache.commons.statistics.distribution; import org.apache.commons.numbers.gamma.RegularizedBeta; /** - * Utilities for the <a href="http://mathworld.wolfram.com/RegularizedBetaFunction.html"> + * Utilities for the <a href="https://mathworld.wolfram.com/RegularizedBetaFunction.html"> * Regularized Beta function</a> {@code I(x, a, b)}. */ final class RegularizedBetaUtils { 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 0eeb1e5..d810509 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 @@ -21,7 +21,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.numbers.gamma.LogGamma; /** - * Implementation of <a href='http://en.wikipedia.org/wiki/Student's_t-distribution'>Student's t-distribution</a>. + * Implementation of Student's t-distribution. * * <p>The probability density function of \( X \) is: * @@ -30,6 +30,9 @@ import org.apache.commons.numbers.gamma.LogGamma; * <p>for \( v > 0 \) the degrees of freedom, * \( \Gamma \) is the gamma function, and * \( x \in (-\infty, \infty) \). + * + * @see <a href="https://en.wikipedia.org/wiki/Student%27s_t-distribution">Student's t-distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/Studentst-Distribution.html">Student's t-distribution (MathWorld)</a> */ public abstract class TDistribution extends AbstractContinuousDistribution { /** A standard normal distribution used for calculations. 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 baa18c2..058c4ae 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 @@ -31,8 +31,8 @@ package org.apache.commons.statistics.distribution; * <p>for \( -\infty \lt a \le c \le b \lt \infty \) and * \( x \in [a, b] \). * - * @see <a href="http://en.wikipedia.org/wiki/Triangular_distribution"> - * Triangular distribution (Wikipedia)</a> + * @see <a href="https://en.wikipedia.org/wiki/Triangular_distribution">Triangular distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/TriangularDistribution.html">Triangular distribution (MathWorld)</a> */ public final class TriangularDistribution extends AbstractContinuousDistribution { /** Lower limit of this distribution (inclusive). */ 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 d7fccf6..2787070 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 @@ -21,7 +21,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.ContinuousUniformSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Uniform_distribution_(continuous)">uniform distribution</a>. + * Implementation of the uniform distribution. * * <p>The probability density function of \( X \) is: * @@ -29,6 +29,11 @@ import org.apache.commons.rng.sampling.distribution.ContinuousUniformSampler; * * <p>for \( -\infty \lt a \lt b \lt \infty \) and * \( x \in [a, b] \). + * + * @see <a href="https://en.wikipedia.org/wiki/Uniform_distribution_(continuous)"> + * Uniform distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/UniformDistribution.html"> + * Uniform distribution (MathWorld)</a> */ public final class UniformContinuousDistribution extends AbstractContinuousDistribution { /** Lower bound of this distribution (inclusive). */ 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 5624324..1b6c528 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 @@ -21,8 +21,7 @@ import org.apache.commons.rng.UniformRandomProvider; import org.apache.commons.rng.sampling.distribution.DiscreteUniformSampler; /** - * Implementation of the <a href="http://en.wikipedia.org/wiki/Uniform_distribution_(discrete)"> - * uniform integer distribution</a>. + * Implementation of the uniform discrete distribution. * * <p>The probability mass function of \( X \) is: * @@ -30,6 +29,11 @@ import org.apache.commons.rng.sampling.distribution.DiscreteUniformSampler; * * <p>for integer \( a, b \) and \( a \le b \) and * \( k \in [a, b] \). + * + * @see <a href="https://en.wikipedia.org/wiki/Uniform_distribution_(discrete)"> + * Uniform distribution (discrete) (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/DiscreteUniformDistribution.html"> + * Discrete uniform distribution (MathWorld)</a> */ public final class UniformDiscreteDistribution extends AbstractDiscreteDistribution { /** Lower bound (inclusive) of this distribution. */ 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 5ac33e7..eb29633 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 @@ -38,8 +38,8 @@ import org.apache.commons.rng.sampling.distribution.ZigguratSampler; * <li>\( k = 2 \) is the Rayleigh distribution with scale \( \sigma = \frac {\lambda}{\sqrt{2}} \) * </ul> * - * @see <a href="http://en.wikipedia.org/wiki/Weibull_distribution">Weibull distribution (Wikipedia)</a> - * @see <a href="http://mathworld.wolfram.com/WeibullDistribution.html">Weibull distribution (MathWorld)</a> + * @see <a href="https://en.wikipedia.org/wiki/Weibull_distribution">Weibull distribution (Wikipedia)</a> + * @see <a href="https://mathworld.wolfram.com/WeibullDistribution.html">Weibull distribution (MathWorld)</a> */ public final class WeibullDistribution extends AbstractContinuousDistribution { /** Support lower bound. */ 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 0a2f26c..15c7412 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 @@ -22,7 +22,7 @@ import org.apache.commons.rng.sampling.distribution.DiscreteUniformSampler; import org.apache.commons.rng.sampling.distribution.RejectionInversionZipfSampler; /** - * Implementation of the <a href="https://en.wikipedia.org/wiki/Zipf's_law">Zipf distribution</a>. + * Implementation of the Zipf distribution. * * <p>The probability mass function of \( X \) is: * @@ -34,6 +34,8 @@ import org.apache.commons.rng.sampling.distribution.RejectionInversionZipfSample * \( H_{N,s} \) is the normalizing constant which corresponds to the * <a href="https://en.wikipedia.org/wiki/Harmonic_number#Generalized_harmonic_numbers"> * generalized harmonic number</a> of order N of s. + * + * @see <a href="https://en.wikipedia.org/wiki/Zipf's_law">Zipf distribution (Wikipedia)</a> */ public final class ZipfDistribution extends AbstractDiscreteDistribution { /** Number of elements. */ @@ -197,7 +199,7 @@ public final class ZipfDistribution extends AbstractDiscreteDistribution { /** * Calculates the Nth generalized harmonic number. See - * <a href="http://mathworld.wolfram.com/HarmonicSeries.html">Harmonic + * <a href="https://mathworld.wolfram.com/HarmonicSeries.html">Harmonic * Series</a>. * * <p>Assumes {@code exponent > 0} to arrange the terms to sum from small to large.
