commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From er...@apache.org
Subject [4/9] commons-rng git commit: Javadoc.
Date Tue, 18 Oct 2016 15:38:28 GMT
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/58c68e3d
Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/58c68e3d
Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/58c68e3d

Branch: refs/heads/master
Commit: 58c68e3d1310b6ad84377958b5d4016047f398ce
Parents: 8bbc132
Author: Gilles <erans@apache.org>
Authored: Tue Oct 18 14:12:30 2016 +0200
Committer: Gilles <erans@apache.org>
Committed: Tue Oct 18 14:12:30 2016 +0200

----------------------------------------------------------------------
 src/main/java/org/apache/commons/rng/RandomSource.java | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-rng/blob/58c68e3d/src/main/java/org/apache/commons/rng/RandomSource.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/rng/RandomSource.java b/src/main/java/org/apache/commons/rng/RandomSource.java
index b71d8ef..546b115 100644
--- a/src/main/java/org/apache/commons/rng/RandomSource.java
+++ b/src/main/java/org/apache/commons/rng/RandomSource.java
@@ -358,13 +358,19 @@ public enum RandomSource {
     /**
      * Creates a random number generator with a random seed.
      *
-     * <p>Example of usage:</p>
+     * <p>Usage example:</p>
      * <pre><code>
      *  UniformRandomProvider rng = RandomSource.create(RandomSource.MT);
      * </code></pre>
+     * <p>or, if a {@link RestorableUniformRandomProvider "save/restore"} functionality
is needed,</p>
+     * <pre><code>
+     *  RestorableUniformRandomProvider rng = RandomSource.create(RandomSource.MT);
+     * </code></pre>
      *
      * @param source RNG type.
      * @return the RNG.
+     *
+     * @see #create(RandomSource,Object,Object[])
      */
     public static RestorableUniformRandomProvider create(RandomSource source) {
         return create(source, null);
@@ -373,7 +379,7 @@ public enum RandomSource {
     /**
      * Creates a random number generator with the given {@code seed}.
      *
-     * <p>Example of usage:</p>
+     * <p>Usage example:</p>
      * <pre><code>
      *  UniformRandomProvider rng = RandomSource.create(RandomSource.TWO_CMRES_SELECT, 26219,
6, 9);
      * </code></pre>
@@ -416,6 +422,8 @@ public enum RandomSource {
      * is invalid.
      * @throws IllegalStateException if data is missing to initialize the
      * generator implemented by the given {@code source}.
+     *
+     * @see #create(RandomSource)
      */
     public static RestorableUniformRandomProvider create(RandomSource source,
                                                          Object seed,


Mime
View raw message