Allow javadoc warnings in the JMH module

Enables building on JDK 17

Fix some typo and grammar.

Migrate workflows from adopt to temurin

Use GitHub Actions setup-java Maven cache property

Require method javadoc for private scope

Add missing javadoc checks

Fail javadoc on warnings

Increase jacoco method ratio to 1.00

Fail build on coverage checks

Remove empty revapi configuration section

Remove block level element from inside <p> tags

Update JMH 1.32 to 1.35

Disable Travis CI

Remove Travis profile

Update README badges

coveralls to codecov
travis to GH actions

RNG-179: Track changes

RNG-179: Add fast loaded dice roller discrete sampler

Correct if-else GH action workflow

Use a single build goal

This allows the examples modules to use the dependency artifacts from
the build and not the local repository.

Use greater than expression in GH workflow

Skip spotbugs in JMH module

Skip generated files in JMH module

Run examples on JDK 17

Add module javadoc

Fix working directory

Simplify GH build workflow

Verify the examples in the GH action workflow

Ignore IntBuffer in animal sniffer

JDK9 breaks compatibility with older versions for IntBuffer.flip() by
returning IntBuffer instead of Buffer.

This ignores this change to allow building on JDK 9+.

Update GH actions versions

Simplify returns.

Parameter name typo

Method name typo

Formatting

Changes typo

RNG-178: Add stream support to JumpableUniformRandomProvider

Javadoc

RNG-176: Track changes

RNG-176: Update user guide with new UniformRandomProvider methods

RNG-176: Remove redundant methods from core module

The methods are now present as default implementations in the client-api
UniformRandomProvider.

This requires JApiCmp is disabled as it does not recognise the change as
compatible. Binary compatibility is checked by revapi which allows this
change.

RNG-176: Update anonymous implementations of UniformRandomProvider

Only one method is required to implement the interface. This simplifies
creation of implementations for testing edge cases.

For a delegate implementation then additional methods must be added.
This applies to RandomSource.unrestorable.

RNG-176: Enhance the UniformRandomProvider interface

Add methods for streams and generation of numbers in a range. The
methods match those implementations in JDK 17 RandomGenerator interface.

Add default implementations of the existing interface methods using
nextLong() as the source of randomness.

Add explicit dependency from simple to the client-api module

The simple module uses interfaces from the client-api that can be after
v1.0. Add an explicit dependency to avoid transitive dependency
resolution creating mismatched modules.

Add revapi plugin for binary compatibility check

Do not leak package-private class in public API

Reduces the 'protected' copy method to 'package-private'.

This issue was detected using the revapi maven plugin.

Remove public test modifier

Sonar fix: lambdas to have 1 invocation possible throwing an exception

Sonar fix: Use @ParameterizedTest

RNG-177: Track changes

RNG-177: Add streaming examples to the user guide

RNG-177: Add stream methods to the sampler API

Set permissions for GH Actions

RNG-168: Track changes

RNG-168: Add stress test results

RNG-168: LXM family of random number generators

Add support for generators included in JDK 17:

L32X64Mix
L64X128StarStar
L64X128Mix
L64X256Mix
L64X1024Mix
L128X128Mix
L128X256Mix
L128X1024Mix

Added benchmark for support routines for computing the unsigned long
multiplications in the 128-bit LCG (linear congruential generator).

Added a benchmark for the jump function to allow comparison with the
equivalent base XBG (xor-based generator).

Added a faster carry computation than the method provided in the
reference LXM paper.

Use the copy constructor

Spotbugs excludes for updated spotbugs version

Drop <h3> package titles

This allows building on JDK 17

Update to commons parent 53

Update changes support for spotbugs with updated propertie names. It now
supports JDK 17.

Do not put lists within paragraph blocks

Update developer guide

Drop reference to building with ant.

Add notes about contributing using GitHub PRs.

Add table of contents to user guide

The user guide page can be directly linked from the site menu.

Added selected section links to the site menu.

Add GH actions for CI build and coverage

Add @since tags

Use reference instead of lambda.

Do not use fully qualified classname in javadoc

fix broken javadoc link.

RNG-174: Improve support for non-zero seeds

Allow specification of a range for array seeds that must be non-zero.

The values for the range are based on the result of
o.a.c.rng.simple.ProvidersCommonParametricTest.testZeroIntArraySeed.

See also the core module for tests using:
- RandomAssert.assertNextIntZeroOutput
- RandomAssert.assertIntArrayConstructorWithSingleBitInPoolIsFunctional

Any generator that fails these tests requires a non-zero seed. In most
cases this was set as the full seed length, or one less for generators
that do not use all the bits of the seed array (WELL_19937_x,
WELL_44497_x).

Notable exceptions:

The KISS generator is reduced to a simple LCG when positions [0, 3) are
all zero. Added a test to demonstrate this. With a zero seed the KISS
LCG passes testZeroIntArraySeed. To avoid a poor generator the seed will
be checked to be non-zero in [0, 3).

The MSWS generator is sensitive to the initial state. Added a test to
show that a zero seed creates zero output. Updating RandomAssert to add
an assertLongArrayConstructorWithSingleBitInPoolIsFunctional test shows
the MSWS fails with single bit seeds. The sub-range has been set to [2,
3) to ensure a non-zero Weyl increment which is the best way to escape a
bad seed. This is a functionally breaking change.

Fix typo

RNG-175: Fix MSWS createSeed(UniformRandomProvider) to handle a bad RNG

The createSeed(UniformRandomProvider) method should generate a seed even
if the input RNG is non-functional. This fixes an infinite loop when the
RNG output is not suitably random to create a seed.

Remove unused import

Support methods can be static

Update checkNextInRange to use a LongSupplier

The generic type <T extends Number> was used as a long value. The type
can be dropped to avoid auto-boxing for all generator tests.

Modified methods to static.

Correct isUniformNextByte test

Chi-square critical value should be for 255 degrees of freedom.

This lowers the critical value from 311.56 to 310.46. The test is now
harder to pass.

Consistent error messages for nextInRange test

Port modifications from sampling ContinuousSamplerParametricTest to the
ProvidersCommonParametricTest in core and simple modules.

Updated the precision of the chi-square critical value.

Add failed chi-square values to the message.

Format failed chi-square values to 3 decimal places.

Consolidate Int/LongProvider to use next() as the source of random bits

This removes the mixed use of next and nextLong or nextInt. The next
method is default source of the random bits and should always be used.

RNG-173: BaseProvider static method to extend an input array seed

Correct longAsInt output in the stress test application

RNG-171 changed the cached int source to output a long as two ints using
the low 32-bits, then high 32-bits.

Updated the RngDataOutput to support HiLo or LoHi. Added tests for each
implementation.

Dropped high-bits and low-bits command options. Added source64 option
with enum for high, low, high-Low, low-high, long, int. The default for
stress testing matches the caching implementation.

Update the test documentation to reflect the changes.

RNG-169: Avoid long to int[] that can generate a zero output seed.

This is relevant to small state RNGs with an int[] native seed such as
XoRoShiRo64StarStar.

Add missing <p> tags

Fix trailing whitespace

Document the lack of functional compatibility for derived output types.

Only the reference output type (int/long) from the generator is required
to maintain functional compatibility.

RNG-171: Reduce the memory footprint in cached boolean and int source

This change has a performance improvement on some JDKs.

Add a benchmark to compare the performance with and without the cache.

RNG-172: Support power of 2 by lowering limit by 1

This change has been made for completeness. In practice a different
sampler is used for powers of 2.

RNG-172: Pre-compute rejection threshold

Use Java 1.8 method to compute map value if absent

RNG-169: Track changes

RNG-169: Remove redundant Seed2ArrayConverter implementation

The functionality has been moved to the Conversions class. This removes
unreleased public API methods from legacy convertor classes.

Add tests to ensure coverage for converter classes.

Fix PMD errors

RNG-169: Move array size conversions to Conversions class

RNG-169: Move all conversions to the Conversions class

Remove use of instances of SeedConverter as the conversion is stateless.

RNG-169: Expand primitive input seeds using a SplitMix64

This changes behaviour so that

if int == long:
  int -> array1
  long -> array2
  array1 == array2

int -> array[0] == int -> long

RNG-169: Avoid intermediate arrays during conversions

The following conversions now avoid intermediate arrays:

byte[] -> int
byte[] -> long
int[] -> long

Behaviour change:

int[] is now converted as if to long[] then to long. This avoids loss of
bits and changes the possible output seeds from 2^32 to 2^64.

RNG-169: Update array seed conversion to use optimum seed length

Avoid duplication of the input byte[] to zero fill it to a length
modulus 4 or 8 for conversion by the NumberFactory.

During array to array conversions only convert the minimum of the
required number of bytes for the native seed type, or the number of
input bytes.

Change all array conversions to use little-endian byte order.

RNG-170: Ensure nextBytes is consistent with JDK range checks

Updated to match behaviour of System.arraycopy and JDK 9
Objects.checkFromIndexSize. This now allows:

nextBytes(new byte[0], 0, 0)
nextBytes(new byte[10], 10, 0)

Previously these would throw an exception.

Return the class type of the unrecognised seed.

This avoids creating a message containing the string representation of
an Object. This may be a very large String, for example a BitSet.
fix

Update NumberFactory to use parameterized/repeated tests

Add little-endian test for byte[] conversions.

Check all the test long/int values in nextBoolean.

Documentation typos

Add option to list a range of the RandomSource enum

Add missing generator name to example command

Add TSampler to continuous sampler performance JMH example

Add example histogram of the TSampler output to the userguide.