From 53d9d652f2af8dd93b1a79c692f4b1fecbc7ea37 Mon Sep 17 00:00:00 2001
From: Ray DeCampo
Date: Fri, 12 May 2017 17:52:09 -0400
Subject: [PATCH] Fix javadoc issues
---
.../math4/stat/descriptive/moment/GeometricMean.java | 2 +-
.../commons/math4/stat/descriptive/moment/Kurtosis.java | 2 +-
.../commons/math4/stat/descriptive/moment/SemiVariance.java | 2 +-
.../commons/math4/stat/descriptive/moment/Skewness.java | 2 +-
.../commons/math4/stat/descriptive/moment/Variance.java | 6 +++---
5 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/GeometricMean.java b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/GeometricMean.java
index aaeffe640..874274832 100644
--- a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/GeometricMean.java
+++ b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/GeometricMean.java
@@ -35,7 +35,7 @@ import org.apache.commons.math4.util.MathUtils;
* Uses a {@link SumOfLogs} instance to compute sum of logs and returns
* exp( 1/n (sum of logs) ).
Therefore,
*
- * - If any of values are < 0, the result is
NaN.
+ * - If any of values are {@code < 0}, the result is
NaN.
* - If all values are non-negative and less than
*
Double.POSITIVE_INFINITY
, but at least one value is 0, the
* result is 0.
diff --git a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Kurtosis.java b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Kurtosis.java
index 8e5f2802e..a9a0cc51e 100644
--- a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Kurtosis.java
+++ b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Kurtosis.java
@@ -36,7 +36,7 @@ import org.apache.commons.math4.util.MathUtils;
* where n is the number of values, mean is the {@link Mean} and std is the
* {@link StandardDeviation}
*
- * Note that this statistic is undefined for n < 4. Double.Nan
+ * Note that this statistic is undefined for {@code n < 4}. Double.Nan
* is returned when there is not sufficient data to compute the statistic.
* Note that Double.NaN may also be returned if the input includes NaN
* and / or infinite values.
diff --git a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/SemiVariance.java b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/SemiVariance.java
index b1427b872..33c0c8ebf 100644
--- a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/SemiVariance.java
+++ b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/SemiVariance.java
@@ -30,7 +30,7 @@ import org.apache.commons.math4.util.MathUtils;
* We define the downside semivariance of a set of values x
* against the cutoff value cutoff
to be
* Σ (x[i] - target)2 / df
- * where the sum is taken over all i
such that x[i] < cutoff
+ * where the sum is taken over all i
such that {@code x[i] < cutoff}
* and df
is the length of x
(non-bias-corrected) or
* one less than this number (bias corrected). The upside semivariance
* is defined similarly, with the sum taken over values of x
that
diff --git a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Skewness.java b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Skewness.java
index 93a7f7fc2..3fcd4bedc 100644
--- a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Skewness.java
+++ b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Skewness.java
@@ -35,7 +35,7 @@ import org.apache.commons.math4.util.MathUtils;
* where n is the number of values, mean is the {@link Mean} and std is the
* {@link StandardDeviation}
*
- * Note that this statistic is undefined for n < 3. Double.Nan
+ * Note that this statistic is undefined for {@code n < 3}. Double.Nan
* is returned when there is not sufficient data to compute the statistic.
* Double.NaN may also be returned if the input includes NaN and / or
* infinite values.
diff --git a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Variance.java b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Variance.java
index 7ed06bc69..ebed82f6d 100644
--- a/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Variance.java
+++ b/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Variance.java
@@ -276,10 +276,10 @@ public class Variance extends AbstractStorelessUnivariateStatistic implements Se
* the input array, or Double.NaN
if the designated subarray
* is empty.
*
- * Uses the formula
+ * Uses the formula
* Σ(weights[i]*(values[i] - weightedMean)2)/(Σ(weights[i]) - 1)
- *
- * where weightedMean is the weighted mean
+ *
+ * where weightedMean is the weighted mean
*
* This formula will not return the same result as the unweighted variance when all
* weights are equal, unless all weights are equal to 1. The formula assumes that