You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2022/11/29 16:26:41 UTC
[commons-statistics] 03/14: Remove redundant javadoc describing the sampler
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 b72d83e78349e64908e8b8e9baa7aa2a3a39fb56
Author: aherbert <ah...@apache.org>
AuthorDate: Tue Nov 29 13:36:30 2022 +0000
Remove redundant javadoc describing the sampler
The sampler details are documented in the underlying RNG library.
---
.../statistics/distribution/BetaDistribution.java | 13 +----------
.../distribution/ChiSquaredDistribution.java | 25 +---------------------
.../statistics/distribution/GammaDistribution.java | 25 +---------------------
3 files changed, 3 insertions(+), 60 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 307a00a..2b76571 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
@@ -232,18 +232,7 @@ public final class BetaDistribution extends AbstractContinuousDistribution {
return 1;
}
- /**
- * {@inheritDoc}
- *
- * <p>Sampling is performed using Cheng's algorithm:
- * <blockquote>
- * <pre>
- * R. C. H. Cheng,
- * "Generating beta variates with nonintegral shape parameters",
- * Communications of the ACM, 21, 317-322, 1978.
- * </pre>
- * </blockquote>
- */
+ /** {@inheritDoc} */
@Override
public ContinuousDistribution.Sampler createSampler(final UniformRandomProvider rng) {
// Beta distribution sampler.
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 0c305cb..aed3452 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
@@ -159,30 +159,7 @@ public final class ChiSquaredDistribution extends AbstractContinuousDistribution
return Double.POSITIVE_INFINITY;
}
- /**
- * {@inheritDoc}
- *
- * <p>
- * Sampling algorithms:
- * <ul>
- * <li>
- * For {@code 0 < degreesOfFreedom < 2}:
- * <blockquote>
- * Ahrens, J. H. and Dieter, U.,
- * <i>Computer methods for sampling from gamma, beta, Poisson and binomial distributions,</i>
- * Computing, 12, 223-246, 1974.
- * </blockquote>
- * </li>
- * <li>
- * For {@code degreesOfFreedom >= 2}:
- * <blockquote>
- * Marsaglia and Tsang, <i>A Simple Method for Generating
- * Gamma Variables.</i> ACM Transactions on Mathematical Software,
- * Volume 26 Issue 3, September, 2000.
- * </blockquote>
- * </li>
- * </ul>
- */
+ /** {@inheritDoc} */
@Override
public ContinuousDistribution.Sampler createSampler(final UniformRandomProvider rng) {
return gamma.createSampler(rng);
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 79f0aa4..58966ee 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
@@ -241,30 +241,7 @@ public final class GammaDistribution extends AbstractContinuousDistribution {
return SUPPORT_HI;
}
- /**
- * {@inheritDoc}
- *
- * <p>
- * Sampling algorithms:
- * <ul>
- * <li>
- * For {@code 0 < shape < 1}:
- * <blockquote>
- * Ahrens, J. H. and Dieter, U.,
- * <i>Computer methods for sampling from gamma, beta, Poisson and binomial distributions,</i>
- * Computing, 12, 223-246, 1974.
- * </blockquote>
- * </li>
- * <li>
- * For {@code shape >= 1}:
- * <blockquote>
- * Marsaglia and Tsang, <i>A Simple Method for Generating
- * Gamma Variables.</i> ACM Transactions on Mathematical Software,
- * Volume 26 Issue 3, September, 2000.
- * </blockquote>
- * </li>
- * </ul>
- */
+ /** {@inheritDoc} */
@Override
public ContinuousDistribution.Sampler createSampler(final UniformRandomProvider rng) {
// Gamma distribution sampler.