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/01/21 17:02:29 UTC
[commons-statistics] 02/03: Remove HTML for the PDF/CDF in the javadoc
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 072075a3542107e7753d1e6f9822d23ec3fd7281
Author: aherbert <ah...@apache.org>
AuthorDate: Fri Jan 21 16:42:45 2022 +0000
Remove HTML for the PDF/CDF in the javadoc
The PDF is defined in the class header using mathjax.
No CDFs are defined for any distribution and removing this is more
consistent with the current javadoc.
---
.../statistics/distribution/LevyDistribution.java | 34 +++++-----------------
1 file changed, 8 insertions(+), 26 deletions(-)
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 4a8b7ec..5bdf5c3 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
@@ -93,20 +93,12 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
return c;
}
- /** {@inheritDoc}
- * <p>
- * From Wikipedia: The probability density function of the Lévy distribution
- * over the domain is
- * </p>
- * <div style="white-space: pre"><code>
- * f(x; μ, c) = √(c / 2π) * e<sup>-c / 2 (x - μ)</sup> / (x - μ)<sup>3/2</sup>
- * </code></div>
- * <p>
- * For this distribution, {@code X}, this method returns {@code P(X < x)}.
- * If {@code x} is less than location parameter μ, {@code 0} is
- * returned, as in these cases the distribution is not defined.
- * </p>
- */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>If {@code x} is less than the location parameter then {@code 0} is
+ * returned, as in these cases the distribution is not defined.
+ */
@Override
public double density(final double x) {
if (x <= mu) {
@@ -122,10 +114,7 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
return Math.sqrt(f / Math.PI) * Math.exp(-f) / delta;
}
- /** {@inheritDoc}
- *
- * <p>See documentation of {@link #density(double)} for computation details.
- */
+ /** {@inheritDoc} */
@Override
public double logDensity(double x) {
if (x <= mu) {
@@ -137,14 +126,7 @@ public final class LevyDistribution extends AbstractContinuousDistribution {
return 0.5 * Math.log(f / Math.PI) - f - Math.log(delta);
}
- /** {@inheritDoc}
- * <p>
- * From Wikipedia: the cumulative distribution function is
- * </p>
- * <pre>
- * f(x; u, c) = erfc (√ (c / 2 (x - u )))
- * </pre>
- */
+ /** {@inheritDoc} */
@Override
public double cumulativeProbability(final double x) {
if (x <= mu) {