You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2022/11/23 17:55:21 UTC
[commons-rng] 01/02: Correct documentation of RNG methods used by the sampler
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-rng.git
commit a45c04c92bc0568131e0feb29f4374f2f7d2917e
Author: aherbert <ah...@apache.org>
AuthorDate: Wed Nov 23 17:50:53 2022 +0000
Correct documentation of RNG methods used by the sampler
---
.../rng/sampling/distribution/BoxMullerGaussianSampler.java | 7 ++++++-
.../rng/sampling/distribution/BoxMullerLogNormalSampler.java | 7 ++++++-
.../sampling/distribution/BoxMullerNormalizedGaussianSampler.java | 7 ++++++-
3 files changed, 18 insertions(+), 3 deletions(-)
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java
index e2f7222d..497362ad 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java
@@ -22,7 +22,12 @@ import org.apache.commons.rng.UniformRandomProvider;
* <a href="https://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform">
* Box-Muller algorithm</a> for sampling from a Gaussian distribution.
*
- * <p>Sampling uses {@link UniformRandomProvider#nextDouble()}.</p>
+ * <p>Sampling uses:</p>
+ *
+ * <ul>
+ * <li>{@link UniformRandomProvider#nextDouble()}
+ * <li>{@link UniformRandomProvider#nextLong()}
+ * </ul>
*
* @since 1.0
*
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.java
index 8f1ae507..8628434b 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.java
@@ -23,7 +23,12 @@ import org.apache.commons.rng.UniformRandomProvider;
* log-normal distribution</a>.
* Uses {@link BoxMullerNormalizedGaussianSampler} as the underlying sampler.
*
- * <p>Sampling uses {@link UniformRandomProvider#nextDouble()}.</p>
+ * <p>Sampling uses:</p>
+ *
+ * <ul>
+ * <li>{@link UniformRandomProvider#nextDouble()}
+ * <li>{@link UniformRandomProvider#nextLong()}
+ * </ul>
*
* @since 1.0
*
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.java
index b90a383e..8859c1ce 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.java
@@ -23,7 +23,12 @@ import org.apache.commons.rng.UniformRandomProvider;
* Box-Muller algorithm</a> for sampling from Gaussian distribution with
* mean 0 and standard deviation 1.
*
- * <p>Sampling uses {@link UniformRandomProvider#nextDouble()}.</p>
+ * <p>Sampling uses:</p>
+ *
+ * <ul>
+ * <li>{@link UniformRandomProvider#nextDouble()}
+ * <li>{@link UniformRandomProvider#nextLong()}
+ * </ul>
*
* @since 1.1
*/