[commons-statistics] 03/07: Javadoc for the moments

[aherbert]

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 d49248ce42f3094a2ee6dae7a8feee47db9f3272
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Mon Aug 2 23:58:35 2021 +0100

    Javadoc for the moments
---
 .../statistics/distribution/GumbelDistribution.java        | 14 ++++++++++++--
 .../statistics/distribution/LaplaceDistribution.java       | 12 ++++++++++--
 .../commons/statistics/distribution/LevyDistribution.java  | 12 ++++++++++--
 .../statistics/distribution/LogisticDistribution.java      | 12 ++++++++++--
 4 files changed, 42 insertions(+), 8 deletions(-)

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 6b9ecdb..b945649 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
@@ -122,13 +122,23 @@ public class GumbelDistribution extends 
AbstractContinuousDistribution {
         return mu - Math.log(-Math.log(p)) * beta;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The mean is {@code mu + gamma * beta}, where {@code gamma} is
+     * <a 
href="http://mathworld.wolfram.com/Euler-MascheroniConstantApproximations.html";>
+     * Euler's constant</a>
+     */
     @Override
     public double getMean() {
         return mu + EULER * beta;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The variance is {@code pi^2 * beta^2 / 6}.
+     */
     @Override
     public double getVariance() {
         return PI_SQUARED_OVER_SIX * beta * beta;
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 afbfe8a..ebcd0dc 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
@@ -110,13 +110,21 @@ public class LaplaceDistribution extends 
AbstractContinuousDistribution {
         return mu + beta * x;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The mean is equal to the {@link #getLocation() location}.
+     */
     @Override
     public double getMean() {
         return getLocation();
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The variance is {@code 2 * beta^2}.
+     */
     @Override
     public double getVariance() {
         return 2.0 * beta * beta;
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 ddc3504..286d6eb 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
@@ -139,13 +139,21 @@ public class LevyDistribution extends 
AbstractContinuousDistribution {
         return mu + halfC / (t * t);
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The mean is equal to positive infinity.
+     */
     @Override
     public double getMean() {
         return Double.POSITIVE_INFINITY;
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The variance is equal to positive infinity.
+     */
     @Override
     public double getVariance() {
         return Double.POSITIVE_INFINITY;
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 38111bf..bee2c7c 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
@@ -125,13 +125,21 @@ public class LogisticDistribution extends 
AbstractContinuousDistribution {
         }
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>The mean is equal to the {@link #getLocation() location}.
+     */
     @Override
     public double getMean() {
         return getLocation();
     }
 
-    /** {@inheritDoc} */
+    /**
+     * {@inheritDoc}
+     *
+     * <p>For scale parameter {@code s}, the variance is {@code s^2 * pi^2 / 
3}.
+     */
     @Override
     public double getVariance() {
         return scale * scale * PI_SQUARED_OVER_THREE;