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 af42b0da954482133d158b10e6472f8d83da3841
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Mon Aug 2 23:37:56 2021 +0100
Javadoc for the support
---
.../distribution/GumbelDistribution.java | 28 +++++++++++++++++++---
.../distribution/LaplaceDistribution.java | 28 +++++++++++++++++++---
.../statistics/distribution/LevyDistribution.java | 26 +++++++++++++++++---
.../distribution/LogisticDistribution.java | 28 +++++++++++++++++++---
.../distribution/NakagamiDistribution.java | 26 +++++++++++++++++---
.../distribution/ParetoDistribution.java | 2 +-
.../distribution/TruncatedNormalDistribution.java | 8 ++++++-
7 files changed, 129 insertions(+), 17 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 fc9551a..6b9ecdb 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
@@ -134,19 +134,41 @@ public class GumbelDistribution extends
AbstractContinuousDistribution {
return PI_SQUARED_OVER_SIX * beta * beta;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The lower bound of the support is always negative infinity
+ * no matter the parameters.
+ *
+ * @return lower bound of the support (always
+ * {@code Double.NEGATIVE_INFINITY})
+ */
@Override
public double getSupportLowerBound() {
return SUPPORT_LO;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The upper bound of the support is always positive infinity
+ * no matter the parameters.
+ *
+ * @return upper bound of the support (always
+ * {@code Double.POSITIVE_INFINITY})
+ */
@Override
public double getSupportUpperBound() {
return SUPPORT_HI;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The support of this distribution is connected.
+ *
+ * @return {@code true}
+ */
@Override
public boolean isSupportConnected() {
return true;
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 efccfd4..afbfe8a 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
@@ -122,19 +122,41 @@ public class LaplaceDistribution extends
AbstractContinuousDistribution {
return 2.0 * beta * beta;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The lower bound of the support is always negative infinity
+ * no matter the parameters.
+ *
+ * @return lower bound of the support (always
+ * {@code Double.NEGATIVE_INFINITY})
+ */
@Override
public double getSupportLowerBound() {
return Double.NEGATIVE_INFINITY;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The upper bound of the support is always positive infinity
+ * no matter the parameters.
+ *
+ * @return upper bound of the support (always
+ * {@code Double.POSITIVE_INFINITY})
+ */
@Override
public double getSupportUpperBound() {
return Double.POSITIVE_INFINITY;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The support of this distribution is connected.
+ *
+ * @return {@code true}
+ */
@Override
public boolean isSupportConnected() {
return true;
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 50565db..ddc3504 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
@@ -151,19 +151,39 @@ public class LevyDistribution extends
AbstractContinuousDistribution {
return Double.POSITIVE_INFINITY;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The lower bound of the support is the {@link #getLocation()
location}.
+ *
+ * @return lower bound of the support
+ */
@Override
public double getSupportLowerBound() {
return getLocation();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The upper bound of the support is always positive infinity
+ * no matter the parameters.
+ *
+ * @return upper bound of the support (always
+ * {@code Double.POSITIVE_INFINITY})
+ */
@Override
public double getSupportUpperBound() {
return Double.POSITIVE_INFINITY;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The support of this distribution is connected.
+ *
+ * @return {@code true}
+ */
@Override
public boolean isSupportConnected() {
return true;
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 f945274..38111bf 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
@@ -137,19 +137,41 @@ public class LogisticDistribution extends
AbstractContinuousDistribution {
return scale * scale * PI_SQUARED_OVER_THREE;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The lower bound of the support is always negative infinity
+ * no matter the parameters.
+ *
+ * @return lower bound of the support (always
+ * {@code Double.NEGATIVE_INFINITY})
+ */
@Override
public double getSupportLowerBound() {
return SUPPORT_LO;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The upper bound of the support is always positive infinity
+ * no matter the parameters.
+ *
+ * @return upper bound of the support (always
+ * {@code Double.POSITIVE_INFINITY})
+ */
@Override
public double getSupportUpperBound() {
return SUPPORT_HI;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The support of this distribution is connected.
+ *
+ * @return {@code true}
+ */
@Override
public boolean isSupportConnected() {
return true;
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 3dabb44..b71c41a 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
@@ -142,19 +142,39 @@ public class NakagamiDistribution extends
AbstractContinuousDistribution {
return omega * (1 - 1 / mu * v * v);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The lower bound of the support is always 0 no matter parameters.
+ *
+ * @return lower bound of the support (always 0)
+ */
@Override
public double getSupportLowerBound() {
return SUPPORT_LO;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The upper bound of the support is always positive infinity
+ * no matter the parameters.
+ *
+ * @return upper bound of the support (always
+ * {@code Double.POSITIVE_INFINITY})
+ */
@Override
public double getSupportUpperBound() {
return SUPPORT_HI;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The support of this distribution is connected.
+ *
+ * @return {@code true}
+ */
@Override
public boolean isSupportConnected() {
return true;
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 9dfc5fe..7be4094 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
@@ -206,7 +206,7 @@ public class ParetoDistribution extends
AbstractContinuousDistribution {
/**
* {@inheritDoc}
- * <p>
+ *
* <p>The support of this distribution is connected.
*
* @return {@code true}
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 08de808..4f17d8b 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
@@ -201,7 +201,13 @@ public class TruncatedNormalDistribution extends
AbstractContinuousDistribution
return upper;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * <p>The support of this distribution is connected.
+ *
+ * @return {@code true}
+ */
@Override
public boolean isSupportConnected() {
return true;
