Added/Updated @since 1.3 javadoc tags to new API.
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoRoShiRo64.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoRoShiRo64.java
index 03e7582..f80fe3a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoRoShiRo64.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoRoShiRo64.java
@@ -24,7 +24,6 @@
* generators with 64-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
abstract class AbstractXoRoShiRo64 extends IntProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoShiRo128.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoShiRo128.java
index 8a8c94b..2950c89 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoShiRo128.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/AbstractXoShiRo128.java
@@ -27,7 +27,6 @@
* generators with 128-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
abstract class AbstractXoShiRo128 extends IntProvider implements LongJumpableUniformRandomProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/DotyHumphreySmallFastCounting32.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/DotyHumphreySmallFastCounting32.java
index 6f97bf5..d7ef3fd 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/DotyHumphreySmallFastCounting32.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/DotyHumphreySmallFastCounting32.java
@@ -26,7 +26,6 @@
* average of approximately 2<sup>127</sup>.</p>
*
* @see <a href="http://pracrand.sourceforge.net/">PractRand</a>
- *
* @since 1.3
*/
public class DotyHumphreySmallFastCounting32 extends IntProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/IntProvider.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/IntProvider.java
index ab4a0aa..b358fbd 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/IntProvider.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/IntProvider.java
@@ -61,6 +61,7 @@
* JumpableUniformRandomProvider} interface.
*
* @param source Source to copy.
+ * @since 1.3
*/
protected IntProvider(IntProvider source) {
booleanSource = source.booleanSource;
@@ -73,6 +74,8 @@
* <p>This should be used when the state is no longer valid, for example after a jump
* performed for the {@link org.apache.commons.rng.JumpableUniformRandomProvider
* JumpableUniformRandomProvider} interface.</p>
+ *
+ * @since 1.3
*/
protected void resetCachedState() {
booleanSource = 0;
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JenkinsSmallFast32.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JenkinsSmallFast32.java
index 54459e5..4b53331 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JenkinsSmallFast32.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/JenkinsSmallFast32.java
@@ -25,7 +25,6 @@
* and it expected that about one seed will run into another seed within 2<sup>64</sup> values.</p>
*
* @see <a href="https://burtleburtle.net/bob/rand/smallprng.html">A small noncryptographic PRNG</a>
- *
* @since 1.3
*/
public class JenkinsSmallFast32 extends IntProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/MiddleSquareWeylSequence.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/MiddleSquareWeylSequence.java
index c0495f2..ce07108 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/MiddleSquareWeylSequence.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/MiddleSquareWeylSequence.java
@@ -31,7 +31,6 @@
* <a href="https://arxiv.org/abs/1704.00358v3">Middle Square Weyl Sequence RNG</a>.</p>
*
* @see <a href="https://en.wikipedia.org/wiki/Middle-square_method">Middle Square Method</a>
- *
* @since 1.3
*/
public class MiddleSquareWeylSequence extends IntProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64Star.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64Star.java
index 72b1211..a1053cf 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64Star.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64Star.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoroshiro64star.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo64Star extends AbstractXoRoShiRo64 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64StarStar.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64StarStar.java
index 7c903a1..52f6c8a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64StarStar.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoRoShiRo64StarStar.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoroshiro64starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo64StarStar extends AbstractXoRoShiRo64 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128Plus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128Plus.java
index 105d5d1..8216c4a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128Plus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128Plus.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro128plus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo128Plus extends AbstractXoShiRo128 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128PlusPlus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128PlusPlus.java
index 81e982d..2714b57 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128PlusPlus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128PlusPlus.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro128plusplus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo128PlusPlus extends AbstractXoShiRo128 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128StarStar.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128StarStar.java
index f636ad3..d9d458d 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128StarStar.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source32/XoShiRo128StarStar.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro128starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo128StarStar extends AbstractXoShiRo128 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo1024.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo1024.java
index 1a49973..941b650 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo1024.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo1024.java
@@ -29,7 +29,6 @@
* generators with 1024-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
abstract class AbstractXoRoShiRo1024 extends LongProvider implements LongJumpableUniformRandomProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo128.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo128.java
index 794eef6..978c89e 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo128.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoRoShiRo128.java
@@ -27,7 +27,6 @@
* generators with 128-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
abstract class AbstractXoRoShiRo128 extends LongProvider implements LongJumpableUniformRandomProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo256.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo256.java
index 12a292e..fe04616 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo256.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo256.java
@@ -27,7 +27,6 @@
* generators with 256-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
abstract class AbstractXoShiRo256 extends LongProvider implements LongJumpableUniformRandomProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo512.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo512.java
index d6ebd05..dd5ba61 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo512.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/AbstractXoShiRo512.java
@@ -27,7 +27,6 @@
* generators with 512-bits of state.
*
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
abstract class AbstractXoShiRo512 extends LongProvider implements LongJumpableUniformRandomProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/DotyHumphreySmallFastCounting64.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/DotyHumphreySmallFastCounting64.java
index 5517f83..72a7d48 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/DotyHumphreySmallFastCounting64.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/DotyHumphreySmallFastCounting64.java
@@ -26,7 +26,6 @@
* average of approximately 2<sup>255</sup>.</p>
*
* @see <a href="http://pracrand.sourceforge.net/">PractRand</a>
- *
* @since 1.3
*/
public class DotyHumphreySmallFastCounting64 extends LongProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/JenkinsSmallFast64.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/JenkinsSmallFast64.java
index bb935b0..53c56af 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/JenkinsSmallFast64.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/JenkinsSmallFast64.java
@@ -24,7 +24,6 @@
* <p>The state size is 256-bits.</p>
*
* @see <a href="https://burtleburtle.net/bob/rand/smallprng.html">A small noncryptographic PRNG</a>
- *
* @since 1.3
*/
public class JenkinsSmallFast64 extends LongProvider {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/LongProvider.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/LongProvider.java
index 98220a2..d1c2941 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/LongProvider.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/LongProvider.java
@@ -71,6 +71,7 @@
* JumpableUniformRandomProvider} interface.
*
* @param source Source to copy.
+ * @since 1.3
*/
protected LongProvider(LongProvider source) {
booleanSource = source.booleanSource;
@@ -86,6 +87,8 @@
* <p>This should be used when the state is no longer valid, for example after a jump
* performed for the {@link org.apache.commons.rng.JumpableUniformRandomProvider
* JumpableUniformRandomProvider} interface.</p>
+ *
+ * @since 1.3
*/
protected void resetCachedState() {
booleanSource = 0L;
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/SplitMix64.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/SplitMix64.java
index df243d2..a55c96a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/SplitMix64.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/SplitMix64.java
@@ -36,6 +36,7 @@
* Creates a new instance.
*
* @param seed Initial seed.
+ * @since 1.3
*/
public SplitMix64(long seed) {
state = seed;
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024PlusPlus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024PlusPlus.java
index 4802bd9..b74255a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024PlusPlus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024PlusPlus.java
@@ -27,7 +27,6 @@
*
* @see <a href="http://xorshift.di.unimi.it/xoroshiro1024plusplus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo1024PlusPlus extends AbstractXoRoShiRo1024 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024Star.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024Star.java
index 7d85015..a6120ca 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024Star.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024Star.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xorshift.di.unimi.it/xoroshiro1024star.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo1024Star extends AbstractXoRoShiRo1024 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024StarStar.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024StarStar.java
index 9a39e12..7f2ec8a 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024StarStar.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo1024StarStar.java
@@ -27,7 +27,6 @@
*
* @see <a href="http://xorshift.di.unimi.it/xoroshiro1024starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo1024StarStar extends AbstractXoRoShiRo1024 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128Plus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128Plus.java
index ce7c9b5..3583dbb 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128Plus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128Plus.java
@@ -27,7 +27,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoroshiro128plus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo128Plus extends AbstractXoRoShiRo128 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128PlusPlus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128PlusPlus.java
index d6c20d9..045902c 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128PlusPlus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128PlusPlus.java
@@ -29,7 +29,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoroshiro128plusplus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo128PlusPlus extends AbstractXoRoShiRo128 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128StarStar.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128StarStar.java
index f115fed..9708810 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128StarStar.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoRoShiRo128StarStar.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoroshiro128starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoRoShiRo128StarStar extends AbstractXoRoShiRo128 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256Plus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256Plus.java
index 838a12c..126e62d 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256Plus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256Plus.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro256plus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo256Plus extends AbstractXoShiRo256 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256PlusPlus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256PlusPlus.java
index 4c398f4..6b1b45b 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256PlusPlus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256PlusPlus.java
@@ -25,7 +25,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro256starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo256PlusPlus extends AbstractXoShiRo256 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256StarStar.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256StarStar.java
index 11a4bb5..c41541f 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256StarStar.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo256StarStar.java
@@ -25,7 +25,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro256starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo256StarStar extends AbstractXoShiRo256 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512Plus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512Plus.java
index 678f5d4..dd416b5 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512Plus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512Plus.java
@@ -27,7 +27,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro512plus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo512Plus extends AbstractXoShiRo512 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512PlusPlus.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512PlusPlus.java
index 7989516..3575405 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512PlusPlus.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512PlusPlus.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro512plusplus.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo512PlusPlus extends AbstractXoShiRo512 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512StarStar.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512StarStar.java
index 756a7fe..e588c48 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512StarStar.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XoShiRo512StarStar.java
@@ -26,7 +26,6 @@
*
* @see <a href="http://xoshiro.di.unimi.it/xoshiro512starstar.c">Original source code</a>
* @see <a href="http://xoshiro.di.unimi.it/">xorshiro / xoroshiro generators</a>
- *
* @since 1.3
*/
public class XoShiRo512StarStar extends AbstractXoShiRo512 {
diff --git a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XorShift1024Star.java b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XorShift1024Star.java
index 7525129..3a7087e 100644
--- a/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XorShift1024Star.java
+++ b/commons-rng-core/src/main/java/org/apache/commons/rng/core/source64/XorShift1024Star.java
@@ -70,6 +70,7 @@
* be used; if smaller, the remaining elements will be automatically
* set. A seed containing all zeros will create a non-functional generator.
* @param multiplier The multiplier for the XorShift1024 algorithm.
+ * @since 1.3
*/
protected XorShift1024Star(long[] seed, long multiplier) {
setSeedInternal(seed);
@@ -80,6 +81,7 @@
* Creates a copy instance.
*
* @param source Source to copy.
+ * @since 1.3
*/
protected XorShift1024Star(XorShift1024Star source) {
super(source);
@@ -139,6 +141,8 @@
* <p>The jump size is the equivalent of 2<sup>512</sup>
* calls to {@link UniformRandomProvider#nextLong() nextLong()}. It can provide
* up to 2<sup>512</sup> non-overlapping subsequences.</p>
+ *
+ * @since 1.3
*/
@Override
public UniformRandomProvider jump() {
@@ -151,6 +155,7 @@
* Create a copy.
*
* @return the copy
+ * @since 1.3
*/
protected XorShift1024Star copy() {
// This exists to ensure the jump function returns
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java
index 12c8b93..fc5a3da 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CollectionSampler.java
@@ -77,7 +77,11 @@
return items.get(rng.nextInt(items.size()));
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public CollectionSampler<T> withUniformRandomProvider(UniformRandomProvider rng) {
return new CollectionSampler<T>(rng, this);
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java
index 848f737..1fc0c70 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/CombinationSampler.java
@@ -121,7 +121,11 @@
return SubsetSamplerUtils.partialSample(domain, steps, rng, upper);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public CombinationSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new CombinationSampler(rng, this);
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java
index 69b45bc..f04cb7d 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.java
@@ -135,7 +135,11 @@
return items.get(sampler.sample());
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public DiscreteProbabilityCollectionSampler<T> withUniformRandomProvider(UniformRandomProvider rng) {
return new DiscreteProbabilityCollectionSampler<T>(rng, this);
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 37aa7bc..b93c0fd 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
@@ -86,7 +86,11 @@
return SubsetSamplerUtils.partialSample(domain, size, rng, true);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public PermutationSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new PermutationSampler(rng, this);
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
index 67cecd1..6ce8b74 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/UnitSphereSampler.java
@@ -99,7 +99,11 @@
return v;
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public UnitSphereSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new UnitSphereSampler(rng, this);
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java
index b804210..54898b0 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java
@@ -136,7 +136,11 @@
return "Ahrens-Dieter Exponential deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new AhrensDieterExponentialSampler(rng, this);
@@ -149,6 +153,7 @@
* @param mean Mean of the distribution.
* @return the sampler
* @throws IllegalArgumentException if {@code mean <= 0}
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(UniformRandomProvider rng,
double mean) {
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 b5f55d1..08c72b8 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
@@ -46,9 +46,9 @@
* <li>{@link UniformRandomProvider#nextLong()} (only for {@code alpha >= 1})
* </ul>
*
- * @since 1.0
* @see <a href="http://mathworld.wolfram.com/GammaDistribution.html">MathWorld Gamma distribution</a>
* @see <a href="https://en.wikipedia.org/wiki/Gamma_distribution">Wikipedia Gamma distribution</a>
+ * @since 1.0
*/
public class AhrensDieterMarsagliaTsangGammaSampler
extends SamplerBase
@@ -295,7 +295,11 @@
return delegate.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
// Direct return of the optimised sampler
@@ -310,6 +314,7 @@
* @param theta Theta parameter of the distribution (this is a scale parameter).
* @return the sampler
* @throws IllegalArgumentException if {@code alpha <= 0} or {@code theta <= 0}
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(UniformRandomProvider rng,
double alpha,
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 39422cf..d110e4b 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
@@ -76,7 +76,11 @@
return "Box-Muller normalized Gaussian deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new BoxMullerNormalizedGaussianSampler(rng);
@@ -88,6 +92,7 @@
* @param <S> Sampler type.
* @param rng Generator of uniformly distributed random numbers.
* @return the sampler
+ * @since 1.3
*/
@SuppressWarnings("unchecked")
public static <S extends NormalizedGaussianSampler & SharedStateContinuousSampler> S
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java
index aa1f9ba..8d9fec9 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ChengBetaSampler.java
@@ -330,7 +330,11 @@
return delegate.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return delegate.withUniformRandomProvider(rng);
@@ -344,6 +348,7 @@
* @param beta Distribution second shape parameter.
* @return the sampler
* @throws IllegalArgumentException if {@code alpha <= 0} or {@code beta <= 0}
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(UniformRandomProvider rng,
double alpha,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java
index 4aea1ab..feaddc2 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java
@@ -62,7 +62,11 @@
return "Uniform deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new ContinuousUniformSampler(rng, lo, hi);
@@ -75,6 +79,7 @@
* @param lo Lower bound.
* @param hi Higher bound.
* @return the sampler
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(UniformRandomProvider rng,
double lo,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java
index 9eebc2c..6a39aea 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.java
@@ -345,7 +345,11 @@
return delegate.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng) {
// Direct return of the optimised sampler
@@ -360,6 +364,7 @@
* @param upper Upper bound (inclusive) of the distribution.
* @return the sampler
* @throws IllegalArgumentException if {@code lower > upper}.
+ * @since 1.3
*/
public static SharedStateDiscreteSampler of(UniformRandomProvider rng,
int lower,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java
index d7f2e11..5540018 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java
@@ -83,6 +83,8 @@
* @throws UnsupportedOperationException if the underlying sampler is not a
* {@link org.apache.commons.rng.sampling.SharedStateSampler SharedStateSampler} or
* does not return a {@link NormalizedGaussianSampler} when sharing state.
+ *
+ * @since 1.3
*/
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
@@ -102,6 +104,7 @@
* @return the sampler
* @throws IllegalArgumentException if {@code standardDeviation <= 0}
* @see #withUniformRandomProvider(UniformRandomProvider)
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(NormalizedGaussianSampler normalized,
double mean,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java
index e701e72..bdb88a5 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GeometricSampler.java
@@ -42,7 +42,6 @@
* @see <a
* href="https://en.wikipedia.org/wiki/Geometric_distribution#Related_distributions">Geometric
* distribution - related distributions</a>
- *
* @since 1.3
*/
public final class GeometricSampler {
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 c0761d9..b43ad12 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
@@ -91,6 +91,8 @@
*
* <p>Note: The new sampler will share the inverse cumulative probability function. This
* must be suitable for concurrent use to ensure thread safety.</p>
+ *
+ * @since 1.3
*/
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
@@ -108,6 +110,7 @@
* @param function Inverse cumulative probability function.
* @return the sampler
* @see #withUniformRandomProvider(UniformRandomProvider)
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(UniformRandomProvider rng,
ContinuousInverseCumulativeProbabilityFunction function) {
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 da7ee63..3f5991c 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
@@ -91,6 +91,8 @@
*
* <p>Note: The new sampler will share the inverse cumulative probability function. This
* must be suitable for concurrent use to ensure thread safety.</p>
+ *
+ * @since 1.3
*/
@Override
public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng) {
@@ -108,6 +110,7 @@
* @param function Inverse cumulative probability function.
* @return the sampler
* @see #withUniformRandomProvider(UniformRandomProvider)
+ * @since 1.3
*/
public static SharedStateDiscreteSampler of(UniformRandomProvider rng,
DiscreteInverseCumulativeProbabilityFunction function) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java
index ff84cc6..b2e4aaf 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java
@@ -80,7 +80,11 @@
return "[Inverse method for Pareto distribution " + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new InverseTransformParetoSampler(rng, this);
@@ -94,6 +98,7 @@
* @param shape Shape of the distribution.
* @return the sampler
* @throws IllegalArgumentException if {@code scale <= 0} or {@code shape <= 0}
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(UniformRandomProvider rng,
double scale,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java
index ae16216..d2ea63c 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java
@@ -310,7 +310,11 @@
return "Large Mean Poisson deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new LargeMeanPoissonSampler(rng, this);
@@ -324,6 +328,7 @@
* @return the sampler
* @throws IllegalArgumentException if {@code mean < 1} or {@code mean > 0.5 *}
* {@link Integer#MAX_VALUE}.
+ * @since 1.3
*/
public static SharedStateDiscreteSampler of(UniformRandomProvider rng,
double mean) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java
index 561cdd9..c8a7e4c 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java
@@ -84,6 +84,8 @@
* @throws UnsupportedOperationException if the underlying sampler is not a
* {@link org.apache.commons.rng.sampling.SharedStateSampler SharedStateSampler} or
* does not return a {@link NormalizedGaussianSampler} when sharing state.
+ *
+ * @since 1.3
*/
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
@@ -103,6 +105,7 @@
* @return the sampler
* @throws IllegalArgumentException if {@code scale < 0} or {@code shape <= 0}.
* @see #withUniformRandomProvider(UniformRandomProvider)
+ * @since 1.3
*/
public static SharedStateContinuousSampler of(NormalizedGaussianSampler gaussian,
double scale,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.java
index 516f67c..dd0b370 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.java
@@ -85,7 +85,11 @@
return "Box-Muller (with rejection) normalized Gaussian deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new MarsagliaNormalizedGaussianSampler(rng);
@@ -97,6 +101,7 @@
* @param <S> Sampler type.
* @param rng Generator of uniformly distributed random numbers.
* @return the sampler
+ * @since 1.3
*/
@SuppressWarnings("unchecked")
public static <S extends NormalizedGaussianSampler & SharedStateContinuousSampler> S
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java
index 7fe581c..6bbd9c0 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSampler.java
@@ -91,7 +91,11 @@
return poissonSamplerDelegate.toString();
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng) {
// Direct return of the optimised sampler
@@ -106,6 +110,7 @@
* @return the sampler
* @throws IllegalArgumentException if {@code mean <= 0} or {@code mean >}
* {@link Integer#MAX_VALUE}.
+ * @since 1.3
*/
public static SharedStateDiscreteSampler of(UniformRandomProvider rng,
double mean) {
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 7459c7b..2567bf8 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
@@ -192,7 +192,11 @@
return "Rejection inversion Zipf deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new RejectionInversionZipfSampler(rng, this);
@@ -207,6 +211,7 @@
* @return the sampler
* @throws IllegalArgumentException if {@code numberOfElements <= 0} or
* {@code exponent <= 0}.
+ * @since 1.3
*/
public static SharedStateDiscreteSampler of(UniformRandomProvider rng,
int numberOfElements,
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java
index d444003..e52beb4 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java
@@ -108,7 +108,11 @@
return "Small Mean Poisson deviate [" + rng.toString() + "]";
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateDiscreteSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new SmallMeanPoissonSampler(rng, this);
@@ -121,6 +125,7 @@
* @param mean Mean of the distribution.
* @return the sampler
* @throws IllegalArgumentException if {@code mean <= 0} or {@code Math.exp(-mean) == 0}.
+ * @since 1.3
*/
public static SharedStateDiscreteSampler of(UniformRandomProvider rng,
double mean) {
diff --git a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.java b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.java
index 96c3626..a8b3e5d 100644
--- a/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.java
+++ b/commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.java
@@ -161,7 +161,11 @@
return Math.exp(-0.5 * x * x);
}
- /** {@inheritDoc} */
+ /**
+ * {@inheritDoc}
+ *
+ * @since 1.3
+ */
@Override
public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvider rng) {
return new ZigguratNormalizedGaussianSampler(rng);
@@ -173,6 +177,7 @@
* @param <S> Sampler type.
* @param rng Generator of uniformly distributed random numbers.
* @return the sampler
+ * @since 1.3
*/
@SuppressWarnings("unchecked")
public static <S extends NormalizedGaussianSampler & SharedStateContinuousSampler> S
diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/JDKRandomWrapper.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/JDKRandomWrapper.java
index 998e4ec..84f52b8 100644
--- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/JDKRandomWrapper.java
+++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/JDKRandomWrapper.java
@@ -33,9 +33,9 @@
* There are many other pseudo-random number generators that are statistically superior and often
* faster (see {@link RandomSource}).</p>
*
- * @since 1.3
* @see java.security.SecureRandom
* @see RandomSource
+ * @since 1.3
*/
public final class JDKRandomWrapper implements UniformRandomProvider {
/** The JDK Random instance. */
diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java
index 33674b4..9164a2c 100644
--- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java
+++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/RandomSource.java
@@ -301,6 +301,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 16.</li>
* </ul>
+ * @since 1.3
*/
XOR_SHIFT_1024_S_PHI(ProviderBuilder.RandomSourceInternal.XOR_SHIFT_1024_S_PHI),
/**
@@ -309,6 +310,7 @@
* <li>Native seed type: {@code int[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_64_S(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_64_S),
/**
@@ -317,6 +319,7 @@
* <li>Native seed type: {@code int[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_64_SS(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_64_SS),
/**
@@ -325,6 +328,7 @@
* <li>Native seed type: {@code int[]}.</li>
* <li>Native seed size: 4.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_128_PLUS(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_128_PLUS),
/**
@@ -333,6 +337,7 @@
* <li>Native seed type: {@code int[]}.</li>
* <li>Native seed size: 4.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_128_SS(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_128_SS),
/**
@@ -341,6 +346,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_128_PLUS(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_128_PLUS),
/**
@@ -349,6 +355,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_128_SS(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_128_SS),
/**
@@ -357,6 +364,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 4.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_256_PLUS(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_256_PLUS),
/**
@@ -365,6 +373,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 4.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_256_SS(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_256_SS),
/**
@@ -373,6 +382,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 8.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_512_PLUS(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_512_PLUS),
/**
@@ -381,6 +391,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 8.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_512_SS(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_512_SS),
/**
@@ -389,6 +400,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
PCG_XSH_RR_32(ProviderBuilder.RandomSourceInternal.PCG_XSH_RR_32),
/**
@@ -397,6 +409,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
PCG_XSH_RS_32(ProviderBuilder.RandomSourceInternal.PCG_XSH_RS_32),
/**
@@ -405,6 +418,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
PCG_RXS_M_XS_64(ProviderBuilder.RandomSourceInternal.PCG_RXS_M_XS_64),
/**
@@ -412,6 +426,7 @@
* <ul>
* <li>Native seed type: {@code Long}.</li>
* </ul>
+ * @since 1.3
*/
PCG_MCG_XSH_RR_32(ProviderBuilder.RandomSourceInternal.PCG_MCG_XSH_RR_32),
/**
@@ -419,6 +434,7 @@
* <ul>
* <li>Native seed type: {@code Long}.</li>
* </ul>
+ * @since 1.3
*/
PCG_MCG_XSH_RS_32(ProviderBuilder.RandomSourceInternal.PCG_MCG_XSH_RS_32),
/**
@@ -427,6 +443,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 3.</li>
* </ul>
+ * @since 1.3
*/
MSWS(ProviderBuilder.RandomSourceInternal.MSWS),
/**
@@ -435,6 +452,7 @@
* <li>Native seed type: {@code int[]}.</li>
* <li>Native seed size: 3.</li>
* </ul>
+ * @since 1.3
*/
SFC_32(ProviderBuilder.RandomSourceInternal.SFC_32),
/**
@@ -443,6 +461,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 3.</li>
* </ul>
+ * @since 1.3
*/
SFC_64(ProviderBuilder.RandomSourceInternal.SFC_64),
/**
@@ -450,6 +469,7 @@
* <ul>
* <li>Native seed type: {@code Integer}.</li>
* </ul>
+ * @since 1.3
*/
JSF_32(ProviderBuilder.RandomSourceInternal.JSF_32),
/**
@@ -457,6 +477,7 @@
* <ul>
* <li>Native seed type: {@code Long}.</li>
* </ul>
+ * @since 1.3
*/
JSF_64(ProviderBuilder.RandomSourceInternal.JSF_64),
/**
@@ -465,6 +486,7 @@
* <li>Native seed type: {@code int[]}.</li>
* <li>Native seed size: 4.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_128_PP(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_128_PP),
/**
@@ -473,6 +495,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 2.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_128_PP(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_128_PP),
/**
@@ -481,6 +504,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 4.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_256_PP(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_256_PP),
/**
@@ -489,6 +513,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 8.</li>
* </ul>
+ * @since 1.3
*/
XO_SHI_RO_512_PP(ProviderBuilder.RandomSourceInternal.XO_SHI_RO_512_PP),
/**
@@ -497,6 +522,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 16.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_1024_PP(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_1024_PP),
/**
@@ -505,6 +531,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 16.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_1024_S(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_1024_S),
/**
@@ -513,6 +540,7 @@
* <li>Native seed type: {@code long[]}.</li>
* <li>Native seed size: 16.</li>
* </ul>
+ * @since 1.3
*/
XO_RO_SHI_RO_1024_SS(ProviderBuilder.RandomSourceInternal.XO_RO_SHI_RO_1024_SS);
@@ -561,7 +589,6 @@
* </code></pre>
*
* @return the seed
- *
* @since 1.3
*/
public byte[] createSeed() {
@@ -585,7 +612,6 @@
*
* @param rng Source of randomness.
* @return the seed
- *
* @since 1.3
*/
public byte[] createSeed(UniformRandomProvider rng) {
@@ -609,7 +635,6 @@
* </code></pre>
*
* @return {@code true} if jumpable
- *
* @since 1.3
*/
public boolean isJumpable() {
@@ -633,7 +658,6 @@
* </code></pre>
*
* @return {@code true} if long jumpable
- *
* @since 1.3
*/
public boolean isLongJumpable() {
diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/ProviderBuilder.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/ProviderBuilder.java
index 4c6f0ef..790b020 100644
--- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/ProviderBuilder.java
+++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/ProviderBuilder.java
@@ -508,6 +508,7 @@
* <p>This method should be over-ridden to satisfy seed requirements for the generator.</p>
*
* @return the native seed
+ * @since 1.3
*/
protected Object createSeed() {
return nativeSeedType.createSeed(nativeSeedSize);
@@ -523,6 +524,7 @@
*
* @param source Source of randomness.
* @return the byte[] seed
+ * @since 1.3
*/
protected byte[] createByteArraySeed(UniformRandomProvider source) {
return SeedFactory.createByteArray(source, getSeedByteSize());
@@ -538,6 +540,7 @@
* @param seed Input seed (must not be null).
* @return the native seed
* @throws UnsupportedOperationException if the {@code seed} type is invalid.
+ * @since 1.3
*/
protected Object convertSeed(Object seed) {
return nativeSeedType.convertSeed(seed, nativeSeedSize);
@@ -563,7 +566,6 @@
* implementing class. The seed is converted from the native type to bytes.</p>
*
* @return the seed bytes
- *
* @since 1.3
*/
public final byte[] createSeedBytes() {
@@ -581,7 +583,6 @@
*
* @param source Source of randomness.
* @return the seed bytes
- *
* @since 1.3
*/
public final byte[] createSeedBytes(UniformRandomProvider source) {
diff --git a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Seed2ArrayConverter.java b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Seed2ArrayConverter.java
index 2cf5abb..3dfa8a9 100644
--- a/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Seed2ArrayConverter.java
+++ b/commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Seed2ArrayConverter.java
@@ -21,7 +21,6 @@
*
* @param <IN> Input seed type.
* @param <OUT> Output seed type.
- *
* @since 1.3
*/
public interface Seed2ArrayConverter<IN, OUT> extends SeedConverter<IN, OUT> {
