Reverting commit aaabfe8d2d8d8c963310cdbd8fd0e81c50006992 as per Gilles request.
The work on revamping the random packages is perfoemd in the random-ravamp branch. Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/b144fa56 Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/b144fa56 Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/b144fa56 Branch: refs/heads/master Commit: b144fa56326cc19a424fc287b4d22e8a6aeed3f4 Parents: 15a7ab8 Author: Luc Maisonobe <l...@apache.org> Authored: Sun Jan 17 11:35:24 2016 +0100 Committer: Luc Maisonobe <l...@apache.org> Committed: Sun Jan 17 11:40:27 2016 +0100 ---------------------------------------------------------------------- .../commons/math4/random/RandomGenerator.java | 4 +-- .../commons/math4/random/package-info.java | 26 +++++++++----------- 2 files changed, 13 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-math/blob/b144fa56/src/main/java/org/apache/commons/math4/random/RandomGenerator.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/random/RandomGenerator.java b/src/main/java/org/apache/commons/math4/random/RandomGenerator.java index b1e7e5e..8e0b5b1 100644 --- a/src/main/java/org/apache/commons/math4/random/RandomGenerator.java +++ b/src/main/java/org/apache/commons/math4/random/RandomGenerator.java @@ -18,8 +18,8 @@ package org.apache.commons.math4.random; /** - * Interface extracted from <code>java.util.Random</code>. - * This interface is implemented by {@link BaseRandomGenerator}. + * Interface extracted from <code>java.util.Random</code>. This interface is + * implemented by {@link AbstractRandomGenerator}. * * @since 1.1 */ http://git-wip-us.apache.org/repos/asf/commons-math/blob/b144fa56/src/main/java/org/apache/commons/math4/random/package-info.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/math4/random/package-info.java b/src/main/java/org/apache/commons/math4/random/package-info.java index 0eec009..4d42815 100644 --- a/src/main/java/org/apache/commons/math4/random/package-info.java +++ b/src/main/java/org/apache/commons/math4/random/package-info.java @@ -17,29 +17,25 @@ /** * * <p>Random number and random data generators.</p> - * <p> - * Commons Math provides a few pseudo-random number generators. - * The top level interface is {@link RandomGenerator}. - * It is implemented by the following classes: - * <ul> - * <li> - * {@link org.apache.commons.math4.random.JDKRandomGenerator JDKRandomGenerator} - * that delegates to the JDK provided generator - * </li> - * <li> - * BaseRandomGenerator as a base class for concrete generators: + * <p>Commons-math provides a few pseudo random number generators. The top level interface is RandomGenerator. + * It is implemented by three classes: + * <ul> + * <li>{@link org.apache.commons.math4.random.JDKRandomGenerator JDKRandomGenerator} + * that extends the JDK provided generator</li> + * <li>AbstractRandomGenerator as a helper for users generators</li> + * <li>BitStreamGenerator which is an abstract class for several generators and + * which in turn is extended by: * <ul> - * <li>{@link org.apache.commons.math4.random.ISAACRandom ISAAC}</li> + * <li>{@link org.apache.commons.math4.random.MersenneTwister MersenneTwister}</li> * <li>{@link org.apache.commons.math4.random.Well512a Well512a}</li> * <li>{@link org.apache.commons.math4.random.Well1024a Well1024a}</li> * <li>{@link org.apache.commons.math4.random.Well19937a Well19937a}</li> * <li>{@link org.apache.commons.math4.random.Well19937c Well19937c}</li> * <li>{@link org.apache.commons.math4.random.Well44497a Well44497a}</li> * <li>{@link org.apache.commons.math4.random.Well44497b Well44497b}</li> - * <li>{@link org.apache.commons.math4.random.MersenneTwister MersenneTwister}</li> * </ul> - * </li> - * </ul> + * </li> + * </ul> * </p> * * <p>
