Javadoc protected/public constructors and methods

Added to avoid warnings when building on Java 21 (which fail the build).

This requires adding implicit public constructors.

commons-rng-core/src/main/java/org/apache/commons/rng/core/BaseProvider.java

@@ -37,6 +37,9 @@ public abstract class BaseProvider
     /** The fractional part of the golden ratio, phi, scaled to 32-bits and rounded to odd. */
     private static final int GOLDEN_RATIO_32 = 0x9e3779b9;
 
+    /** Create an instance. */
+    public BaseProvider() {}
+
     /** {@inheritDoc} */
     @Override
     public RandomProviderState saveState() {

commons-rng-examples/examples-quadrature/src/main/java/org/apache/commons/rng/examples/quadrature/ComputePi.java

@@ -40,6 +40,8 @@ public class ComputePi extends MonteCarloIntegration {
     private static final int DIMENSION = 2;
 
     /**
+     * Create an instance.
+     *
      * @param rng RNG.
      */
     public ComputePi(UniformRandomProvider rng) {
@@ -78,6 +80,8 @@ public static void main(String[] args) {
     }
 
     /**
+     * Compute the value of pi.
+     *
      * @param numPoints Number of random points to generate.
      * @return the approximate value of pi.
      */

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.java

@@ -73,6 +73,8 @@ public class AhrensDieterExponentialSampler
     }
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param mean Mean of this distribution.
      * @throws IllegalArgumentException if {@code mean <= 0}

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.java

@@ -48,6 +48,8 @@ public class BoxMullerGaussianSampler
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param mean Mean of the Gaussian distribution.
      * @param standardDeviation Standard deviation of the Gaussian distribution.

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.java

@@ -42,6 +42,8 @@ public class BoxMullerLogNormalSampler
     private final ContinuousSampler sampler;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param mu Mean of the natural logarithm of the distribution values.
      * @param sigma Standard deviation of the natural logarithm of the distribution values.

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.java

@@ -40,6 +40,8 @@ public class BoxMullerNormalizedGaussianSampler
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      */
     public BoxMullerNormalizedGaussianSampler(UniformRandomProvider rng) {

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.java

@@ -72,6 +72,8 @@ public SharedStateContinuousSampler withUniformRandomProvider(UniformRandomProvi
     }
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param lo Lower bound.
      * @param hi Higher bound.

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/GaussianSampler.java

@@ -41,6 +41,8 @@ public class GaussianSampler implements SharedStateContinuousSampler {
     private final NormalizedGaussianSampler normalized;
 
     /**
+     * Create an instance.
+     *
      * @param normalized Generator of N(0,1) Gaussian distributed random numbers.
      * @param mean Mean of the Gaussian distribution.
      * @param standardDeviation Standard deviation of the Gaussian distribution.

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.java

@@ -64,6 +64,8 @@ public class InverseTransformContinuousSampler
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param function Inverse cumulative probability function.
      */

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.java

@@ -64,6 +64,8 @@ public class InverseTransformDiscreteSampler
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param function Inverse cumulative probability function.
      */

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.java

@@ -39,6 +39,8 @@ public class InverseTransformParetoSampler
     private final LongToDoubleFunction nextDouble;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param scale Scale of the distribution.
      * @param shape Shape of the distribution.

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.java

@@ -119,6 +119,8 @@ public int sample() {
 
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      * @param mean Mean.
      * @throws IllegalArgumentException if {@code mean < 1} or

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/LogNormalSampler.java

@@ -32,6 +32,8 @@ public class LogNormalSampler implements SharedStateContinuousSampler {
     private final NormalizedGaussianSampler gaussian;
 
     /**
+     * Create an instance.
+     *
      * @param gaussian N(0,1) generator.
      * @param mu Mean of the natural logarithm of the distribution values.
      * @param sigma Standard deviation of the natural logarithm of the distribution values.

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.java

@@ -37,6 +37,8 @@ public class MarsagliaNormalizedGaussianSampler
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      */
     public MarsagliaNormalizedGaussianSampler(UniformRandomProvider rng) {

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/PoissonSamplerCache.java

@@ -79,6 +79,8 @@ public class PoissonSamplerCache {
     private final LargeMeanPoissonSamplerState[] values;
 
     /**
+     * Create an instance.
+     *
      * @param minMean The minimum mean covered by the cache.
      * @param maxMean The maximum mean covered by the cache.
      * @throws IllegalArgumentException if {@code maxMean < minMean}

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SamplerBase.java

@@ -31,13 +31,17 @@ public class SamplerBase {
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      */
     protected SamplerBase(UniformRandomProvider rng) {
         this.rng = rng;
     }
 
     /**
+     * Return the next {@code double} value.
+     *
      * @return a random value from a uniform distribution in the
      * interval {@code [0, 1)}.
      */
@@ -46,13 +50,17 @@ protected double nextDouble() {
     }
 
     /**
+     * Return the next {@code int} value.
+     *
      * @return a random {@code int} value.
      */
     protected int nextInt() {
         return rng.nextInt();
     }
 
     /**
+     * Return the next {@code int} value.
+     *
      * @param max Upper bound (excluded).
      * @return a random {@code int} value in the interval {@code [0, max)}.
      */
@@ -61,6 +69,8 @@ protected int nextInt(int max) {
     }
 
     /**
+     * Return the next {@code long} value.
+     *
      * @return a random {@code long} value.
      */
     protected long nextLong() {

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.java

@@ -54,6 +54,8 @@ public class SmallMeanPoissonSampler
     private final UniformRandomProvider rng;
 
     /**
+     * Create an instance.
+     *
      * @param rng  Generator of uniformly distributed random numbers.
      * @param mean Mean.
      * @throws IllegalArgumentException if {@code mean <= 0} or {@code Math.exp(-mean) == 0}

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.java

@@ -95,6 +95,8 @@ public class ZigguratNormalizedGaussianSampler
     }
 
     /**
+     * Create an instance.
+     *
      * @param rng Generator of uniformly distributed random numbers.
      */
     public ZigguratNormalizedGaussianSampler(UniformRandomProvider rng) {

commons-rng-sampling/src/main/java/org/apache/commons/rng/sampling/shape/UnitBallSampler.java

@@ -201,6 +201,11 @@ public UnitBallSampler withUniformRandomProvider(UniformRandomProvider rng) {
         }
     }
 
+    /**
+     * Create an instance.
+     */
+    public UnitBallSampler() {}
+
     /**
      * @return a random Cartesian coordinate within the unit n-ball.
      */

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/JDKRandomBridge.java

@@ -95,6 +95,8 @@ protected int next(int n) {
     }
 
     /**
+     * Serialization method.
+     *
      * @param output Output stream.
      * @throws IOException if an error occurs.
      */
@@ -115,6 +117,8 @@ private void writeObject(ObjectOutputStream output)
     }
 
     /**
+     * Deserialization method.
+     *
      * @param input Input stream.
      * @throws IOException if an error occurs.
      * @throws ClassNotFoundException if an error occurs.

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/ByteArray2IntArray.java

@@ -22,6 +22,9 @@
  * @since 1.0
  */
 public class ByteArray2IntArray implements SeedConverter<byte[], int[]> {
+    /** Create an instance. */
+    public ByteArray2IntArray() {}
+
     /** {@inheritDoc} */
     @Override
     public int[] convert(byte[] seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/ByteArray2LongArray.java

@@ -22,6 +22,9 @@
  * @since 1.0
  */
 public class ByteArray2LongArray implements SeedConverter<byte[], long[]> {
+    /** Create an instance. */
+    public ByteArray2LongArray() {}
+
     /** {@inheritDoc} */
     @Override
     public long[] convert(byte[] seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Int2Long.java

@@ -22,6 +22,9 @@
  * @since 1.0
  */
 public class Int2Long implements SeedConverter<Integer, Long> {
+    /** Create an instance. */
+    public Int2Long() {}
+
     /** {@inheritDoc} */
     @Override
     public Long convert(Integer seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/IntArray2Int.java

@@ -22,6 +22,9 @@
  * @since 1.0
  */
 public class IntArray2Int implements SeedConverter<int[], Integer> {
+    /** Create an instance. */
+    public IntArray2Int() {}
+
     /** {@inheritDoc} */
     @Override
     public Integer convert(int[] seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/IntArray2LongArray.java

@@ -26,6 +26,9 @@
  * @since 1.0
  */
 public class IntArray2LongArray implements SeedConverter<int[], long[]> {
+    /** Create an instance. */
+    public IntArray2LongArray() {}
+
     /** {@inheritDoc} */
     @Override
     public long[] convert(int[] seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Long2Int.java

@@ -24,6 +24,9 @@
  * @since 1.0
  */
 public class Long2Int implements SeedConverter<Long, Integer> {
+    /** Create an instance. */
+    public Long2Int() {}
+
     /** {@inheritDoc} */
     @SuppressWarnings("deprecation")
     @Override

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Long2IntArray.java

@@ -29,6 +29,8 @@ public class Long2IntArray implements Seed2ArrayConverter<Long, int[]> {
     private final int size;
 
     /**
+     * Create an instance.
+     *
      * @param size Size of the output array.
      */
     public Long2IntArray(int size) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/Long2LongArray.java

@@ -29,6 +29,8 @@ public class Long2LongArray implements Seed2ArrayConverter<Long, long[]> {
     private final int size;
 
     /**
+     * Create an instance.
+     *
      * @param size Size of the output array.
      */
     public Long2LongArray(int size) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/LongArray2IntArray.java

@@ -25,6 +25,9 @@
  * @since 1.0
  */
 public class LongArray2IntArray implements SeedConverter<long[], int[]> {
+    /** Create an instance. */
+    public LongArray2IntArray() {}
+
     /** {@inheritDoc} */
     @Override
     public int[] convert(long[] seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/LongArray2Long.java

@@ -22,6 +22,9 @@
  * @since 1.0
  */
 public class LongArray2Long implements SeedConverter<long[], Long> {
+    /** Create an instance. */
+    public LongArray2Long() {}
+
     /** {@inheritDoc} */
     @Override
     public Long convert(long[] seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/NoOpConverter.java

@@ -26,6 +26,9 @@
  * @since 1.0
  */
 public class NoOpConverter<SEED> implements SeedConverter<SEED, SEED> {
+    /** Create an instance. */
+    public NoOpConverter() {}
+
     /** {@inheritDoc} */
     @Override
     public SEED convert(SEED seed) {

commons-rng-simple/src/main/java/org/apache/commons/rng/simple/internal/SeedConverterComposer.java

@@ -32,6 +32,8 @@ public class SeedConverterComposer<IN, TRANS, OUT> implements SeedConverter<IN,
     private final SeedConverter<TRANS, OUT> second;
 
     /**
+     * Create an instance.
+     *
      * @param first First conversion.
      * @param second second conversion.
      */