This is an automated email from the ASF dual-hosted git repository. aherbert pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-rng.git
commit 51a17f6a887f54d26c4e4ceb599818342ec4acab Author: Alex Herbert <[email protected]> AuthorDate: Mon Jul 15 11:42:44 2024 +0100 Update following 1.6 release --- RELEASE-NOTES.txt | 62 ++++++++++++++++++++++ commons-rng-bom/pom.xml | 1 + commons-rng-bom/src/site/xdoc/index.xml | 2 +- commons-rng-client-api/src/site/site.xml | 2 + commons-rng-core/src/site/site.xml | 2 + commons-rng-examples/examples-jmh/pom.xml | 1 + commons-rng-sampling/src/site/site.xml | 2 + commons-rng-simple/src/site/site.xml | 2 + src/changes/changes.xml | 7 ++- .../resources/release-notes/RELEASE-NOTES-1.6.txt | 62 ++++++++++++++++++++++ src/site/xdoc/download_rng.xml | 28 +++++----- 11 files changed, 155 insertions(+), 16 deletions(-) diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index ea2338d9..ba9a1a20 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,4 +1,66 @@ + Apache Commons RNG 1.6 RELEASE NOTES + +The Apache Commons RNG team is pleased to announce the release of Apache Commons RNG 1.6 + +The Apache Commons RNG project provides pure-Java implementation of pseudo-random generators. + +New features, updates and bug fixes (requires Java 8). + +Apache Commons RNG 1.6 contains the following library modules: + commons-rng-client-api (requires Java 8) + commons-rng-core (requires Java 8) + commons-rng-simple (requires Java 8) + commons-rng-sampling (requires Java 8) + commons-rng-bom + +The code in module 'commons-rng-core' should not be accessed +directly by applications; generators should be created using +the 'commons-rng-simple' module. + +Additional code is provided in the following modules: + commons-rng-examples-quadrature (requires Java 8) + commons-rng-examples-jmh (requires Java 8) + commons-rng-examples-sampling (requires Java 8) + commons-rng-examples-stress (requires Java 8) + commons-rng-examples-jpms (requires Java 11) + +It is however not part of the official API and no compatibility +should be expected in subsequent releases. + +It must be noted that, due to the nature of random number generation, some unit tests +are bound to fail with some probability. The 'maven-surefire-plugin' is configured +to re-run tests that fail, and pass the build if they succeed within the allotted +number of reruns (the test will be marked as 'flaky' in the report). + +The source output type (int/long) of a RNG must maintain behavioural compatibility +between releases; derived types may break behavioural compatibility. Any functional +changes will be recorded in the release notes. + +Changes in this version include: + +New features: +o RNG-186: Correct the module OSGi exports. Use of multiple modules is validated in an OSGi + integration test. +o RNG-184: New "ArraySampler" to support shuffling primitive and generic arrays with + sub-range support. + + +Changes: +o RNG-183: "InverseTransformParetoSampler": Modified to concentrate samples at the distribution + lower/upper bounds for extreme shape parameters. Eliminates generation of outlier + infinite samples and NaN samples under certain conditions. Changes sampling to use + the RNG nextLong() method in-place of nextDouble(). + + +For complete information on Apache Commons RNG, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons RNG website: + +https://commons.apache.org/proper/commons-rng/ + + +============================================================================= + Apache Commons RNG 1.5 RELEASE NOTES The Apache Commons RNG team is pleased to announce the release of Apache Commons RNG 1.5 diff --git a/commons-rng-bom/pom.xml b/commons-rng-bom/pom.xml index b40c414a..3ec5cb50 100644 --- a/commons-rng-bom/pom.xml +++ b/commons-rng-bom/pom.xml @@ -62,6 +62,7 @@ <!-- Disable unused plugins --> <animal.sniffer.skip>true</animal.sniffer.skip> <pmd.skip>true</pmd.skip> + <cpd.skip>true</cpd.skip> <spotbugs.skip>true</spotbugs.skip> <checkstyle.skip>true</checkstyle.skip> <changes.jira.skip>true</changes.jira.skip> diff --git a/commons-rng-bom/src/site/xdoc/index.xml b/commons-rng-bom/src/site/xdoc/index.xml index 061f35e7..936277b4 100644 --- a/commons-rng-bom/src/site/xdoc/index.xml +++ b/commons-rng-bom/src/site/xdoc/index.xml @@ -49,7 +49,7 @@ <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-rng-bom</artifactId> - <version>1.5</version> + <version>1.6</version> <type>pom</type> <scope>import</scope> </dependency> diff --git a/commons-rng-client-api/src/site/site.xml b/commons-rng-client-api/src/site/site.xml index c972543a..cc72c0ef 100644 --- a/commons-rng-client-api/src/site/site.xml +++ b/commons-rng-client-api/src/site/site.xml @@ -28,6 +28,8 @@ <item name="Overview" href="index.html"/> <item name="Latest API docs (development)" href="apidocs/index.html"/> + <item name="Javadoc (1.6 release)" + href="https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.6/index.html"/> <item name="Javadoc (1.5 release)" href="https://commons.apache.org/rng/commons-rng-client-api/javadocs/api-1.5/index.html"/> <item name="Javadoc (1.4 release)" diff --git a/commons-rng-core/src/site/site.xml b/commons-rng-core/src/site/site.xml index 7e4b032f..7ae9e8d0 100644 --- a/commons-rng-core/src/site/site.xml +++ b/commons-rng-core/src/site/site.xml @@ -28,6 +28,8 @@ <item name="Overview" href="index.html"/> <item name="Latest API docs (development)" href="apidocs/index.html"/> + <item name="Javadoc (1.6 release)" + href="https://commons.apache.org/rng/commons-rng-core/javadocs/api-1.6/index.html"/> <item name="Javadoc (1.5 release)" href="https://commons.apache.org/rng/commons-rng-core/javadocs/api-1.5/index.html"/> <item name="Javadoc (1.4 release)" diff --git a/commons-rng-examples/examples-jmh/pom.xml b/commons-rng-examples/examples-jmh/pom.xml index ac2e53af..2d361a3a 100644 --- a/commons-rng-examples/examples-jmh/pom.xml +++ b/commons-rng-examples/examples-jmh/pom.xml @@ -78,6 +78,7 @@ <project.mainClass>org.openjdk.jmh.Main</project.mainClass> <!-- Disable analysis for benchmarking code. --> <pmd.skip>true</pmd.skip> + <cpd.skip>true</cpd.skip> <spotbugs.skip>true</spotbugs.skip> <!-- Skip tests. This avoids the lengthy test of the ziggurat samplers. Override using: diff --git a/commons-rng-sampling/src/site/site.xml b/commons-rng-sampling/src/site/site.xml index d5f96050..78284ec5 100644 --- a/commons-rng-sampling/src/site/site.xml +++ b/commons-rng-sampling/src/site/site.xml @@ -28,6 +28,8 @@ <item name="Overview" href="index.html"/> <item name="Latest API docs (development)" href="apidocs/index.html"/> + <item name="Javadoc (1.6 release)" + href="https://commons.apache.org/rng/commons-rng-sampling/javadocs/api-1.6/index.html"/> <item name="Javadoc (1.5 release)" href="https://commons.apache.org/rng/commons-rng-sampling/javadocs/api-1.5/index.html"/> <item name="Javadoc (1.4 release)" diff --git a/commons-rng-simple/src/site/site.xml b/commons-rng-simple/src/site/site.xml index 0aac3169..9db0f7a2 100644 --- a/commons-rng-simple/src/site/site.xml +++ b/commons-rng-simple/src/site/site.xml @@ -28,6 +28,8 @@ <item name="Overview" href="index.html"/> <item name="Latest API docs (development)" href="apidocs/index.html"/> + <item name="Javadoc (1.6 release)" + href="https://commons.apache.org/rng/commons-rng-simple/javadocs/api-1.6/index.html"/> <item name="Javadoc (1.5 release)" href="https://commons.apache.org/rng/commons-rng-simple/javadocs/api-1.5/index.html"/> <item name="Javadoc (1.4 release)" diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 7225882f..2cd4a1aa 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -53,7 +53,12 @@ If the output is not quite correct, check for invisible trailing spaces! </properties> <body> - <release version="1.6" date="TBD" description=" + <release version="1.7" date="TBD" description=" +New features, updates and bug fixes (requires Java 8). +"> +</release> + + <release version="1.6" date="2024-07-15" description=" New features, updates and bug fixes (requires Java 8). "> <action dev="aherbert" type="add" issue="RNG-186"> diff --git a/RELEASE-NOTES.txt b/src/site/resources/release-notes/RELEASE-NOTES-1.6.txt similarity index 91% copy from RELEASE-NOTES.txt copy to src/site/resources/release-notes/RELEASE-NOTES-1.6.txt index ea2338d9..ba9a1a20 100644 --- a/RELEASE-NOTES.txt +++ b/src/site/resources/release-notes/RELEASE-NOTES-1.6.txt @@ -1,4 +1,66 @@ + Apache Commons RNG 1.6 RELEASE NOTES + +The Apache Commons RNG team is pleased to announce the release of Apache Commons RNG 1.6 + +The Apache Commons RNG project provides pure-Java implementation of pseudo-random generators. + +New features, updates and bug fixes (requires Java 8). + +Apache Commons RNG 1.6 contains the following library modules: + commons-rng-client-api (requires Java 8) + commons-rng-core (requires Java 8) + commons-rng-simple (requires Java 8) + commons-rng-sampling (requires Java 8) + commons-rng-bom + +The code in module 'commons-rng-core' should not be accessed +directly by applications; generators should be created using +the 'commons-rng-simple' module. + +Additional code is provided in the following modules: + commons-rng-examples-quadrature (requires Java 8) + commons-rng-examples-jmh (requires Java 8) + commons-rng-examples-sampling (requires Java 8) + commons-rng-examples-stress (requires Java 8) + commons-rng-examples-jpms (requires Java 11) + +It is however not part of the official API and no compatibility +should be expected in subsequent releases. + +It must be noted that, due to the nature of random number generation, some unit tests +are bound to fail with some probability. The 'maven-surefire-plugin' is configured +to re-run tests that fail, and pass the build if they succeed within the allotted +number of reruns (the test will be marked as 'flaky' in the report). + +The source output type (int/long) of a RNG must maintain behavioural compatibility +between releases; derived types may break behavioural compatibility. Any functional +changes will be recorded in the release notes. + +Changes in this version include: + +New features: +o RNG-186: Correct the module OSGi exports. Use of multiple modules is validated in an OSGi + integration test. +o RNG-184: New "ArraySampler" to support shuffling primitive and generic arrays with + sub-range support. + + +Changes: +o RNG-183: "InverseTransformParetoSampler": Modified to concentrate samples at the distribution + lower/upper bounds for extreme shape parameters. Eliminates generation of outlier + infinite samples and NaN samples under certain conditions. Changes sampling to use + the RNG nextLong() method in-place of nextDouble(). + + +For complete information on Apache Commons RNG, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons RNG website: + +https://commons.apache.org/proper/commons-rng/ + + +============================================================================= + Apache Commons RNG 1.5 RELEASE NOTES The Apache Commons RNG team is pleased to announce the release of Apache Commons RNG 1.5 diff --git a/src/site/xdoc/download_rng.xml b/src/site/xdoc/download_rng.xml index 842a66a6..69c0696a 100644 --- a/src/site/xdoc/download_rng.xml +++ b/src/site/xdoc/download_rng.xml @@ -107,38 +107,38 @@ limitations under the License. failing that using the <code>SHA512</code> hash (<code>*.sha512</code> checksum files). </p> <p> - The <a href="https://www.apache.org/dist/commons/KEYS";>KEYS</a> + The <a href="https://downloads.apache.org/commons/KEYS";>KEYS</a> file contains the public PGP keys used by Apache Commons developers to sign releases. </p> </subsection> </section> - <section name="Apache Commons RNG 1.5 (requires Java 8+)"> + <section name="Apache Commons RNG 1.6 (requires Java 8+)"> <subsection name="Binaries"> <table> <tr> - <td><a href="[preferred]/commons/rng/binaries/commons-rng-1.5-bin.tar.gz">commons-rng-1.5-bin.tar.gz</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/binaries/commons-rng-1.5-bin.tar.gz.sha512";>sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/binaries/commons-rng-1.5-bin.tar.gz.asc";>pgp</a></td> + <td><a href="[preferred]/commons/rng/binaries/commons-rng-1.6-bin.tar.gz">commons-rng-1.6-bin.tar.gz</a></td> + <td><a href="https://downloads.apache.org/commons/rng/binaries/commons-rng-1.6-bin.tar.gz.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/rng/binaries/commons-rng-1.6-bin.tar.gz.asc";>pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/rng/binaries/commons-rng-1.5-bin.zip">commons-rng-1.5-bin.zip</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/binaries/commons-rng-1.5-bin.zip.sha512";>sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/binaries/commons-rng-1.5-bin.zip.asc";>pgp</a></td> + <td><a href="[preferred]/commons/rng/binaries/commons-rng-1.6-bin.zip">commons-rng-1.6-bin.zip</a></td> + <td><a href="https://downloads.apache.org/commons/rng/binaries/commons-rng-1.6-bin.zip.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/rng/binaries/commons-rng-1.6-bin.zip.asc";>pgp</a></td> </tr> </table> </subsection> <subsection name="Source"> <table> <tr> - <td><a href="[preferred]/commons/rng/source/commons-rng-1.5-src.tar.gz">commons-rng-1.5-src.tar.gz</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/source/commons-rng-1.5-src.tar.gz.sha512";>sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/source/commons-rng-1.5-src.tar.gz.asc";>pgp</a></td> + <td><a href="[preferred]/commons/rng/source/commons-rng-1.6-src.tar.gz">commons-rng-1.6-src.tar.gz</a></td> + <td><a href="https://downloads.apache.org/commons/rng/source/commons-rng-1.6-src.tar.gz.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/rng/source/commons-rng-1.6-src.tar.gz.asc";>pgp</a></td> </tr> <tr> - <td><a href="[preferred]/commons/rng/source/commons-rng-1.5-src.zip">commons-rng-1.5-src.zip</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/source/commons-rng-1.5-src.zip.sha512";>sha512</a></td> - <td><a href="https://www.apache.org/dist/commons/rng/source/commons-rng-1.5-src.zip.asc";>pgp</a></td> + <td><a href="[preferred]/commons/rng/source/commons-rng-1.6-src.zip">commons-rng-1.6-src.zip</a></td> + <td><a href="https://downloads.apache.org/commons/rng/source/commons-rng-1.6-src.zip.sha512";>sha512</a></td> + <td><a href="https://downloads.apache.org/commons/rng/source/commons-rng-1.6-src.zip.asc";>pgp</a></td> </tr> </table> </subsection>
