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 6e1da4adff405f26b4d632e5245064b5d0f4cfb4
Author: aherbert <aherb...@apache.org>
AuthorDate: Wed Nov 30 12:10:58 2022 +0000
Javadoc link to infinity
---
.../commons/statistics/distribution/CauchyDistribution.java | 8 ++++----
.../commons/statistics/distribution/ChiSquaredDistribution.java | 2 +-
.../commons/statistics/distribution/ExponentialDistribution.java | 2 +-
.../org/apache/commons/statistics/distribution/FDistribution.java | 6 +++---
.../apache/commons/statistics/distribution/GammaDistribution.java | 2 +-
.../commons/statistics/distribution/GumbelDistribution.java | 4 ++--
.../commons/statistics/distribution/LaplaceDistribution.java | 4 ++--
.../apache/commons/statistics/distribution/LevyDistribution.java | 6 +++---
.../commons/statistics/distribution/LogNormalDistribution.java | 2 +-
.../commons/statistics/distribution/LogisticDistribution.java | 4 ++--
.../commons/statistics/distribution/NakagamiDistribution.java | 2 +-
.../commons/statistics/distribution/NormalDistribution.java | 4 ++--
.../commons/statistics/distribution/ParetoDistribution.java | 2 +-
.../org/apache/commons/statistics/distribution/TDistribution.java | 8 ++++----
.../commons/statistics/distribution/WeibullDistribution.java | 2 +-
15 files changed, 29 insertions(+), 29 deletions(-)
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 000bc14..4fb46f9 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
@@ -156,7 +156,7 @@ public final class CauchyDistribution extends
AbstractContinuousDistribution {
*
* <p>The mean is always undefined.
*
- * @return NaN.
+ * @return {@link Double#NaN NaN}.
*/
@Override
public double getMean() {
@@ -168,7 +168,7 @@ public final class CauchyDistribution extends
AbstractContinuousDistribution {
*
* <p>The variance is always undefined.
*
- * @return NaN.
+ * @return {@link Double#NaN NaN}.
*/
@Override
public double getVariance() {
@@ -180,7 +180,7 @@ public final class CauchyDistribution extends
AbstractContinuousDistribution {
*
* <p>The lower bound of the support is always negative infinity.
*
- * @return negative infinity.
+ * @return {@link Double#NEGATIVE_INFINITY negative infinity}.
*/
@Override
public double getSupportLowerBound() {
@@ -192,7 +192,7 @@ public final class CauchyDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 aed3452..3a2daaf 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
@@ -152,7 +152,7 @@ public final class ChiSquaredDistribution extends
AbstractContinuousDistribution
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 4416b74..13bef64 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
@@ -171,7 +171,7 @@ public final class ExponentialDistribution extends
AbstractContinuousDistributio
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 8058de9..39739e9 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
@@ -287,7 +287,7 @@ public final class FDistribution extends
AbstractContinuousDistribution {
* \text{undefined} & \text{otherwise}
* \end{cases} \]
*
- * @return the mean, or {@code NaN} if it is not defined.
+ * @return the mean, or {@link Double#NaN NaN} if it is not defined.
*/
@Override
public double getMean() {
@@ -305,7 +305,7 @@ public final class FDistribution extends
AbstractContinuousDistribution {
* \text{undefined} & \text{otherwise}
* \end{cases} \]
*
- * @return the variance, or {@code NaN} if it is not defined.
+ * @return the variance, or {@link Double#NaN NaN} if it is not defined.
*/
@Override
public double getVariance() {
@@ -329,7 +329,7 @@ public final class FDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 58966ee..92e5061 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
@@ -234,7 +234,7 @@ public final class GammaDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 58df245..aa5223b 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
@@ -190,7 +190,7 @@ public final class GumbelDistribution extends
AbstractContinuousDistribution {
*
* <p>The lower bound of the support is always negative infinity.
*
- * @return negative infinity.
+ * @return {@link Double#NEGATIVE_INFINITY negative infinity}.
*/
@Override
public double getSupportLowerBound() {
@@ -202,7 +202,7 @@ public final class GumbelDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 d341e14..4fb06da 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
@@ -165,7 +165,7 @@ public final class LaplaceDistribution extends
AbstractContinuousDistribution {
*
* <p>The lower bound of the support is always negative infinity.
*
- * @return negative infinity.
+ * @return {@link Double#NEGATIVE_INFINITY negative infinity}.
*/
@Override
public double getSupportLowerBound() {
@@ -177,7 +177,7 @@ public final class LaplaceDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 5bdf5c3..ac4e4fe 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
@@ -165,7 +165,7 @@ public final class LevyDistribution extends
AbstractContinuousDistribution {
*
* <p>The mean is equal to positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getMean() {
@@ -177,7 +177,7 @@ public final class LevyDistribution extends
AbstractContinuousDistribution {
*
* <p>The variance is equal to positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getVariance() {
@@ -201,7 +201,7 @@ public final class LevyDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 622e8f3..fa610a7 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
@@ -256,7 +256,7 @@ public final class LogNormalDistribution extends
AbstractContinuousDistribution
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 8dce169..fe1f6ed 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
@@ -191,7 +191,7 @@ public final class LogisticDistribution extends
AbstractContinuousDistribution {
*
* <p>The lower bound of the support is always negative infinity.
*
- * @return negative infinity.
+ * @return {@link Double#NEGATIVE_INFINITY negative infinity}.
*/
@Override
public double getSupportLowerBound() {
@@ -203,7 +203,7 @@ public final class LogisticDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 c64f3b8..246e6e8 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
@@ -198,7 +198,7 @@ public final class NakagamiDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 ccd75f5..f1a999a 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
@@ -184,7 +184,7 @@ public final class NormalDistribution extends
AbstractContinuousDistribution {
*
* <p>The lower bound of the support is always negative infinity.
*
- * @return negative infinity.
+ * @return {@link Double#NEGATIVE_INFINITY negative infinity}.
*/
@Override
public double getSupportLowerBound() {
@@ -196,7 +196,7 @@ public final class NormalDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 e9d7c15..41877c1 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
@@ -285,7 +285,7 @@ public final class ParetoDistribution extends
AbstractContinuousDistribution {
* <p>
* The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 5f078eb..22f5b8c 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
@@ -287,7 +287,7 @@ public abstract class TDistribution extends
AbstractContinuousDistribution {
* \text{undefined} & \text{otherwise}
* \end{cases} \]
*
- * @return the mean, or {@code NaN} if it is not defined.
+ * @return the mean, or {@link Double#NaN NaN} if it is not defined.
*/
@Override
public abstract double getMean();
@@ -303,7 +303,7 @@ public abstract class TDistribution extends
AbstractContinuousDistribution {
* \text{undefined} & \text{otherwise}
* \end{cases} \]
*
- * @return the variance, or {@code NaN} if it is not defined.
+ * @return the variance, or {@link Double#NaN NaN} if it is not defined.
*/
@Override
public abstract double getVariance();
@@ -313,7 +313,7 @@ public abstract class TDistribution extends
AbstractContinuousDistribution {
*
* <p>The lower bound of the support is always negative infinity.
*
- * @return negative infinity.
+ * @return {@link Double#NEGATIVE_INFINITY negative infinity}.
*/
@Override
public double getSupportLowerBound() {
@@ -325,7 +325,7 @@ public abstract class TDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
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 ac7dd88..28f7536 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
@@ -289,7 +289,7 @@ public final class WeibullDistribution extends
AbstractContinuousDistribution {
*
* <p>The upper bound of the support is always positive infinity.
*
- * @return positive infinity.
+ * @return {@link Double#POSITIVE_INFINITY positive infinity}.
*/
@Override
public double getSupportUpperBound() {
