Repository: commons-math Updated Branches: refs/heads/master 44b2b2c1b -> cec35baf0
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/5976c9e4 Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/5976c9e4 Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/5976c9e4 Branch: refs/heads/master Commit: 5976c9e44503a8eb2d384a5e551a245efbb643bc Parents: 44b2b2c Author: Ray DeCampo <r...@decampo.org> Authored: Sat May 13 09:08:59 2017 -0400 Committer: Ray DeCampo <r...@decampo.org> Committed: Sat May 13 09:08:59 2017 -0400 ---------------------------------------------------------------------- .../math4/distribution/AbstractIntegerDistribution.java | 2 +- .../math4/distribution/EmpiricalDistribution.java | 12 ++++++------ .../math4/distribution/EnumeratedDistribution.java | 4 ++-- .../commons/math4/distribution/GammaDistribution.java | 2 +- .../commons/math4/distribution/IntegerDistribution.java | 8 ++++---- .../commons/math4/distribution/LevyDistribution.java | 4 ++-- .../commons/math4/distribution/RealDistribution.java | 8 ++++---- .../commons/math4/distribution/ZipfDistribution.java | 2 +- 8 files changed, 21 insertions(+), 21 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java b/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java index add433e..86ecdf9 100644 --- a/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/AbstractIntegerDistribution.java @@ -117,7 +117,7 @@ public abstract class AbstractIntegerDistribution implements IntegerDistribution * #inverseCumulativeProbability(double)}. It assumes {@code 0 < p < 1} and * that the inverse cumulative probability lies in the bracket {@code * (lower, upper]}. The implementation does simple bisection to find the - * smallest {@code p}-quantile <code>inf{x in Z | P(X<=x) >= p}</code>. + * smallest {@code p}-quantile {@code inf{x in Z | P(X<=x) >= p}}. * * @param p the cumulative probability * @param lower a value satisfying {@code cumulativeProbability(lower) < p} http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/EmpiricalDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/EmpiricalDistribution.java b/src/main/java/org/apache/commons/math4/distribution/EmpiricalDistribution.java index 567c7c2..471b19e 100644 --- a/src/main/java/org/apache/commons/math4/distribution/EmpiricalDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/EmpiricalDistribution.java @@ -60,7 +60,7 @@ import org.apache.commons.math4.util.MathUtils; * Applications can use <code>EmpiricalDistribution</code> to build grouped * frequency histograms representing the input data or to generate random values * "like" those in the input file -- i.e., the values generated will follow the - * distribution of the values in the file.</p> + * distribution of the values in the file. * * <p>The implementation uses what amounts to the * <a href="http://nedwww.ipac.caltech.edu/level5/March02/Silverman/Silver2_6.html"> @@ -83,10 +83,10 @@ import org.apache.commons.math4.util.MathUtils; * be the bin containing x and let K be the within-bin kernel for B. Let P(B-) * be the sum of the probabilities of the bins below B and let K(B) be the * mass of B under K (i.e., the integral of the kernel density over B). Then - * set P(X < x) = P(B-) + P(B) * K(x) / K(B) where K(x) is the kernel distribution - * evaluated at x. This results in a cdf that matches the grouped frequency - * distribution at the bin endpoints and interpolates within bins using - * within-bin kernels.</p> + * set {@code P(X < x) = P(B-) + P(B) * K(x) / K(B)} where {@code K(x)} is the + * kernel distribution evaluated at x. This results in a cdf that matches the + * grouped frequency distribution at the bin endpoints and interpolates within + * bins using within-bin kernels.</p> * *<strong>USAGE NOTES:</strong><ul> *<li>The <code>binCount</code> is set by default to 1000. A good rule of thumb @@ -532,7 +532,7 @@ public class EmpiricalDistribution extends AbstractRealDistribution { * <li>Return P(B-) + P(B) * [K(x) - K(B-)] / K(B) where * K(x) is the within-bin kernel distribution function evaluated at x.</li></ol> * If K is a constant distribution, we return P(B-) + P(B) (counting the full - * mass of B).</p> + * mass of B). * * @since 3.1 */ http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/EnumeratedDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/EnumeratedDistribution.java b/src/main/java/org/apache/commons/math4/distribution/EnumeratedDistribution.java index f0b6f2e..2ca612e 100644 --- a/src/main/java/org/apache/commons/math4/distribution/EnumeratedDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/EnumeratedDistribution.java @@ -41,7 +41,7 @@ import org.apache.commons.math4.util.Pair; * but zero values are allowed and their sum does not have to equal one. Constructors will normalize input * probabilities to make them sum to one.</p> * - * <p>The list of <value, probability> pairs does not, strictly speaking, have to be a function and it can + * <p>The list of <value, probability> pairs does not, strictly speaking, have to be a function and it can * contain null values. The pmf created by the constructor will combine probabilities of equal values and * will treat null values as equal. For example, if the list of pairs <"dog", 0.2>, <null, 0.1>, * <"pig", 0.2>, <"dog", 0.1>, <null, 0.4> is provided to the constructor, the resulting @@ -139,7 +139,7 @@ public class EnumeratedDistribution<T> implements Serializable { } /** - * <p>Return the probability mass function as a list of <value, probability> pairs.</p> + * <p>Return the probability mass function as a list of <value, probability> pairs.</p> * * <p>Note that if duplicate and / or null values were provided to the constructor * when creating this EnumeratedDistribution, the returned list will contain these http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java b/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java index 29ad268..77d296b 100644 --- a/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/GammaDistribution.java @@ -267,7 +267,7 @@ public class GammaDistribution extends AbstractRealDistribution { * <a href="http://mathworld.wolfram.com/Chi-SquaredDistribution.html"> * Chi-Squared Distribution</a>, equation (9). * </li> - * <li>Casella, G., & Berger, R. (1990). <i>Statistical Inference</i>. + * <li>Casella, G., & Berger, R. (1990). <i>Statistical Inference</i>. * Belmont, CA: Duxbury Press. * </li> * </ul> http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/IntegerDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/IntegerDistribution.java b/src/main/java/org/apache/commons/math4/distribution/IntegerDistribution.java index 05076ae..34a51d0 100644 --- a/src/main/java/org/apache/commons/math4/distribution/IntegerDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/IntegerDistribution.java @@ -84,8 +84,8 @@ public interface IntegerDistribution { * For a random variable {@code X} distributed according to this distribution, * the returned value is * <ul> - * <li><code>inf{x in Z | P(X<=x) >= p}</code> for {@code 0 < p <= 1},</li> - * <li><code>inf{x in Z | P(X<=x) > 0}</code> for {@code p = 0}.</li> + * <li>{@code inf{x in Z | P(X<=x) >= p}} for {@code 0 < p <= 1},</li> + * <li>{@code inf{x in Z | P(X<=x) > 0}} for {@code p = 0}.</li> * </ul> * If the result exceeds the range of the data type {@code int}, * then {@code Integer.MIN_VALUE} or {@code Integer.MAX_VALUE} is returned. @@ -118,7 +118,7 @@ public interface IntegerDistribution { * Access the lower bound of the support. This method must return the same * value as {@code inverseCumulativeProbability(0)}. In other words, this * method must return - * <p><code>inf {x in Z | P(X <= x) > 0}</code>.</p> + * <p>{@code inf {x in Z | P(X <= x) > 0}}.</p> * * @return lower bound of the support ({@code Integer.MIN_VALUE} * for negative infinity) @@ -129,7 +129,7 @@ public interface IntegerDistribution { * Access the upper bound of the support. This method must return the same * value as {@code inverseCumulativeProbability(1)}. In other words, this * method must return - * <p><code>inf {x in R | P(X <= x) = 1}</code>.</p> + * <p>{@code inf {x in R | P(X <= x) = 1}}.</p> * * @return upper bound of the support ({@code Integer.MAX_VALUE} * for positive infinity) http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/LevyDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/LevyDistribution.java b/src/main/java/org/apache/commons/math4/distribution/LevyDistribution.java index a8d5793..1986cac 100644 --- a/src/main/java/org/apache/commons/math4/distribution/LevyDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/LevyDistribution.java @@ -57,9 +57,9 @@ public class LevyDistribution extends AbstractRealDistribution { * From Wikipedia: The probability density function of the Lévy distribution * over the domain is * </p> - * <pre> + * <div style="white-space: pre"><code> * f(x; μ, c) = √(c / 2π) * e<sup>-c / 2 (x - μ)</sup> / (x - μ)<sup>3/2</sup> - * </pre> + * </code></div> * <p> * For this distribution, {@code X}, this method returns {@code P(X < x)}. * If {@code x} is less than location parameter μ, {@code Double.NaN} is http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/RealDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/RealDistribution.java b/src/main/java/org/apache/commons/math4/distribution/RealDistribution.java index a9e8cb2..baaf747 100644 --- a/src/main/java/org/apache/commons/math4/distribution/RealDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/RealDistribution.java @@ -100,8 +100,8 @@ public interface RealDistribution { * variable {@code X} distributed according to this distribution, the * returned value is * <ul> - * <li><code>inf{x in R | P(X<=x) >= p}</code> for {@code 0 < p <= 1},</li> - * <li><code>inf{x in R | P(X<=x) > 0}</code> for {@code p = 0}.</li> + * <li>{@code inf{x in R | P(X<=x) >= p}} for {@code 0 < p <= 1},</li> + * <li>{@code inf{x in R | P(X<=x) > 0}} for {@code p = 0}.</li> * </ul> * * @param p the cumulative probability @@ -133,7 +133,7 @@ public interface RealDistribution { * Access the lower bound of the support. This method must return the same * value as {@code inverseCumulativeProbability(0)}. In other words, this * method must return - * <p><code>inf {x in R | P(X <= x) > 0}</code>.</p> + * <p>{@code inf {x in R | P(X <= x) > 0}}.</p> * * @return lower bound of the support (might be * {@code Double.NEGATIVE_INFINITY}) @@ -144,7 +144,7 @@ public interface RealDistribution { * Access the upper bound of the support. This method must return the same * value as {@code inverseCumulativeProbability(1)}. In other words, this * method must return - * <p><code>inf {x in R | P(X <= x) = 1}</code>.</p> + * <p>{@code inf {x in R | P(X <= x) = 1}}.</p> * * @return upper bound of the support (might be * {@code Double.POSITIVE_INFINITY}) http://git-wip-us.apache.org/repos/asf/commons-math/blob/5976c9e4/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java b/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java index 569d51b..17a95c2 100644 --- a/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java +++ b/src/main/java/org/apache/commons/math4/distribution/ZipfDistribution.java @@ -39,7 +39,7 @@ import org.apache.commons.rng.sampling.distribution.RejectionInversionZipfSample * <li>{@code N} is the number of elements</li> * <li>{@code s} is the exponent</li> * </ul> - * @see <a href="https://en.wikipedia.org/wiki/Zipf's_law">Zipf's law (Wikipedia)</a> + * @see <a href="https://en.wikipedia.org/wiki/Zipf's_law">Zipf's law (Wikipedia)</a> * @see <a href="https://en.wikipedia.org/wiki/Harmonic_number#Generalized_harmonic_numbers">Generalized harmonic numbers</a> */ public class ZipfDistribution extends AbstractIntegerDistribution {