Fix javadoc issues Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/53d9d652 Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/53d9d652 Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/53d9d652
Branch: refs/heads/master Commit: 53d9d652f2af8dd93b1a79c692f4b1fecbc7ea37 Parents: 6440b7f Author: Ray DeCampo <r...@decampo.org> Authored: Fri May 12 17:52:09 2017 -0400 Committer: Ray DeCampo <r...@decampo.org> Committed: Fri May 12 17:52:09 2017 -0400 ---------------------------------------------------------------------- .../commons/math4/stat/descriptive/moment/GeometricMean.java | 2 +- .../apache/commons/math4/stat/descriptive/moment/Kurtosis.java | 2 +- .../commons/math4/stat/descriptive/moment/SemiVariance.java | 2 +- .../apache/commons/math4/stat/descriptive/moment/Skewness.java | 2 +- .../apache/commons/math4/stat/descriptive/moment/Variance.java | 6 +++--- 5 files changed, 7 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/53d9d652/src/main/java/org/apache/commons/math4/stat/descriptive/moment/GeometricMean.java ---------------------------------------------------------------------- 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 aaeffe6..8742748 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 * <code> exp( 1/n (sum of logs) ).</code> Therefore, </p> * <ul> - * <li>If any of values are < 0, the result is <code>NaN.</code></li> + * <li>If any of values are {@code < 0}, the result is <code>NaN.</code></li> * <li>If all values are non-negative and less than * <code>Double.POSITIVE_INFINITY</code>, but at least one value is 0, the * result is <code>0.</code></li> http://git-wip-us.apache.org/repos/asf/commons-math/blob/53d9d652/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Kurtosis.java ---------------------------------------------------------------------- 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 8e5f280..a9a0cc5 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}</p> * <p> - * Note that this statistic is undefined for n < 4. <code>Double.Nan</code> + * Note that this statistic is undefined for {@code n < 4}. <code>Double.Nan</code> * 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.</p> http://git-wip-us.apache.org/repos/asf/commons-math/blob/53d9d652/src/main/java/org/apache/commons/math4/stat/descriptive/moment/SemiVariance.java ---------------------------------------------------------------------- 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 b1427b8..33c0c8e 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 <i>downside semivariance</i> of a set of values <code>x</code> * against the <i>cutoff value</i> <code>cutoff</code> to be <br> * <code>Σ (x[i] - target)<sup>2</sup> / df</code> <br> - * where the sum is taken over all <code>i</code> such that <code>x[i] < cutoff</code> + * where the sum is taken over all <code>i</code> such that {@code x[i] < cutoff} * and <code>df</code> is the length of <code>x</code> (non-bias-corrected) or * one less than this number (bias corrected). The <i>upside semivariance</i> * is defined similarly, with the sum taken over values of <code>x</code> that http://git-wip-us.apache.org/repos/asf/commons-math/blob/53d9d652/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Skewness.java ---------------------------------------------------------------------- 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 93a7f7f..3fcd4be 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} </p> * <p> - * Note that this statistic is undefined for n < 3. <code>Double.Nan</code> + * Note that this statistic is undefined for {@code n < 3}. <code>Double.Nan</code> * 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.</p> http://git-wip-us.apache.org/repos/asf/commons-math/blob/53d9d652/src/main/java/org/apache/commons/math4/stat/descriptive/moment/Variance.java ---------------------------------------------------------------------- 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 7ed06bc..ebed82f 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 <code>Double.NaN</code> if the designated subarray * is empty.</p> * <p> - * Uses the formula <pre> + * Uses the formula <div style="white-space: pre"><code> * Σ(weights[i]*(values[i] - weightedMean)<sup>2</sup>)/(Σ(weights[i]) - 1) - * </pre> - * where weightedMean is the weighted mean</p> + * </code></div> + * where weightedMean is the weighted mean * <p> * 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
