You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2016/11/29 11:32:27 UTC
[16/50] commons-rng git commit: Javadoc.
Javadoc.
Project: http://git-wip-us.apache.org/repos/asf/commons-rng/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-rng/commit/6a1b0c16
Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/6a1b0c16
Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/6a1b0c16
Branch: refs/heads/1.0-release
Commit: 6a1b0c16090912e8fc5de2c1fb5bd8490ac14699
Parents: 43e3dc5
Author: Gilles <er...@apache.org>
Authored: Thu Nov 24 16:19:58 2016 +0100
Committer: Gilles <er...@apache.org>
Committed: Thu Nov 24 16:19:58 2016 +0100
----------------------------------------------------------------------
.../main/java/org/apache/commons/rng/sampling/ListSampler.java | 2 +-
.../org/apache/commons/rng/sampling/PermutationSampler.java | 2 +-
.../distribution/AhrensDieterMarsagliaTsangGammaSampler.java | 2 --
.../ContinuousInverseCumulativeProbabilityFunction.java | 4 ++--
.../DiscreteInverseCumulativeProbabilityFunction.java | 4 ++--
.../distribution/InverseTransformContinuousSampler.java | 6 ++----
.../sampling/distribution/InverseTransformDiscreteSampler.java | 6 ++----
.../sampling/distribution/RejectionInversionZipfSampler.java | 2 +-
8 files changed, 11 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/ListSampler.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/ListSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/ListSampler.java
index 733072f..40e4ddd 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/ListSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/ListSampler.java
@@ -84,7 +84,7 @@ public class ListSampler {
/**
* Shuffles the entries of the given array, using the
- * <a href="http://en.wikipedia.org/wiki/Fisher\u2013Yates_shuffle#The_modern_algorithm">
+ * <a href="http://en.wikipedia.org/wiki/Fisher-Yates_shuffle#The_modern_algorithm">
* Fisher-Yates</a> algorithm.
* The {@code start} and {@code pos} parameters select which part
* of the array is randomized and which is left untouched.
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
index 253b3c6..3d1d1d6 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/PermutationSampler.java
@@ -92,7 +92,7 @@ public class PermutationSampler {
/**
* Shuffles the entries of the given array, using the
- * <a href="http://en.wikipedia.org/wiki/Fisher\u2013Yates_shuffle#The_modern_algorithm">
+ * <a href="http://en.wikipedia.org/wiki/Fisher-Yates_shuffle#The_modern_algorithm">
* Fisher-Yates</a> algorithm.
* The {@code start} and {@code pos} parameters select which part
* of the array is randomized and which is left untouched.
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
index a9b8034..ef5243a 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.java
@@ -19,7 +19,6 @@ package org.apache.commons.rng.sampling.distribution;
import org.apache.commons.rng.UniformRandomProvider;
/**
- * <p>
* Sampling from the <a href="http://mathworld.wolfram.com/GammaDistribution.html">Gamma distribution</a>.
* <ul>
* <li>
@@ -39,7 +38,6 @@ import org.apache.commons.rng.UniformRandomProvider;
* </blockquote>
* </li>
* </ul>
- * </p>
*/
public class AhrensDieterMarsagliaTsangGammaSampler
extends SamplerBase
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.java
index 789049b..05743b1 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.java
@@ -27,8 +27,8 @@ public interface ContinuousInverseCumulativeProbabilityFunction {
* For a random variable {@code X} distributed according to this distribution,
* the returned value is
* <ul>
- * <li>\( \inf_{x \in \mathcal{R}} P(X \le x) \ge p \) for \( 0 < p \le 1 \)</li>
- * <li>\( \inf_{x \in \mathcal{R}} P(X \le x) > 0 \) for \( p = 0 \)</li>
+ * <li>\( \inf_{x \in \mathcal{R}} P(X \le x) \ge p \) for \( 0 \lt p \le 1 \)</li>
+ * <li>\( \inf_{x \in \mathcal{R}} P(X \le x) \gt 0 \) for \( p = 0 \)</li>
* </ul>
*
* @param p Cumulative probability.
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.java
index 31822cb..3b5e623 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.java
@@ -27,8 +27,8 @@ public interface DiscreteInverseCumulativeProbabilityFunction {
* For a random variable {@code X} distributed according to this distribution,
* the returned value is
* <ul>
- * <li>\( \inf_{x \in \mathcal{Z}} P(X \le x) \ge p \) for \( 0 < p \le 1 \)</li>
- * <li>\( \inf_{x \in \mathcal{Z}} P(X \le x) > 0 \) for \( p = 0 \)</li>
+ * <li>\( \inf_{x \in \mathcal{Z}} P(X \le x) \ge p \) for \( 0 \lt p \le 1 \)</li>
+ * <li>\( \inf_{x \in \mathcal{Z}} P(X \le x) \gt 0 \) for \( p = 0 \)</li>
* </ul>
*
* @param p Cumulative probability.
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.java
index 7424f46..0f6e727 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.java
@@ -23,13 +23,11 @@ import org.apache.commons.rng.UniformRandomProvider;
* <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling">
* inversion method</a>.
*
- * <p>
* It can be used to sample any distribution that provides access to its
* <em>inverse cumulative probabilty function</em>.
- * </p>
*
* <p>Example:</p>
- * <pre><source>
+ * <pre><code>
* import org.apache.commons.math3.distribution.RealDistribution;
* import org.apache.commons.math3.distribution.ChiSquaredDistribution;
*
@@ -51,7 +49,7 @@ import org.apache.commons.rng.UniformRandomProvider;
*
* // Generate random deviate.
* double random = chiSquareSampler.sample();
- * </source></pre>
+ * </code></pre>
*/
public class InverseTransformContinuousSampler
extends SamplerBase
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.java
index eddb52a..e22f273 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.java
@@ -23,13 +23,11 @@ import org.apache.commons.rng.UniformRandomProvider;
* <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling">
* inversion method</a>.
*
- * <p>
* It can be used to sample any distribution that provides access to its
* <em>inverse cumulative probabilty function</em>.
- * </p>
*
* <p>Example:</p>
- * <pre><source>
+ * <pre><code>
* import org.apache.commons.math3.distribution.IntegerDistribution;
* import org.apache.commons.math3.distribution.BinomialDistribution;
*
@@ -51,7 +49,7 @@ import org.apache.commons.rng.UniformRandomProvider;
*
* // Generate random deviate.
* int random = binomialSampler.sample();
- * </source></pre>
+ * </code></pre>
*/
public class InverseTransformDiscreteSampler
extends SamplerBase
http://git-wip-us.apache.org/repos/asf/commons-rng/blob/6a1b0c16/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
----------------------------------------------------------------------
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
index 92523d0..90ef8b9 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.java
@@ -69,7 +69,7 @@ public class RejectionInversionZipfSampler
* <blockquote>
* Wolfgang H�rmann and Gerhard Derflinger.
* <i>"Rejection-inversion to generate variates from monotone discrete
- * distributions",<i><br>
+ * distributions",</i><br>
* <strong>ACM Transactions on Modeling and Computer Simulation</strong> (TOMACS) 6.3 (1996): 169-184.
* </blockquote>
*/