Skip to content

Commit 5b59cc7

Browse files
committed
improve class javadoc for rngs
1 parent 09ae81c commit 5b59cc7

File tree

8 files changed

+15
-11
lines changed

8 files changed

+15
-11
lines changed

src/main/java/de/tilman_neumann/jml/random/LehmerRng64.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/**
1919
* Lehmer's random number generator for 64 bit numbers; requires 128 bit multiplication internally.
2020
*
21-
* This is class is still <strong>experimental</strong>. It seems to work but not much faster than Random yet.
21+
* It seems to work but not much faster than Random yet.
2222
*
2323
* @see https://en.wikipedia.org/wiki/Lehmer_random_number_generator
2424
*/

src/main/java/de/tilman_neumann/jml/random/LehmerRng64MH.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
import de.tilman_neumann.jml.base.Uint128;
1717

1818
/**
19-
* Lehmer's random number generator for 64 bit numbers, using Math.multiplyHigh(); requires 128 bit multiplication internally.
19+
* Lehmer's random number generator for 64 bit numbers; requires 128 bit multiplication internally.
2020
*
21-
* This is class is still <strong>experimental</strong>.
21+
* This variant uses using Math.multiplyHigh().
2222
*
2323
* @see https://en.wikipedia.org/wiki/Lehmer_random_number_generator
2424
*/

src/main/java/de/tilman_neumann/jml/random/SpRand32.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import org.apache.logging.log4j.Logger;
1818

1919
/**
20-
* My Java port of the pseudo-random number generator from tinyEcm.c by Ben Buhrow.
20+
* My Java port of the 32-bit pseudo-random number generator from tinyEcm.c by Ben Buhrow.
2121
*
2222
* This generator is special in that nextInt() creates strictly non-negative random numbers.
2323
*

src/main/java/de/tilman_neumann/jml/random/SplitMix64.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@
1616
import de.tilman_neumann.jml.base.Uint128;
1717

1818
/**
19-
* 64 bit random number generator adapted from https://rosettacode.org/wiki/Pseudo-random_numbers/Splitmix64.
19+
* splitmix64 is a 64 bit random number generator with 64 bit state.
20+
* Adapted from https://rosettacode.org/wiki/Pseudo-random_numbers/Splitmix64.
2021
*
2122
* Very fast, but its statistical properties are poor.
22-
* But according to https://en.wikipedia.org/wiki/Xorshift#Initialization, it is well-suited to initialize other random generators.
23+
* According to https://en.wikipedia.org/wiki/Xorshift#Initialization, it is well-suited to initialize other random generators.
2324
*
2425
* @author Tilman Neumann
2526
*/

src/main/java/de/tilman_neumann/jml/random/Xoroshiro128Plus.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import de.tilman_neumann.jml.base.Uint128;
1717

1818
/**
19-
* 64 bit random number generator.
19+
* xoroshiro128+ is a 64 bit random number generator using 128 bit state.
2020
*
2121
* @see https://nullprogram.com/blog/2017/09/21/
2222
. *

src/main/java/de/tilman_neumann/jml/random/Xoroshiro256StarStar.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@
1616
import de.tilman_neumann.jml.base.Uint128;
1717

1818
/**
19-
* 64 bit random number generator adapted from https://en.wikipedia.org/wiki/Xorshift.
19+
* xoroshiro256** is a 64 bit random number generator using 256 bit state.
20+
* Adapted from https://en.wikipedia.org/wiki/Xorshift.
2021
*
21-
* This seems to be the best 64 bit pseudo-random number generator these days, see also https://nullprogram.com/blog/2017/09/21/
22+
* This seems to be one of the best 64 bit pseudo-random number generators these days, see also https://nullprogram.com/blog/2017/09/21/
2223
*
2324
* @author Tilman Neumann
2425
*/

src/main/java/de/tilman_neumann/jml/random/Xorshift128Plus.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
import de.tilman_neumann.jml.base.Uint128;
1717

1818
/**
19-
* 64 bit random number generator adapted from https://nullprogram.com/blog/2017/09/21/.
19+
* xorshift128+ is a 64 bit random number generator using 128 bit state.
20+
* Adapted from https://nullprogram.com/blog/2017/09/21/.
2021
. *
2122
* @author Tilman Neumann
2223
*/

src/main/java/de/tilman_neumann/jml/random/Xorshift64Star.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
import de.tilman_neumann.jml.base.Uint128;
1717

1818
/**
19-
* 64 bit random number generator adapted from https://nullprogram.com/blog/2017/09/21/.
19+
* xorshift64* is a 64 bit random number generator using 64 bit state.
20+
* Adapted from https://nullprogram.com/blog/2017/09/21/.
2021
. *
2122
* @author Tilman Neumann
2223
*/

0 commit comments

Comments
 (0)